Office.Ews interface
Exchange Web サービス (EWS) コールバック トークンがorganizationでサポートされているかどうかを判断する方法を提供します。
注釈
最小アクセス許可レベル: 項目の読み取り
適用可能な Outlook モード: Composeまたは読み取り
重要: 従来の Exchange Online ユーザー ID トークンとコールバック トークンはサポートされなくなり、すべての Microsoft 365 テナントでオフになっています。 Outlook アドインで代理ユーザー アクセスまたはユーザー ID が必要な場合は、MSAL (Microsoft 認証ライブラリ) と入れ子になったアプリ認証 (NAA) を使うことをお勧めします。 Exchange ユーザー ID トークンは、Exchange オンプレミスで引き続きサポートされます。 詳細については、「 入れ子になったアプリ認証に関する FAQ」を参照してください。
使用元
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/89-other-mailbox-apis/get-token-status.yaml
Office.context.mailbox.diagnostics.ews.getTokenStatusAsync({ isRest: false }, (result) => {
if (result.status === Office.AsyncResultStatus.Failed) {
console.log(result.error.message);
return;
}
const status = result.value;
switch (status) {
case Office.MailboxEnums.TokenStatus.Enabled:
console.log("EWS callback tokens are enabled.");
break;
case Office.MailboxEnums.TokenStatus.Disabled:
console.log("EWS callback tokens are disabled.");
break;
case Office.MailboxEnums.TokenStatus.Removed:
console.log("The organization has an Exchange Online environment. Legacy Exchange tokens are no longer supported.");
break;
}
});
メソッド
| get |
organization 内の EWS コールバック トークンの状態を取得します。 |
| get |
organization 内の EWS コールバック トークンの状態を取得します。 |
メソッドの詳細
getTokenStatusAsync(options, callback)
organization 内の EWS コールバック トークンの状態を取得します。
getTokenStatusAsync(options: Office.AsyncContextOptions & { isRest?: boolean }, callback: (asyncResult: Office.AsyncResult<MailboxEnums.TokenStatus>) => void): void;パラメーター
- options
-
Office.AsyncContextOptions & { isRest?: boolean }
次のプロパティのうち 1 つ以上を含むオブジェクト リテラル。
asyncContext
: コールバック関数でアクセスするデータ。
isRest
: 必要なトークンが EWS 用か Outlook REST API 用かを識別します。 既定では、 isRest プロパティは false に設定されています。
- callback
-
(asyncResult: Office.AsyncResult<Office.MailboxEnums.TokenStatus>) => void
メソッドが完了すると、 callback パラメーターに渡された関数が Office.AsyncResult 型の単一のパラメーターで呼び出されます。
asyncResult.value プロパティはトークンの状態 (Office.MailboxEnums.TokenStatus.Enabled、Office.MailboxEnums.TokenStatus.Disabled、Office.MailboxEnums.TokenStatus.Removed のいずれか) を返します。
Office.MailboxEnums.TokenStatus.Removed状態は、レガシ Exchange トークンが無効になり、サポートされなくなったExchange Online環境でメールボックスがホストされていることを示します。
返品
void
注釈
最小アクセス許可レベル: 項目の読み取り
適用可能な Outlook モード: Composeまたは読み取り
重要:
Outlook.com または Gmail メールボックスにアドインを読み込む場合、
getTokenStatusAsyncメソッドはサポートされません。作成モードで
getTokenStatusAsyncメソッドを呼び出すには、アイテムを保存しておく必要があります。saveAsyncメソッドでは、読み取り/書き込み項目の最小アクセス許可レベルが必要です。
getTokenStatusAsync(callback)
organization 内の EWS コールバック トークンの状態を取得します。
getTokenStatusAsync(callback: (asyncResult: Office.AsyncResult<MailboxEnums.TokenStatus>) => void): void;パラメーター
- callback
-
(asyncResult: Office.AsyncResult<Office.MailboxEnums.TokenStatus>) => void
メソッドが完了すると、 callback パラメーターに渡された関数が Office.AsyncResult 型の単一のパラメーターで呼び出されます。
asyncResult.value プロパティはトークンの状態 (Office.MailboxEnums.TokenStatus.Enabled、Office.MailboxEnums.TokenStatus.Disabled、Office.MailboxEnums.TokenStatus.Removed のいずれか) を返します。
Office.MailboxEnums.TokenStatus.Removed状態は、レガシ Exchange トークンが無効になり、サポートされなくなったExchange Online環境でメールボックスがホストされていることを示します。
返品
void
注釈
最小アクセス許可レベル: 項目の読み取り
適用可能な Outlook モード: Composeまたは読み取り
重要:
Outlook.com または Gmail メールボックスにアドインを読み込む場合、
getTokenStatusAsyncメソッドはサポートされません。作成モードで
getTokenStatusAsyncメソッドを呼び出すには、アイテムを保存しておく必要があります。saveAsyncメソッドでは、読み取り/書き込み項目の最小アクセス許可レベルが必要です。