Compartilhar via


Office.Ews interface

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Fornece métodos para determinar se os tokens de chamada de retorno do Exchange Web Services (EWS) são suportados numa organização.

Comentários

[ Conjunto de API: Pré-visualização da caixa de correio ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Compose ou Leitura

Importante: os tokens de identidade de utilizador e os tokens de chamada de retorno legados Exchange Online já não são suportados e estão desativados em todos os inquilinos do Microsoft 365. Se um suplemento do Outlook exigir acesso delegado ou identidade de utilizador, recomendamos que utilize a MSAL (Biblioteca de Autenticação da Microsoft) e a autenticação de aplicações aninhadas (NAA). Os tokens de identidade de utilizador do Exchange ainda são suportados no Exchange no local. Para obter mais informações, veja FAQ sobre autenticação de aplicações aninhadas.

Exemplos

// 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;
  }
});

Métodos

getTokenStatusAsync(options, callback)

Obtém o status de tokens de chamada de retorno do EWS numa organização.

getTokenStatusAsync(callback)

Obtém o status de tokens de chamada de retorno do EWS numa organização.

Detalhes do método

getTokenStatusAsync(options, callback)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Obtém o status de tokens de chamada de retorno do EWS numa organização.

getTokenStatusAsync(options: Office.AsyncContextOptions & { isRest?: boolean }, callback: (asyncResult: Office.AsyncResult<MailboxEnums.TokenStatus>) => void): void;

Parâmetros

options

Office.AsyncContextOptions & { isRest?: boolean }

Um objeto literal que contém uma ou mais das propriedades a seguir. asyncContext : todos os dados a que pretende aceder na função de chamada de retorno. isRest : identifica se o token necessário é para as APIs REST do EWS ou do Outlook. Por predefinição, a isRest propriedade está definida como false.

callback

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

Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult. A asyncResult.value propriedade devolve o token status, que pode serOffice.MailboxEnums.TokenStatus.Enabled , Office.MailboxEnums.TokenStatus.Disabledou Office.MailboxEnums.TokenStatus.Removed. Um Office.MailboxEnums.TokenStatus.Removed status indica que a caixa de correio está alojada num ambiente Exchange Online onde os tokens do Exchange legados estão desativados e já não são suportados.

Retornos

void

Comentários

[ Conjunto de API: Pré-visualização da caixa de correio ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Compose ou Leitura

Importante:

  • O getTokenStatusAsync método está disponível para pré-visualização no Outlook na Web e no Windows (novo e clássico (Versão 2510, Compilação 19328.20000 e posterior)).

  • O getTokenStatusAsync método não é suportado se carregar um suplemento numa caixa de correio Outlook.com ou Gmail.

  • Chamar o getTokenStatusAsync método no modo de composição requer que tenha guardado o item. O saveAsync método requer um nível mínimo de permissão de item de leitura/escrita.

getTokenStatusAsync(callback)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Obtém o status de tokens de chamada de retorno do EWS numa organização.

getTokenStatusAsync(callback: (asyncResult: Office.AsyncResult<MailboxEnums.TokenStatus>) => void): void;

Parâmetros

callback

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

Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult. A asyncResult.value propriedade devolve o token status, que pode serOffice.MailboxEnums.TokenStatus.Enabled , Office.MailboxEnums.TokenStatus.Disabledou Office.MailboxEnums.TokenStatus.Removed. Um Office.MailboxEnums.TokenStatus.Removed status indica que a caixa de correio está alojada num ambiente Exchange Online onde os tokens do Exchange legados estão desativados e já não são suportados.

Retornos

void

Comentários

[ Conjunto de API: Pré-visualização da caixa de correio ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Compose ou Leitura

Importante:

  • O getTokenStatusAsync método está disponível para pré-visualização no Outlook na Web e no Windows (novo e clássico (Versão 2510, Compilação 19328.20000 e posterior)).

  • O getTokenStatusAsync método não é suportado se carregar um suplemento numa caixa de correio Outlook.com ou Gmail.

  • Chamar o getTokenStatusAsync método no modo de composição requer que tenha guardado o item. O saveAsync método requer um nível mínimo de permissão de item de leitura/escrita.