Поделиться через

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