Office.Location interface

パッケージ:

outlook

Outlook アドインで会議の場所を取得し設定する方法を提供します。

注釈

[ API セット: メールボックス 1.1 ]

最小アクセス許可レベル: アイテムの読み取り

適用できる Outlook モード: 新規作成

メソッド

getAsync(options, callback)	予定の場所を取得します。 getAsync メソッドは、Exchange サーバーへの非同期呼び出しを開始し、予定の場所を取得します。 予定の場所は、 プロパティの asyncResult.value 文字列として提供されます。
getAsync(callback)	予定の場所を取得します。 getAsync メソッドは、Exchange サーバーへの非同期呼び出しを開始し、予定の場所を取得します。 予定の場所は、 プロパティの asyncResult.value 文字列として提供されます。
setAsync(location, options, callback)	予定の場所を設定します。 setAsync メソッドは、予定の場所を設定する Exchange サーバーへの非同期呼び出しを開始します。 予定の場所を設定すると、現在の場所が上書きされます。
setAsync(location, callback)	予定の場所を設定します。 setAsync メソッドは、予定の場所を設定する Exchange サーバーへの非同期呼び出しを開始します。 予定の場所を設定すると、現在の場所が上書きされます。

メソッドの詳細

getAsync(options, callback)

予定の場所を取得します。

getAsync メソッドは、Exchange サーバーへの非同期呼び出しを開始し、予定の場所を取得します。 予定の場所は、 プロパティの asyncResult.value 文字列として提供されます。

getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;

パラメーター

options

Office.AsyncContextOptions

次のプロパティの 1 つ以上を含むオブジェクト リテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。

callback

(asyncResult: Office.AsyncResult<string>) => void

メソッドが完了すると、 パラメーターで callback 渡された関数が、 型 Office.AsyncResultの 1 つのパラメーターで呼び出されます。

戻り値

void

注釈

[ API セット: メールボックス 1.1 ]

最小アクセス許可レベル: アイテムの読み取り

適用できる Outlook モード: 新規作成

例

const userContext = { value : 1 };
Office.context.mailbox.item.location.getAsync( { context: userContext}, callback);

function callback(asyncResult) {
    const context = asyncResult.context;
    const location = asyncResult.value;
}

getAsync(callback)

予定の場所を取得します。

getAsync メソッドは、Exchange サーバーへの非同期呼び出しを開始し、予定の場所を取得します。 予定の場所は、 プロパティの asyncResult.value 文字列として提供されます。

getAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;

パラメーター

callback

(asyncResult: Office.AsyncResult<string>) => void

メソッドが完了すると、 パラメーターで callback 渡された関数が、 型 Office.AsyncResultの 1 つのパラメーターで呼び出されます。

戻り値

void

注釈

[ API セット: メールボックス 1.1 ]

最小アクセス許可レベル: アイテムの読み取り

適用できる Outlook モード: 新規作成

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-location-appointment-organizer.yaml

Office.context.mailbox.item.location.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Appointment location: ${result.value}`);
});

setAsync(location, options, callback)

予定の場所を設定します。

setAsync メソッドは、予定の場所を設定する Exchange サーバーへの非同期呼び出しを開始します。 予定の場所を設定すると、現在の場所が上書きされます。

setAsync(location: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

パラメーター

location

string

予定の場所。 文字列の最大長は 255 文字です。

options

Office.AsyncContextOptions

次のプロパティの 1 つ以上を含むオブジェクト リテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。

callback

(asyncResult: Office.AsyncResult<void>) => void

オプション。 メソッドが完了すると、 パラメーターで callback 渡された関数が、 型 Office.AsyncResultの 1 つのパラメーターで呼び出されます。 場所の設定に失敗すると、asyncResult.error プロパティにエラー コードが格納されます。

戻り値

void

注釈

[ API セット: メールボックス 1.1 ]

最小アクセス許可レベル: アイテムの読み取り

適用できる Outlook モード: 新規作成

エラー:

• DataExceedsMaximumSize: location パラメーターが 255 文字を超えています。

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-location-appointment-organizer.yaml

const location = "my office";
Office.context.mailbox.item.location.setAsync(location, (result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Successfully set location to ${location}`);
});

setAsync(location, callback)

予定の場所を設定します。

setAsync メソッドは、予定の場所を設定する Exchange サーバーへの非同期呼び出しを開始します。 予定の場所を設定すると、現在の場所が上書きされます。

setAsync(location: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

パラメーター

location

string

予定の場所。 文字列の最大長は 255 文字です。

callback

(asyncResult: Office.AsyncResult<void>) => void

オプション。 メソッドが完了すると、 パラメーターで callback 渡された関数が、 型 Office.AsyncResultの 1 つのパラメーターで呼び出されます。 場所の設定に失敗すると、asyncResult.error プロパティにエラー コードが格納されます。

戻り値

void

注釈

[ API セット: メールボックス 1.1 ]

最小アクセス許可レベル: アイテムの読み取り

適用できる Outlook モード: 新規作成

エラー:

• DataExceedsMaximumSize: location パラメーターが 255 文字を超えています。