Edit

Share via

Excel.DocumentTaskChange class

  • Reference
Package:
excel

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 a recorded change to the task.

Extends
OfficeExtension.ClientObject

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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.
context

The request context associated with the object. This connects the add-in's process to the Office host application's process.
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.

Methods

load(options)

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

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

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

Create a new instance of the Excel.DocumentTaskChange object.
toJSON()

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 is 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.

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.

readonly 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.

readonly 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.

readonly commentId: string;

Property Value

string

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

context

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 request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

Excel.RequestContext

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.

readonly 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.

readonly 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.

readonly 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.

readonly 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.

readonly 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.

readonly 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.

readonly 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.

readonly 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.

readonly undoChangeId: string;

Property Value

string

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Method Details

load(options)

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.

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

options
Excel.Interfaces.DocumentTaskChangeLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.DocumentTaskChange

load(propertyNames)

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.

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

propertyNames

string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

Excel.DocumentTaskChange

load(propertyNamesAndPaths)

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.

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

propertyNamesAndPaths

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

propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

Returns

Excel.DocumentTaskChange

newObject(context)

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.

Create a new instance of the Excel.DocumentTaskChange object.

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

Parameters

context
OfficeExtension.ClientRequestContext

Returns

Excel.DocumentTaskChange

toJSON()

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.

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 is 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

Excel.Interfaces.DocumentTaskChangeData