Office.IsAllDayEvent interface
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
Outlook アドインで会議の終日のイベント状態を取得および設定するメソッドを提供します。
注釈
最小アクセス許可レベル: 読み取り項目
適用できる Outlook モード: 新規作成
メソッド
| get |
イベントが終日かどうかを示すブール値を取得します。 |
| get |
イベントが終日かどうかを示すブール値を取得します。 |
| set |
予定の終日イベントの状態を設定します。 |
| set |
予定の終日イベントの状態を設定します。 |
メソッドの詳細
getAsync(options, callback)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
イベントが終日かどうかを示すブール値を取得します。
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;パラメーター
- options
- Office.AsyncContextOptions
次のプロパティの 1 つ以上を含むオブジェクト リテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。
- callback
-
(asyncResult: Office.AsyncResult<boolean>) => void
メソッドが完了すると、 callback パラメーターで渡された関数が、 Office.AsyncResult型の 1 つのパラメーターで呼び出されます。
戻り値
void
注釈
最小アクセス許可レベル: 読み取り項目
適用できる Outlook モード: 新規作成
getAsync(callback)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
イベントが終日かどうかを示すブール値を取得します。
getAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;パラメーター
- callback
-
(asyncResult: Office.AsyncResult<boolean>) => void
メソッドが完了すると、 callback パラメーターで渡された関数が、 Office.AsyncResult型の 1 つのパラメーターで呼び出されます。
戻り値
void
注釈
最小アクセス許可レベル: 読み取り項目
適用できる Outlook モード: 新規作成
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/get-set-isalldayevent.yaml
Office.context.mailbox.item.isAllDayEvent.getAsync(function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
console.log("Is this an all-day event? " + asyncResult.value);
} else {
console.log("Failed to get if this is an all-day event. Error: " + JSON.stringify(asyncResult.error));
}
});
setAsync(isAllDayEvent, options, callback)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
予定の終日イベントの状態を設定します。
setAsync(isAllDayEvent: boolean, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;パラメーター
- isAllDayEvent
-
boolean
ブール値を使用して、終日イベントの状態を設定します。
- options
- Office.AsyncContextOptions
次のプロパティの 1 つ以上を含むオブジェクト リテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
省略可能。 メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーターasyncResultで呼び出されます。
戻り値
void
注釈
予定が終日イベントとしてマークされている場合: - 開始時刻と終了時刻は午前 12:00 (Outlook UI と同様) としてマークされます。 開始時刻は午前 12 時に返され、終了時刻は翌日の午前 12 時になります。
最小アクセス許可レベル: 項目の読み取り/書き込み
適用できる Outlook モード: 新規作成
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/get-set-isalldayevent.yaml
Office.context.mailbox.item.isAllDayEvent.setAsync(true, function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Failed) {
console.log("Failed to set all-day event: " + JSON.stringify(asyncResult.error));
} else {
console.log("Appointment set to all-day event.");
}
});
setAsync(isAllDayEvent, callback)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
予定の終日イベントの状態を設定します。
setAsync(isAllDayEvent: boolean, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;パラメーター
- isAllDayEvent
-
boolean
ブール値を使用して、終日イベントの状態を設定します。
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
省略可能。 メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーターasyncResultで呼び出されます。
戻り値
void
注釈
予定が終日イベントとしてマークされている場合: - 開始時刻と終了時刻は午前 12:00 (Outlook UI と同様) としてマークされます。 開始時刻は午前 12 時に返され、終了時刻は翌日の午前 12 時になります。
最小アクセス許可レベル: 項目の読み取り/書き込み
適用できる Outlook モード: 新規作成
Office Add-ins