Excel.DocumentTaskChange class

Пакет:
excel

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Представляет записанное изменение задачи.

Extends
OfficeExtension.ClientObject

Комментарии

Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

Используется

Свойства

assignee

Представляет пользователя, назначенного задаче для assign действия по изменению или пользователя, которому удалена задача для действия по изменению unassign .
changedBy

Представляет удостоверение пользователя, изменившего задачу.
commentId

Представляет идентификатор комментария или ответа на примечание, с которым связано изменение задачи.
context

Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
createdDateTime

Представляет дату и время создания записи об изменении задачи. Все даты указаны в формате UTC.
dueDateTime

Представляет дату и время выполнения задачи. Используется для setSchedule действия изменения. Он находится в часовом поясе UTC. Можно null удалить дату и время выполнения. Его следует устанавливать вместе, startDateTime чтобы избежать конфликтов.
id

Уникальный идентификатор GUID изменения задачи.
percentComplete

Представляет процент завершения задачи. Используется для setPercentComplete действия изменения. Это значение от 0 до 100, где 100 представляет завершенную задачу. Изменение этого значения на 100 также завершает создание соответствующего комментария. Изменение значения завершения со 100 на более низкое активирует соответствующий комментарий.
priority

Представляет приоритет задачи. Используется для setPriority действия изменения. Это значение от 0 до 10, где 5 является приоритетом по умолчанию, если он не установлен, и 0 представляет наивысший приоритет.
startDateTime

Представляет дату и время начала задачи. Используется для setSchedule действия изменения. Он находится в часовом поясе UTC. Можно null удалить дату и время начала. Его следует устанавливать вместе, dueDateTime чтобы избежать конфликтов.
title

Представляет название задачи. Используется для setTitle действия изменения.
type

Представляет тип действия записи изменения задачи. Примеры типов действий: assign, undo, и setPriority.
undoChangeId

Представляет свойство DocumentTaskChange.id , отмененное для undo действия изменения.

Методы

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
newObject(context)

Создание нового экземпляра Excel.DocumentTaskChange объекта.
toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.DocumentTaskChange объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.DocumentTaskChangeData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.

Сведения о свойстве

assignee

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Представляет пользователя, назначенного задаче для assign действия по изменению или пользователя, которому удалена задача для действия по изменению unassign .

readonly assignee: Excel.EmailIdentity;

Значение свойства

Excel.EmailIdentity

Комментарии

Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

changedBy

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Представляет удостоверение пользователя, изменившего задачу.

readonly changedBy: Excel.EmailIdentity;

Значение свойства

Excel.EmailIdentity

Комментарии

Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

commentId

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Представляет идентификатор комментария или ответа на примечание, с которым связано изменение задачи.

readonly commentId: string;

Значение свойства

string

Комментарии

Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

context

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.

context: RequestContext;

Значение свойства

Excel.RequestContext

createdDateTime

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Представляет дату и время создания записи об изменении задачи. Все даты указаны в формате UTC.

readonly createdDateTime: Date;

Значение свойства

Date

Комментарии

Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

dueDateTime

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Представляет дату и время выполнения задачи. Используется для setSchedule действия изменения. Он находится в часовом поясе UTC. Можно null удалить дату и время выполнения. Его следует устанавливать вместе, startDateTime чтобы избежать конфликтов.

readonly dueDateTime: Date;

Значение свойства

Date

Комментарии

Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

id

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Уникальный идентификатор GUID изменения задачи.

readonly id: string;

Значение свойства

string

Комментарии

Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

percentComplete

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Представляет процент завершения задачи. Используется для setPercentComplete действия изменения. Это значение от 0 до 100, где 100 представляет завершенную задачу. Изменение этого значения на 100 также завершает создание соответствующего комментария. Изменение значения завершения со 100 на более низкое активирует соответствующий комментарий.

readonly percentComplete: number;

Значение свойства

number

Комментарии

Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

priority

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Представляет приоритет задачи. Используется для setPriority действия изменения. Это значение от 0 до 10, где 5 является приоритетом по умолчанию, если он не установлен, и 0 представляет наивысший приоритет.

readonly priority: number;

Значение свойства

number

Комментарии

Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

startDateTime

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Представляет дату и время начала задачи. Используется для setSchedule действия изменения. Он находится в часовом поясе UTC. Можно null удалить дату и время начала. Его следует устанавливать вместе, dueDateTime чтобы избежать конфликтов.

readonly startDateTime: Date;

Значение свойства

Date

Комментарии

Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

title

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Представляет название задачи. Используется для setTitle действия изменения.

readonly title: string;

Значение свойства

string

Комментарии

Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

type

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Представляет тип действия записи изменения задачи. Примеры типов действий: assign, undo, и setPriority.

readonly type: Excel.DocumentTaskChangeAction | "unknown" | "create" | "assign" | "unassign" | "unassignAll" | "setSchedule" | "setPercentComplete" | "setPriority" | "remove" | "restore" | "setTitle" | "undo";

Значение свойства

Excel.DocumentTaskChangeAction | "unknown" | "create" | "assign" | "unassign" | "unassignAll" | "setSchedule" | "setPercentComplete" | "setPriority" | "remove" | "restore" | "setTitle" | "undo"

Комментарии

Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

undoChangeId

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Представляет свойство DocumentTaskChange.id , отмененное для undo действия изменения.

readonly undoChangeId: string;

Значение свойства

string

Комментарии

Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

Сведения о методе

load(options)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Excel.Interfaces.DocumentTaskChangeLoadOptions): Excel.DocumentTaskChange;

Параметры

options
Excel.Interfaces.DocumentTaskChangeLoadOptions

Предоставляет параметры для загружаемых свойств объекта.

Возвращаемое значение

Excel.DocumentTaskChange

load(propertyNames)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames?: string | string[]): Excel.DocumentTaskChange;

Параметры

propertyNames

string | string[]

Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.

Возвращаемое значение

Excel.DocumentTaskChange

load(propertyNamesAndPaths)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.DocumentTaskChange;

Параметры

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.

Возвращаемое значение

Excel.DocumentTaskChange

newObject(context)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Создание нового экземпляра Excel.DocumentTaskChange объекта.

static newObject(context: OfficeExtension.ClientRequestContext): Excel.DocumentTaskChange;

Параметры

context
OfficeExtension.ClientRequestContext

Возвращаемое значение

Excel.DocumentTaskChange

toJSON()

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.DocumentTaskChange объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.DocumentTaskChangeData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.

toJSON(): Excel.Interfaces.DocumentTaskChangeData;

Возвращаемое значение

Excel.Interfaces.DocumentTaskChangeData