Edit

Share via

Excel.Interfaces.DocumentTaskChangeData interface

  • Reference
Package:
excel

An interface describing the data returned by calling documentTaskChange.toJSON().

Properties

assignee

Represents the user assigned to the task for an assign change action, or the user unassigned from the task for an unassign change action.
changedBy

Represents the identity of the user who made the task change.
commentId

Represents the ID of the comment or comment reply to which the task change is anchored.
createdDateTime

Represents the creation date and time of the task change record. All dates are in UTC.
dueDateTime

Represents the task's due date and time. It is used for the setSchedule change action. It is in UTC time zone. It can be set to null to remove the due date and time. It should be set together with startDateTime to avoid conflicts.
id

The unique GUID of the task change.
percentComplete

Represents the task's completion percentage. It is used for the setPercentComplete change action. This is a value between 0 and 100, where 100 represents a completed task. Changing this value to 100 also completes the associated comment. Changing the completion from 100 to a lower value reactivates the associated comment.
priority

Represents the task's priority. It is used for the setPriority change action. This is a value between 0 and 10, with 5 being the default priority if not set, and where 0 represents the highest priority.
startDateTime

Represents the task's start date and time. It is used for the setSchedule change action. It is in UTC time zone. It can be set to null to remove the start date and time. It should be set together with dueDateTime to avoid conflicts.
title

Represents the task's title. It is used for the setTitle change action.
type

Represents the action type of the task change record. Some examples of action types are assign, undo, and setPriority.
undoChangeId

Represents the DocumentTaskChange.id property that was undone for the undo change action.

Property Details

assignee

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the user assigned to the task for an assign change action, or the user unassigned from the task for an unassign change action.

assignee?: Excel.EmailIdentity;

Property Value

Excel.EmailIdentity

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

changedBy

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the identity of the user who made the task change.

changedBy?: Excel.EmailIdentity;

Property Value

Excel.EmailIdentity

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

commentId

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the ID of the comment or comment reply to which the task change is anchored.

commentId?: string;

Property Value

string

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

createdDateTime

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the creation date and time of the task change record. All dates are in UTC.

createdDateTime?: Date;

Property Value

Date

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

dueDateTime

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the task's due date and time. It is used for the setSchedule change action. It is in UTC time zone. It can be set to null to remove the due date and time. It should be set together with startDateTime to avoid conflicts.

dueDateTime?: Date;

Property Value

Date

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

id

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

The unique GUID of the task change.

id?: string;

Property Value

string

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

percentComplete

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the task's completion percentage. It is used for the setPercentComplete change action. This is a value between 0 and 100, where 100 represents a completed task. Changing this value to 100 also completes the associated comment. Changing the completion from 100 to a lower value reactivates the associated comment.

percentComplete?: number;

Property Value

number

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

priority

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the task's priority. It is used for the setPriority change action. This is a value between 0 and 10, with 5 being the default priority if not set, and where 0 represents the highest priority.

priority?: number;

Property Value

number

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

startDateTime

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the task's start date and time. It is used for the setSchedule change action. It is in UTC time zone. It can be set to null to remove the start date and time. It should be set together with dueDateTime to avoid conflicts.

startDateTime?: Date;

Property Value

Date

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

title

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the task's title. It is used for the setTitle change action.

title?: string;

Property Value

string

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

type

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the action type of the task change record. Some examples of action types are assign, undo, and setPriority.

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

Property Value

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

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

undoChangeId

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the DocumentTaskChange.id property that was undone for the undo change action.

undoChangeId?: string;

Property Value

string

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]