Excel.DocumentTaskChange class
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
タスクへの記録された変更を表します。
- Extends
プロパティ
| assignee |
|
| changed |
タスクを変更したユーザーの ID を表します。 |
| comment |
タスク変更が固定されているコメントまたはコメント返信の ID を表します。 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| created |
タスク変更レコードの作成日時を表します。 すべての日付は UTC になります。 |
| due |
タスクの期限の日付と時刻を表します。
|
| id | タスク変更の一意の GUID。 |
| percent |
タスクの完了率を表します。
|
| priority | タスクの優先順位を表します。
|
| start |
タスクの開始日時を表します。
|
| title | タスクのタイトルを表します。
|
| type | タスク変更レコードのアクションの種類を表します。 アクションの種類の例としては、 |
| undo |
|
メソッド
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| new |
|
| toJSON() | API オブジェクトが |
プロパティの詳細
assignee
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
assign変更アクションのタスクに割り当てられているユーザー、またはunassign変更アクションのタスクから割り当てられていないユーザーを表します。
readonly assignee: Excel.EmailIdentity;プロパティ値
注釈
changedBy
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
タスクを変更したユーザーの ID を表します。
readonly changedBy: Excel.EmailIdentity;プロパティ値
注釈
commentId
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
タスク変更が固定されているコメントまたはコメント返信の ID を表します。
readonly commentId: string;プロパティ値
string
注釈
context
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
createdDateTime
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
タスク変更レコードの作成日時を表します。 すべての日付は UTC になります。
readonly createdDateTime: Date;プロパティ値
Date
注釈
dueDateTime
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
タスクの期限の日付と時刻を表します。
setSchedule変更操作に使用されます。 UTC タイム ゾーンです。 期限の日付と時刻を削除するには、 null に設定できます。 競合を避けるために、 startDateTime と一緒に設定する必要があります。
readonly dueDateTime: Date;プロパティ値
Date
注釈
id
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
タスク変更の一意の GUID。
readonly id: string;プロパティ値
string
注釈
percentComplete
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
タスクの完了率を表します。
setPercentComplete変更操作に使用されます。 これは 0 から 100 の範囲の値です。100 は完了したタスクを表します。 この値を 100 に変更すると、関連付けられたコメントも完了します。 入力候補を 100 から低い値に変更すると、関連付けられているコメントが再度有効になります。
readonly percentComplete: number;プロパティ値
number
注釈
priority
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
タスクの優先順位を表します。
setPriority変更操作に使用されます。 これは 0 から 10 の範囲の値です。設定されていない場合は 5 が既定の優先度となり、0 が最高の優先度を表します。
readonly priority: number;プロパティ値
number
注釈
startDateTime
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
タスクの開始日時を表します。
setSchedule変更操作に使用されます。 UTC タイム ゾーンです。 開始日時を削除するには、 null に設定できます。 競合を避けるために、 dueDateTime と一緒に設定する必要があります。
readonly startDateTime: Date;プロパティ値
Date
注釈
title
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
タスクのタイトルを表します。
setTitle変更操作に使用されます。
readonly title: string;プロパティ値
string
注釈
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"
注釈
undoChangeId
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
undo変更操作で元に戻されたDocumentTaskChange.idプロパティを表します。
readonly undoChangeId: string;プロパティ値
string
注釈
メソッドの詳細
load(options)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.DocumentTaskChangeLoadOptions): Excel.DocumentTaskChange;パラメーター
読み込むオブジェクトのプロパティのオプションを指定します。
返品
load(propertyNames)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.DocumentTaskChange;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。
返品
load(propertyNamesAndPaths)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.DocumentTaskChange;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。
返品
newObject(context)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
Excel.DocumentTaskChange オブジェクトの新しいインスタンスを作成します。
static newObject(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;