Office.Ews interface

Paquet:
outlook

Fournit des méthodes pour déterminer si les jetons de rappel EWS (services Web Exchange) sont pris en charge dans une organisation.

Remarques

Jeu d’API : Boîte aux lettres 1.16

Niveau d’autorisation minimal : lire l’élément

Mode Outlook applicable : Rédiger ou Lire

Important : les jetons d’identité utilisateur et les jetons de rappel hérités d’Exchange Online ne sont plus pris en charge et sont désactivés pour tous les clients Microsoft 365. Si un complément Outlook nécessite un accès utilisateur délégué ou une identité d’utilisateur, nous vous recommandons d’utiliser MSAL (bibliothèque d’authentification Microsoft) et l’authentification d’application imbriquée (NAA). Les jetons d’identité utilisateur Exchange sont toujours pris en charge pour Exchange sur site. Pour plus d’informations, consultez FAQ sur l’authentification des applications imbriquées.

Utilisateur

Exemples

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

Méthodes

getTokenStatusAsync(options, callback)

Obtient le status des jetons de rappel EWS dans une organisation.
getTokenStatusAsync(callback)

Obtient le status des jetons de rappel EWS dans une organisation.

Détails de la méthode

getTokenStatusAsync(options, callback)

Obtient le status des jetons de rappel EWS dans une organisation.

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

Paramètres

options

Office.AsyncContextOptions & { isRest?: boolean }

Littéral d’objet contenant une ou plusieurs des propriétés suivantes. asyncContext : toutes les données auxquelles vous souhaitez accéder dans la fonction de rappel. isRest : identifie si le jeton nécessaire est destiné aux API REST EWS ou Outlook. Par défaut, la isRest propriété est définie sur false.

callback

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

Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult. La asyncResult.value propriété retourne le status de jeton, qui peut êtreOffice.MailboxEnums.TokenStatus.Enabled , Office.MailboxEnums.TokenStatus.Disabled, ou Office.MailboxEnums.TokenStatus.Removed. Un Office.MailboxEnums.TokenStatus.Removed status indique que la boîte aux lettres est hébergée dans un environnement Exchange Online dans lequel les jetons Exchange hérités sont désactivés et ne sont plus pris en charge.

Retours

void

Remarques

Jeu d’API : Boîte aux lettres 1.16

Niveau d’autorisation minimal : lire l’élément

Mode Outlook applicable : Rédiger ou Lire

Important:

  • Cette getTokenStatusAsync méthode n’est pas prise en charge si vous chargez un complément dans une boîte aux lettres Outlook.com ou Gmail.

  • L’appel de la getTokenStatusAsync méthode en mode composition nécessite que vous ayez enregistré l’élément. La saveAsync méthode nécessite un niveau d’autorisation minimal d’élément de lecture/écriture.

getTokenStatusAsync(callback)

Obtient le status des jetons de rappel EWS dans une organisation.

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

Paramètres

callback

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

Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult. La asyncResult.value propriété retourne le status de jeton, qui peut êtreOffice.MailboxEnums.TokenStatus.Enabled , Office.MailboxEnums.TokenStatus.Disabled, ou Office.MailboxEnums.TokenStatus.Removed. Un Office.MailboxEnums.TokenStatus.Removed status indique que la boîte aux lettres est hébergée dans un environnement Exchange Online dans lequel les jetons Exchange hérités sont désactivés et ne sont plus pris en charge.

Retours

void

Remarques

Jeu d’API : Boîte aux lettres 1.16

Niveau d’autorisation minimal : lire l’élément

Mode Outlook applicable : Rédiger ou Lire

Important:

  • Cette getTokenStatusAsync méthode n’est pas prise en charge si vous chargez un complément dans une boîte aux lettres Outlook.com ou Gmail.

  • L’appel de la getTokenStatusAsync méthode en mode composition nécessite que vous ayez enregistré l’élément. La saveAsync méthode nécessite un niveau d’autorisation minimal d’élément de lecture/écriture.