Office.Time interface
Time オブジェクトは、新規作成モードの予定の start プロパティまたは end プロパティとして返されます。
注釈
最小アクセス許可レベル: 読み取り項目
適用される Outlook モード: Compose
メソッド
| get |
予定の開始または終了の時刻を取得します。 日付と時刻は、 |
| get |
予定の開始または終了の時刻を取得します。 日付と時刻は、 |
| set |
予定の開始または終了の時刻を設定します。 start プロパティで この時刻は UTC でなければなりません。 重要: Windows クライアントでは、このメソッドを使用して繰り返しの開始または終了を更新することはできません。 |
| set |
予定の開始または終了の時刻を設定します。 start プロパティで この時刻は UTC でなければなりません。 重要: Windows クライアントでは、このメソッドを使用して繰り返しの開始または終了を更新することはできません。 |
メソッドの詳細
getAsync(options, callback)
予定の開始または終了の時刻を取得します。
日付と時刻は、asyncResult.value プロパティのDate オブジェクトとして提供されます。 値は、世界協定時刻 (UTC) です。
convertToLocalClientTime メソッドを使用して、UTC 時刻をローカル クライアント時刻に変換できます。
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<Date>) => void): void;パラメーター
- options
- Office.AsyncContextOptions
次のプロパティの 1 つ以上を含むオブジェクト リテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。
- callback
-
(asyncResult: Office.AsyncResult<Date>) => void
メソッドが完了すると、 callback パラメーターで渡された関数が、 Office.AsyncResult型の 1 つのパラメーターで呼び出されます。 結果の value プロパティは、 Date オブジェクトです。
戻り値
void
注釈
最小アクセス許可レベル: 読み取り項目
適用される Outlook モード: Compose
getAsync(callback)
予定の開始または終了の時刻を取得します。
日付と時刻は、asyncResult.value プロパティのDate オブジェクトとして提供されます。 値は、世界協定時刻 (UTC) です。
convertToLocalClientTime メソッドを使用して、UTC 時刻をローカル クライアント時刻に変換できます。
getAsync(callback: (asyncResult: Office.AsyncResult<Date>) => void): void;パラメーター
- callback
-
(asyncResult: Office.AsyncResult<Date>) => void
メソッドが完了すると、コールバック パラメーターで渡された関数が、 Office.AsyncResult型の 1 つのパラメーターで呼び出されます。 結果の value プロパティは、 Date オブジェクトです。
戻り値
void
注釈
最小アクセス許可レベル: 読み取り項目
適用される Outlook モード: Compose
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-start-appointment-organizer.yaml
Office.context.mailbox.item.start.getAsync((result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Action failed with message ${result.error.message}`);
return;
}
console.log(`Appointment starts: ${result.value}`);
});
setAsync(dateTime, options, callback)
予定の開始または終了の時刻を設定します。
start プロパティで setAsync メソッドが呼び出された場合、 end プロパティは、前に設定した予定の期間を維持するように調整されます。
end プロパティで setAsync メソッドが呼び出された場合、予定の期間は新しい終了時刻まで延長されます。
この時刻は UTC でなければなりません。convertToUtcClientTime メソッドを使用して、正確な UTC 時刻を取得できます。
重要: Windows クライアントでは、このメソッドを使用して繰り返しの開始または終了を更新することはできません。
setAsync(dateTime: Date, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;パラメーター
- dateTime
-
Date
協定世界時 (UTC) の日時オブジェクト。
- options
- Office.AsyncContextOptions
次のプロパティの 1 つ以上を含むオブジェクト リテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
省略可能。 メソッドが完了すると、 callback パラメーターで渡された関数が、 Office.AsyncResult型の 1 つのパラメーターで呼び出されます。 日付と時刻の設定が失敗した場合、asyncResult.error プロパティにはエラー コードが格納されます。
戻り値
void
注釈
最小アクセス許可レベル: 項目の読み取り/書き込み
適用される Outlook モード: Compose
エラー:
-
InvalidEndTime: 予定の終了時刻は、予定の開始時刻の前です。
例
const startTime = new Date("3/14/2015");
const options = {
// Pass information that can be used in the callback.
asyncContext: {verb: "Set"}
};
Office.context.mailbox.item.start.setAsync(startTime, options, function(result) {
if (result.error) {
console.debug(result.error);
} else {
// Access the asyncContext that was passed to the setAsync method.
console.debug("Start Time " + result.asyncContext.verb);
}
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-start-appointment-organizer.yaml
const start = new Date(); // Represents current date and time.
start.setDate(start.getDate() + 2); // Add 2 days to current date.
Office.context.mailbox.item.start.setAsync(start, (result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Action failed with message ${result.error.message}`);
return;
}
console.log(`Successfully set start date and time to ${start}`);
});
...
Office.context.mailbox.item.start.getAsync((result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Get start date failed with message ${result.error.message}`);
return;
}
const end = result.value; // Set end to current start date and time.
end.setDate(end.getDate() + 1); // Set end as 1 day later than start date.
Office.context.mailbox.item.end.setAsync(end, (result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Set end date failed with message ${result.error.message}`);
return;
}
console.log(`Successfully set end date and time to ${end}`);
});
});
setAsync(dateTime, callback)
予定の開始または終了の時刻を設定します。
start プロパティで setAsync メソッドが呼び出された場合、 end プロパティは、前に設定した予定の期間を維持するように調整されます。
end プロパティで setAsync メソッドが呼び出された場合、予定の期間は新しい終了時刻まで延長されます。
この時刻は UTC でなければなりません。convertToUtcClientTime メソッドを使用して、正確な UTC 時刻を取得できます。
重要: Windows クライアントでは、このメソッドを使用して繰り返しの開始または終了を更新することはできません。
setAsync(dateTime: Date, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;パラメーター
- dateTime
-
Date
協定世界時 (UTC) の日時オブジェクト。
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
省略可能。 メソッドが完了すると、 callback パラメーターで渡された関数が、 Office.AsyncResult型の 1 つのパラメーターで呼び出されます。 日付と時刻の設定が失敗した場合、asyncResult.error プロパティにはエラー コードが格納されます。
戻り値
void
注釈
最小アクセス許可レベル: 項目の読み取り/書き込み
適用される Outlook モード: Compose
エラー:
-
InvalidEndTime: 予定の終了時刻は、予定の開始時刻の前です。
Office Add-ins