Office.Ews interface
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
Exchange Web サービス (EWS) コールバック トークンがorganizationでサポートされているかどうかを判断するメソッドを提供します。
注釈
最小アクセス許可レベル: 読み取り項目
適用できる Outlook モード: Composeまたは読み取り
重要: レガシ Exchange Online ユーザー ID トークンとコールバック トークンはサポートされなくなり、すべての Microsoft 365 テナントでオフになっています。 Outlook アドインで委任されたユーザー アクセスまたはユーザー ID が必要な場合は、MSAL (Microsoft Authentication Library) と入れ子になったアプリ認証 (NAA) を使用することをお勧めします。 Exchange ユーザー ID トークンは、引き続き Exchange オンプレミスでサポートされています。 詳細については、「 入れ子になったアプリ認証に関する FAQ」を参照してください。
使用元
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-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)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
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 API または Outlook REST API 用であるかどうかを識別します。 既定では、 isRest プロパティは false に設定されます。
- callback
-
(asyncResult: Office.AsyncResult<Office.MailboxEnums.TokenStatus>) => void
メソッドが完了すると、 callback パラメーターで渡された関数が、Office.AsyncResult 型の 1 つのパラメーターで呼び出されます。
asyncResult.value プロパティは、Office.MailboxEnums.TokenStatus.Enabled、Office.MailboxEnums.TokenStatus.Disabled、またはOffice.MailboxEnums.TokenStatus.Removedできるトークンの状態を返します。
Office.MailboxEnums.TokenStatus.Removed状態は、メールボックスが、従来の Exchange トークンがオフになっていてサポートされなくなったExchange Online環境でホストされていることを示します。
返品
void
注釈
最小アクセス許可レベル: 読み取り項目
適用できる Outlook モード: Composeまたは読み取り
重要:
getTokenStatusAsyncメソッドは、Outlook on the webおよび Windows (新規およびクラシック (バージョン 2510、ビルド 19328.20000 以降) でプレビューできます。Outlook.com または Gmail メールボックスにアドインを読み込む場合、
getTokenStatusAsyncメソッドはサポートされていません。作成モードで
getTokenStatusAsyncメソッドを呼び出すには、アイテムを保存している必要があります。saveAsyncメソッドには、読み取り/書き込み項目の最小アクセス許可レベルが必要です。
getTokenStatusAsync(callback)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
organizationの EWS コールバック トークンの状態を取得します。
getTokenStatusAsync(callback: (asyncResult: Office.AsyncResult<MailboxEnums.TokenStatus>) => void): void;
パラメーター
- callback
-
(asyncResult: Office.AsyncResult<Office.MailboxEnums.TokenStatus>) => void
メソッドが完了すると、 callback パラメーターで渡された関数が、Office.AsyncResult 型の 1 つのパラメーターで呼び出されます。
asyncResult.value プロパティは、Office.MailboxEnums.TokenStatus.Enabled、Office.MailboxEnums.TokenStatus.Disabled、またはOffice.MailboxEnums.TokenStatus.Removedできるトークンの状態を返します。
Office.MailboxEnums.TokenStatus.Removed状態は、メールボックスが、従来の Exchange トークンがオフになっていてサポートされなくなったExchange Online環境でホストされていることを示します。
返品
void
注釈
最小アクセス許可レベル: 読み取り項目
適用できる Outlook モード: Composeまたは読み取り
重要:
getTokenStatusAsyncメソッドは、Outlook on the webおよび Windows (新規およびクラシック (バージョン 2510、ビルド 19328.20000 以降) でプレビューできます。Outlook.com または Gmail メールボックスにアドインを読み込む場合、
getTokenStatusAsyncメソッドはサポートされていません。作成モードで
getTokenStatusAsyncメソッドを呼び出すには、アイテムを保存している必要があります。saveAsyncメソッドには、読み取り/書き込み項目の最小アクセス許可レベルが必要です。