Office.IsAllDayEvent interface
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
Outlook アドインで会議の終日イベントの状態を取得して設定する方法を提供します。
メソッド
| get |
イベントが 1 日中であるかどうかを示すブール値を取得します。 |
| get |
イベントが 1 日中であるかどうかを示すブール値を取得します。 |
| set |
予定の終日イベントの状態を設定します。 |
| set |
予定の終日イベントの状態を設定します。 |
メソッドの詳細
getAsync(options, callback)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
イベントが 1 日中であるかどうかを示すブール値を取得します。
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 モード: Compose
getAsync(callback)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
イベントが 1 日中であるかどうかを示すブール値を取得します。
getAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;パラメーター
- callback
-
(asyncResult: Office.AsyncResult<boolean>) => void
メソッドが完了すると、 callback パラメーターで渡された関数が型 Office.AsyncResult の 1 つのパラメーターで呼び出されます。
返品
void
注釈
最小アクセス許可レベル: 項目の読み取り
適用可能な Outlook モード: Compose
例
// 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
注釈
予定が終日イベントとしてマークされている場合: - 開始時刻と終了時刻は (Outlook UI と同様に) 午前 12:00 にマークされます。 開始時刻は午前 12:00 に戻り、終了時刻は翌日の午前 12:00 になります。
最小アクセス許可レベル: 項目の読み取り/書き込み
適用可能な Outlook モード: Compose
例
// 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
注釈
予定が終日イベントとしてマークされている場合: - 開始時刻と終了時刻は (Outlook UI と同様に) 午前 12:00 にマークされます。 開始時刻は午前 12:00 に戻り、終了時刻は翌日の午前 12:00 になります。
最小アクセス許可レベル: 項目の読み取り/書き込み
適用可能な Outlook モード: Compose