Excel.DocumentTaskChange class

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

readonly assignee: Excel.EmailIdentity;

Property Value

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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

readonly changedBy: Excel.EmailIdentity;

Property Value

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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

readonly commentId: string;

Property Value

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

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

readonly createdDateTime: Date;

Property Value

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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.

readonly dueDateTime: Date;

Property Value

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

The unique GUID of the task change.

readonly id: string;

Property Value

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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.

readonly percentComplete: number;

Property Value

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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.

readonly priority: number;

Property Value

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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.

readonly startDateTime: Date;

Property Value

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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

readonly title: string;

Property Value

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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

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

Property Value

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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

readonly undoChangeId: string;

Property Value

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

Returns

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

Returns

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

Returns

Create a new instance of the Excel.DocumentTaskChange object.

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

Parameters

Returns

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Excel.DocumentTaskChange object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.DocumentTaskChangeData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.DocumentTaskChangeData;

Returns