Excel.Interfaces.DocumentTaskData interface

Package:

excel

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

Properties

assignees	Returns a collection of assignees of the task.
completedBy	Gets the most recent user to have completed the task.
completedDateTime	Gets the date and time that the task was completed. All dates are in UTC.
createdBy	Gets the user who created the task.
createdDateTime	Gets the date and time that the task was created. All dates are in UTC.
id	Gets the ID of the task.
percentComplete	Specifies the completion percentage of the task. This is a value between 0 and 100, where 100 represents a completed task.
priority	Specifies the priority of the task. This is a value between 0 and 10, where 0 represents the highest priority.
startAndDueDateTime	Gets or sets the date and time the task should start and is due.
title	Specifies title of the task.

Property Details

assignees

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.

Returns a collection of assignees of the task.

TypeScript

assignees?: Excel.EmailIdentity[];

Property Value

Excel.EmailIdentity[]

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

completedBy

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.

Gets the most recent user to have completed the task.

TypeScript

completedBy?: Excel.EmailIdentity;

Property Value

Excel.EmailIdentity

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

completedDateTime

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.

Gets the date and time that the task was completed. All dates are in UTC.

TypeScript

completedDateTime?: Date;

Property Value

Date

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

createdBy

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.

Gets the user who created the task.

TypeScript

createdBy?: Excel.EmailIdentity;

Property Value

Excel.EmailIdentity

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.

Gets the date and time that the task was created. All dates are in UTC.

TypeScript

createdDateTime?: 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.

Gets the ID of the task.

TypeScript

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.

Specifies the completion percentage of the task. This is a value between 0 and 100, where 100 represents a completed task.

TypeScript

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.

Specifies the priority of the task. This is a value between 0 and 10, where 0 represents the highest priority.

TypeScript

priority?: number;

Property Value

number

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

startAndDueDateTime

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.

Gets or sets the date and time the task should start and is due.

TypeScript

startAndDueDateTime?: Excel.DocumentTaskSchedule;

Property Value

Excel.DocumentTaskSchedule

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.

Specifies title of the task.

TypeScript

title?: string;

Property Value

string

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]