Excel.Interfaces.DocumentTaskChangeData interface
An interface describing the data returned by calling documentTaskChange.toJSON().
Properties
| assignee | Represents the user assigned to the task for an |
| changed |
Represents the identity of the user who made the task change. |
| comment |
Represents the ID of the |
| created |
Represents the creation date and time of the task change record. All dates are in UTC. |
| due |
Represents the task's due date and time. It is used for the |
| id | The unique GUID of the task change. |
| percent |
Represents the task's completion percentage. It is used for the |
| priority | Represents the task's priority. It is used for the |
| start |
Represents the task's start date and time. It is used for the |
| title | Represents the task's title. It is used for the |
| type | Represents the action type of the task change record. Some examples of action types are |
| undo |
Represents the |
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
Remarks
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
Remarks
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 CommentReply to which the task change is anchored.
commentId?: string;Property Value
string
Remarks
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
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
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
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
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
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
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
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
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
Office Add-ins
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for