Partager via

Office.Ews interface

Paquet:
outlook

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

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

Remarques

[ Ensemble d’API : préversion de boîte aux lettres ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Rédiger ou Lire

Important : les jetons d’identité d’utilisateur et les jetons de rappel hérités Exchange Online ne sont plus pris en charge et sont désactivés sur tous les locataires 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 en local. Pour plus d’informations, consultez FAQ sur l’authentification des applications imbriquées.

Exemples

// 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éthodes

getTokenStatusAsync(options, callback)

Obtient la status des jetons de rappel EWS dans un organization.
getTokenStatusAsync(callback)

Obtient la status des jetons de rappel EWS dans un organization.

Détails de la méthode

getTokenStatusAsync(options, callback)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Obtient la status des jetons de rappel EWS dans un organization.

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 à laquelle 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

Une fois la méthode 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 jeton status, qui peut êtreOffice.MailboxEnums.TokenStatus.Enabled , Office.MailboxEnums.TokenStatus.Disabledou Office.MailboxEnums.TokenStatus.Removed. Une Office.MailboxEnums.TokenStatus.Removed status indique que la boîte aux lettres est hébergée dans un environnement Exchange Online où les jetons Exchange hérités sont désactivés et ne sont plus pris en charge.

Retours

void

Remarques

[ Ensemble d’API : préversion de boîte aux lettres ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Rédiger ou Lire

Important:

  • La getTokenStatusAsync méthode est disponible en préversion dans Outlook sur le web et sur Windows (nouveau et classique (version 2510, build 19328.20000 et versions ultérieures)).

  • La 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 en lecture/écriture.

getTokenStatusAsync(callback)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Obtient la status des jetons de rappel EWS dans un organization.

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

Paramètres

callback

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

Une fois la méthode 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 jeton status, qui peut êtreOffice.MailboxEnums.TokenStatus.Enabled , Office.MailboxEnums.TokenStatus.Disabledou Office.MailboxEnums.TokenStatus.Removed. Une Office.MailboxEnums.TokenStatus.Removed status indique que la boîte aux lettres est hébergée dans un environnement Exchange Online où les jetons Exchange hérités sont désactivés et ne sont plus pris en charge.

Retours

void

Remarques

[ Ensemble d’API : préversion de boîte aux lettres ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Rédiger ou Lire

Important:

  • La getTokenStatusAsync méthode est disponible en préversion dans Outlook sur le web et sur Windows (nouveau et classique (version 2510, build 19328.20000 et versions ultérieures)).

  • La 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 en lecture/écriture.