Office.Ews interface
提供用于确定组织是否支持 Exchange Web 服务 (EWS) 回调令牌的方法。
注解
最低权限级别: 读取项目
适用的 Outlook 模式:Compose 或 Read
重要提示:不再支持旧版 Exchange Online 用户标识令牌和回调令牌,并在所有 Microsoft 365 租户中将其关闭。 如果 Outlook 加载项需要委派的用户访问权限或用户标识,建议使用 MSAL (Microsoft 身份验证库) 和嵌套应用身份验证 (NAA) 。 Exchange 内部部署仍支持 Exchange 用户标识令牌。 有关详细信息,请参阅 嵌套应用身份验证常见问题解答。
使用方
示例
// 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 |
获取组织中 EWS 回调令牌的状态。 |
| get |
获取组织中 EWS 回调令牌的状态。 |
方法详细信息
getTokenStatusAsync(options, callback)
获取组织中 EWS 回调令牌的状态。
getTokenStatusAsync(options: Office.AsyncContextOptions & { isRest?: boolean }, callback: (asyncResult: Office.AsyncResult<MailboxEnums.TokenStatus>) => void): void;
参数
- options
-
Office.AsyncContextOptions & { isRest?: boolean }
包含一个或多个以下属性的对象文本。
asyncContext
:想要在回调函数中访问的任何数据。
isRest
:标识所需的令牌是用于 EWS 还是 Outlook REST API。 默认情况下,该 isRest 属性设置为 false。
- callback
-
(asyncResult: Office.AsyncResult<Office.MailboxEnums.TokenStatus>) => void
方法完成后,将使用类型为 Office.AsyncResult 的单个参数调用传入参数的 callback 函数。 该asyncResult.value属性返回令牌状态,可以是 Office.MailboxEnums.TokenStatus.Enabled、 或 。Office.MailboxEnums.TokenStatus.RemovedOffice.MailboxEnums.TokenStatus.Disabled
Office.MailboxEnums.TokenStatus.Removed状态指示邮箱托管在已关闭且不再支持旧版 Exchange 令牌的 Exchange Online 环境中。
返回
void
注解
最低权限级别: 读取项目
适用的 Outlook 模式:Compose 或 Read
重要说明:
如果在 Outlook.com 或 Gmail 邮箱中加载加载项,则不支持此
getTokenStatusAsync方法。在撰写模式下调用该
getTokenStatusAsync方法需要您已经保存该项。 该saveAsync方法需要 读/写项目的最低权限级别。
getTokenStatusAsync(callback)
获取组织中 EWS 回调令牌的状态。
getTokenStatusAsync(callback: (asyncResult: Office.AsyncResult<MailboxEnums.TokenStatus>) => void): void;
参数
- callback
-
(asyncResult: Office.AsyncResult<Office.MailboxEnums.TokenStatus>) => void
方法完成后,将使用类型为 Office.AsyncResult 的单个参数调用传入参数的 callback 函数。 该asyncResult.value属性返回令牌状态,可以是 Office.MailboxEnums.TokenStatus.Enabled、 或 。Office.MailboxEnums.TokenStatus.RemovedOffice.MailboxEnums.TokenStatus.Disabled
Office.MailboxEnums.TokenStatus.Removed状态指示邮箱托管在已关闭且不再支持旧版 Exchange 令牌的 Exchange Online 环境中。
返回
void
注解
最低权限级别: 读取项目
适用的 Outlook 模式:Compose 或 Read
重要说明:
如果在 Outlook.com 或 Gmail 邮箱中加载加载项,则不支持此
getTokenStatusAsync方法。在撰写模式下调用该
getTokenStatusAsync方法需要您已经保存该项。 该saveAsync方法需要 读/写项目的最低权限级别。