Office.EnhancedLocation interface
予定の場所のセットを表します。
注釈
最小アクセス許可レベル: 読み取り項目
適用できる Outlook モード: 新規作成または読み取り
メソッド
| add |
予定に関連付けられている場所のセットにを追加します。 |
| add |
予定に関連付けられている場所のセットにを追加します。 |
| get |
予定に関連付けられている場所のセットを取得します。 注: 予定の場所として追加された 個人用連絡先グループ は、この方法では返されません。 |
| get |
予定に関連付けられている場所のセットを取得します。 注: 予定の場所として追加された 個人用連絡先グループ は、この方法では返されません。 |
| remove |
予定に関連付けられている場所のセットを削除します。 同じ名前の場所が複数ある場合、一致するすべての場所は、 |
| remove |
予定に関連付けられている場所のセットを削除します。 同じ名前の場所が複数ある場合、一致するすべての場所は、 |
メソッドの詳細
addAsync(locationIdentifiers, options, callback)
予定に関連付けられている場所のセットにを追加します。
addAsync(locationIdentifiers: LocationIdentifier[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;パラメーター
- locationIdentifiers
現在の場所の一覧に追加する場所。
- options
- Office.AsyncContextOptions
次のプロパティの 1 つ以上を含むオブジェクト リテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
省略可能。 メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーターasyncResultで呼び出されます。 呼び出しが成功したかどうかを判断するには、asyncResult の status プロパティを確認します。
戻り値
void
注釈
最小アクセス許可レベル: 項目の読み取り/書き込み
適用できる Outlook モード: 新規作成
エラー:
-
InvalidFormatError: 指定されたデータ オブジェクトの形式が無効です。
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-add-remove-enhancedlocation-appointment.yaml
const locations = [
{
id: "Contoso",
type: Office.MailboxEnums.LocationType.Custom
},
{
id: "room500@test.com",
type: Office.MailboxEnums.LocationType.Room
}
];
Office.context.mailbox.item.enhancedLocation.addAsync(locations, (result) => {
if (result.status === Office.AsyncResultStatus.Succeeded) {
console.log(`Successfully added locations ${JSON.stringify(locations)}`);
} else {
console.error(`Failed to add locations. Error message: ${result.error.message}`);
}
});
addAsync(locationIdentifiers, callback)
予定に関連付けられている場所のセットにを追加します。
addAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;パラメーター
- locationIdentifiers
現在の場所の一覧に追加する場所。
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
省略可能。 メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーターasyncResultで呼び出されます。 呼び出しが成功したかどうかを判断するには、asyncResult の status プロパティを確認します。
戻り値
void
注釈
最小アクセス許可レベル: 項目の読み取り/書き込み
適用できる Outlook モード: 新規作成
エラー:
-
InvalidFormatError: 指定されたデータ オブジェクトの形式が無効です。
getAsync(options, callback)
予定に関連付けられている場所のセットを取得します。
注: 予定の場所として追加された 個人用連絡先グループ は、この方法では返されません。
getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<LocationDetails[]>) => void): void;パラメーター
- options
- Office.AsyncContextOptions
次のプロパティの 1 つ以上を含むオブジェクト リテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。
- callback
-
(asyncResult: Office.AsyncResult<Office.LocationDetails[]>) => void
省略可能。 メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーターasyncResultで呼び出されます。
戻り値
void
注釈
最小アクセス許可レベル: 読み取り項目
適用できる Outlook モード: 新規作成または読み取り
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-add-remove-enhancedlocation-appointment.yaml
Office.context.mailbox.item.enhancedLocation.getAsync((result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Failed to get locations. Error message: ${result.error.message}`);
return;
}
const places = result.value;
if (places && places.length > 0) {
result.value.forEach(function(place) {
console.log(`Location: ${place.displayName} (type: ${place.locationIdentifier.type})`);
if (place.locationIdentifier.type === Office.MailboxEnums.LocationType.Room) {
console.log("Email address: " + place.emailAddress);
}
});
} else {
console.log("There are no locations.");
}
});
getAsync(callback)
予定に関連付けられている場所のセットを取得します。
注: 予定の場所として追加された 個人用連絡先グループ は、この方法では返されません。
getAsync(callback?: (asyncResult: Office.AsyncResult<LocationDetails[]>) => void): void;パラメーター
- callback
-
(asyncResult: Office.AsyncResult<Office.LocationDetails[]>) => void
省略可能。 メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーターasyncResultで呼び出されます。
戻り値
void
注釈
最小アクセス許可レベル: 読み取り項目
適用できる Outlook モード: 新規作成または読み取り
removeAsync(locationIdentifiers, options, callback)
予定に関連付けられている場所のセットを削除します。
同じ名前の場所が複数ある場合、一致するすべての場所は、 locationIdentifiersで 1 つだけ指定された場合でも削除されます。
removeAsync(locationIdentifiers: LocationIdentifier[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;パラメーター
- locationIdentifiers
現在の場所の一覧から削除する場所。
- options
- Office.AsyncContextOptions
次のプロパティの 1 つ以上を含むオブジェクト リテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
省略可能。 メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーターasyncResultで呼び出されます。 呼び出しが成功したかどうかを判断するには、asyncResult の status プロパティを確認します。
戻り値
void
注釈
最小アクセス許可レベル: 項目の読み取り/書き込み
適用できる Outlook モード: 新規作成
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-add-remove-enhancedlocation-appointment.yaml
const locations = [
{
id: "Contoso",
type: Office.MailboxEnums.LocationType.Custom
},
{
id: "room500@test.com",
type: Office.MailboxEnums.LocationType.Room
}
];
Office.context.mailbox.item.enhancedLocation.removeAsync(locations, (result) => {
if (result.status === Office.AsyncResultStatus.Succeeded) {
console.log(`Successfully removed locations ${JSON.stringify(locations)}`);
} else {
console.error(`Failed to remove locations. Error message: ${result.error.message}`);
}
});
removeAsync(locationIdentifiers, callback)
予定に関連付けられている場所のセットを削除します。
同じ名前の場所が複数ある場合、一致するすべての場所は、 locationIdentifiersで 1 つだけ指定された場合でも削除されます。
removeAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;パラメーター
- locationIdentifiers
現在の場所の一覧から削除する場所。
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
省略可能。 メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーターasyncResultで呼び出されます。 呼び出しが成功したかどうかを判断するには、asyncResult の status プロパティを確認します。
戻り値
void
注釈
最小アクセス許可レベル: 項目の読み取り/書き込み
適用できる Outlook モード: 新規作成
Office Add-ins