Freigeben über


Office.Ews interface

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Stellt Methoden bereit, mit denen ermittelt werden kann, ob EWS-Rückruftoken (Exchange Web Services) in einem organization unterstützt werden.

Hinweise

[ API-Satz: Postfachvorschau ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose oder Lesen

Wichtig: Legacy-Exchange Online Benutzeridentitätstoken und Rückruftoken werden nicht mehr unterstützt und für alle Microsoft 365-Mandanten deaktiviert. Wenn ein Outlook-Add-In delegierten Benutzerzugriff oder eine Benutzeridentität erfordert, empfehlen wir die Verwendung von MSAL (Microsoft Authentication Library) und geschachtelter App-Authentifizierung (NAA). Exchange-Benutzeridentitätstoken werden für lokale Exchange-Instanzen weiterhin unterstützt. Weitere Informationen finden Sie unter Häufig gestellte Fragen zur Authentifizierung geschachtelter Apps.

Beispiele

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

Methoden

getTokenStatusAsync(options, callback)

Ruft die status von EWS-Rückruftoken in einem organization ab.

getTokenStatusAsync(callback)

Ruft die status von EWS-Rückruftoken in einem organization ab.

Details zur Methode

getTokenStatusAsync(options, callback)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft die status von EWS-Rückruftoken in einem organization ab.

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

Parameter

options

Office.AsyncContextOptions & { isRest?: boolean }

Ein Objektliteral, das mindestens eine der folgenden Eigenschaften enthält. asyncContext : Alle Daten, auf die Sie in der Rückruffunktion zugreifen möchten. isRest : Gibt an, ob das erforderliche Token für EWS- oder Outlook-REST-APIs verwendet wird. Standardmäßig ist die isRest -Eigenschaft auf falsefestgelegt.

callback

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

Nach Abschluss der Methode wird die im callback Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResult aufgerufen. Die asyncResult.value -Eigenschaft gibt das Token status zurück, das ,Office.MailboxEnums.TokenStatus.Disabled oderOffice.MailboxEnums.TokenStatus.Removed sein Office.MailboxEnums.TokenStatus.Enabledkann. Ein Office.MailboxEnums.TokenStatus.Removed status gibt an, dass das Postfach in einer Exchange Online Umgebung gehostet wird, in der Legacy-Exchange-Token deaktiviert und nicht mehr unterstützt werden.

Gibt zurück

void

Hinweise

[ API-Satz: Postfachvorschau ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose oder Lesen

Wichtig:

  • Die getTokenStatusAsync Methode ist in Outlook im Web und unter Windows (neu und klassisch (Version 2510, Build 19328.20000 und höher)) als Vorschauversion verfügbar.

  • Die getTokenStatusAsync Methode wird nicht unterstützt, wenn Sie ein Add-In in ein Outlook.com- oder Gmail-Postfach laden.

  • Wenn Sie die getTokenStatusAsync -Methode im Verfassenmodus aufrufen, müssen Sie das Element gespeichert haben. Die saveAsync -Methode erfordert eine Mindestberechtigungsstufe für Lese-/Schreibzugriff.

getTokenStatusAsync(callback)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft die status von EWS-Rückruftoken in einem organization ab.

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

Parameter

callback

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

Nach Abschluss der Methode wird die im callback Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResult aufgerufen. Die asyncResult.value -Eigenschaft gibt das Token status zurück, das ,Office.MailboxEnums.TokenStatus.Disabled oderOffice.MailboxEnums.TokenStatus.Removed sein Office.MailboxEnums.TokenStatus.Enabledkann. Ein Office.MailboxEnums.TokenStatus.Removed status gibt an, dass das Postfach in einer Exchange Online Umgebung gehostet wird, in der Legacy-Exchange-Token deaktiviert und nicht mehr unterstützt werden.

Gibt zurück

void

Hinweise

[ API-Satz: Postfachvorschau ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose oder Lesen

Wichtig:

  • Die getTokenStatusAsync Methode ist in Outlook im Web und unter Windows (neu und klassisch (Version 2510, Build 19328.20000 und höher)) als Vorschauversion verfügbar.

  • Die getTokenStatusAsync Methode wird nicht unterstützt, wenn Sie ein Add-In in ein Outlook.com- oder Gmail-Postfach laden.

  • Wenn Sie die getTokenStatusAsync -Methode im Verfassenmodus aufrufen, müssen Sie das Element gespeichert haben. Die saveAsync -Methode erfordert eine Mindestberechtigungsstufe für Lese-/Schreibzugriff.