次の方法で共有

Excel.DocumentTaskChange class

パッケージ:
excel

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

タスクに対する記録された変更を表します。

Extends
OfficeExtension.ClientObject

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

プロパティ

assignee

assign変更アクションのタスクに割り当てられたユーザー、またはunassign変更アクションのタスクから割り当てられていないユーザーを表します。
changedBy

タスクを変更したユーザーの ID を表します。
commentId

タスクの変更がアンカーされるコメントまたはコメント応答の ID を表します。
context

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
createdDateTime

タスク変更レコードの作成日時を表します。 すべての日付は UTC です。
dueDateTime

タスクの期限日時を表します。 これは、 setSchedule 変更アクションに使用されます。 UTC タイム ゾーンです。 nullに設定すると、期限の日時を削除できます。 競合を回避するには、 startDateTime と共に設定する必要があります。
id

タスク変更の一意の GUID。
percentComplete

タスクの完了率を表します。 これは、 setPercentComplete 変更アクションに使用されます。 これは 0 から 100 までの値で、100 は完了したタスクを表します。 この値を 100 に変更すると、関連するコメントも完了します。 入力候補を 100 から小さい値に変更すると、関連付けられているコメントが再アクティブ化されます。
priority

タスクの優先度を表します。 これは、 setPriority 変更アクションに使用されます。 これは 0 から 10 までの値で、5 が設定されていない場合は既定の優先順位であり、0 は最も高い優先順位を表します。
startDateTime

タスクの開始日と時刻を表します。 これは、 setSchedule 変更アクションに使用されます。 UTC タイム ゾーンです。 nullに設定すると、開始日と時刻を削除できます。 競合を回避するには、 dueDateTime と共に設定する必要があります。
title

タスクのタイトルを表します。 これは、 setTitle 変更アクションに使用されます。
type

タスク変更レコードのアクションの種類を表します。 アクションの種類には、 assign、 undo、 setPriorityなどがあります。
undoChangeId

undo変更アクションで元に戻されたDocumentTaskChange.id プロパティを表します。

メソッド

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
newObject(context)

Excel.DocumentTaskChange オブジェクトの新しいインスタンスを作成します。
toJSON()

API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.DocumentTaskChange オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.DocumentTaskChangeData として型指定) を返します。

プロパティの詳細

assignee

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

assign変更アクションのタスクに割り当てられたユーザー、またはunassign変更アクションのタスクから割り当てられていないユーザーを表します。

readonly assignee: Excel.EmailIdentity;

プロパティ値

Excel.EmailIdentity

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

changedBy

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

タスクを変更したユーザーの ID を表します。

readonly changedBy: Excel.EmailIdentity;

プロパティ値

Excel.EmailIdentity

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

commentId

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

タスクの変更がアンカーされるコメントまたはコメント応答の ID を表します。

readonly commentId: string;

プロパティ値

string

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

context

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

Excel.RequestContext

createdDateTime

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

タスク変更レコードの作成日時を表します。 すべての日付は UTC です。

readonly createdDateTime: Date;

プロパティ値

Date

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

dueDateTime

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

タスクの期限日時を表します。 これは、 setSchedule 変更アクションに使用されます。 UTC タイム ゾーンです。 nullに設定すると、期限の日時を削除できます。 競合を回避するには、 startDateTime と共に設定する必要があります。

readonly dueDateTime: Date;

プロパティ値

Date

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

id

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

タスク変更の一意の GUID。

readonly id: string;

プロパティ値

string

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

percentComplete

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

タスクの完了率を表します。 これは、 setPercentComplete 変更アクションに使用されます。 これは 0 から 100 までの値で、100 は完了したタスクを表します。 この値を 100 に変更すると、関連するコメントも完了します。 入力候補を 100 から小さい値に変更すると、関連付けられているコメントが再アクティブ化されます。

readonly percentComplete: number;

プロパティ値

number

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

priority

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

タスクの優先度を表します。 これは、 setPriority 変更アクションに使用されます。 これは 0 から 10 までの値で、5 が設定されていない場合は既定の優先順位であり、0 は最も高い優先順位を表します。

readonly priority: number;

プロパティ値

number

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

startDateTime

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

タスクの開始日と時刻を表します。 これは、 setSchedule 変更アクションに使用されます。 UTC タイム ゾーンです。 nullに設定すると、開始日と時刻を削除できます。 競合を回避するには、 dueDateTime と共に設定する必要があります。

readonly startDateTime: Date;

プロパティ値

Date

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

title

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

タスクのタイトルを表します。 これは、 setTitle 変更アクションに使用されます。

readonly title: string;

プロパティ値

string

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

type

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

タスク変更レコードのアクションの種類を表します。 アクションの種類には、 assign、 undo、 setPriorityなどがあります。

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

プロパティ値

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

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

undoChangeId

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

undo変更アクションで元に戻されたDocumentTaskChange.id プロパティを表します。

readonly undoChangeId: string;

プロパティ値

string

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

メソッドの詳細

load(options)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

パラメーター

options
Excel.Interfaces.DocumentTaskChangeLoadOptions

読み込むオブジェクトのプロパティのオプションを提供します。

戻り値

Excel.DocumentTaskChange

load(propertyNames)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

パラメーター

propertyNames

string | string[]

読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。

戻り値

Excel.DocumentTaskChange

load(propertyNamesAndPaths)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

パラメーター

propertyNamesAndPaths

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

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。

戻り値

Excel.DocumentTaskChange

newObject(context)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

Excel.DocumentTaskChange オブジェクトの新しいインスタンスを作成します。

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

パラメーター

context
OfficeExtension.ClientRequestContext

戻り値

Excel.DocumentTaskChange

toJSON()

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.DocumentTaskChange オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.DocumentTaskChangeData として型指定) を返します。

toJSON(): Excel.Interfaces.DocumentTaskChangeData;

戻り値

Excel.Interfaces.DocumentTaskChangeData