Office.Diagnostics interface
Stellt einem Outlook-Add-In Diagnoseinformationen bereit.
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Compose oder Lesen
Ab Postfachanforderungssatz 1.5 können Sie auch die Office.context.Diagnose-Eigenschaft verwenden, um ähnliche Informationen abzurufen.
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-diagnostic-information.yaml
// This function gets a mailbox's diagnostic information, such as Outlook client and version, and logs it to the console.
const diagnostics = Office.context.mailbox.diagnostics;
console.log(`Client application: ${diagnostics.hostName}`);
console.log(`Client version: ${diagnostics.hostVersion}`);
switch (diagnostics.OWAView) {
case undefined:
console.log("Current view (Outlook on the web only): Not applicable. An Outlook desktop client is in use.");
break;
case Office.MailboxEnums.OWAView.OneColumnNarrow:
console.log("Current view (Outlook on the web only): Viewed from an older generation mobile phone");
break;
case Office.MailboxEnums.OWAView.OneColumn:
console.log("Current view (Outlook on the web only): Viewed from a newer generation mobile phone");
break;
case Office.MailboxEnums.OWAView.TwoColumns:
console.log("Current view (Outlook on the web only): Viewed from a tablet");
break;
case Office.MailboxEnums.OWAView.ThreeColumns:
console.log("Current view (Outlook on the web only): Viewed from a desktop computer");
break;
}
Eigenschaften
| ews | Ruft ein -Objekt ab, um zu identifizieren, ob EWS-Rückruftoken (Exchange Web Services) in einem organization unterstützt werden. |
| host |
Ruft eine Zeichenfolge ab, die den Typ des Outlook-Clients darstellt. Die Zeichenfolge kann einen der folgenden Werte aufweisen: |
| host |
Ruft eine Zeichenfolge ab, die die Version des Outlook-Clients oder des Exchange Server darstellt (z. B. "15.0.468.0"). Wenn das Mail-Add-In in Outlook unter Windows (klassisch), auf Mac oder auf mobilen Geräten ausgeführt wird, gibt die |
| OWAView | Ruft eine Zeichenfolge ab, die die aktuelle Ansicht von Outlook im Web darstellt. Die zurückgegebene Zeichenfolge kann einen der folgenden Werte aufweisen: Wenn die Anwendung nicht Outlook im Web ist, führt der Zugriff auf diese Eigenschaft zu undefiniert. Outlook im Web verfügt über drei Ansichten, die der Breite des Bildschirms und des Fensters sowie der Anzahl der Spalten entsprechen, die angezeigt werden können:
|
Details zur Eigenschaft
ews
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 ein -Objekt ab, um zu identifizieren, ob EWS-Rückruftoken (Exchange Web Services) in einem organization unterstützt werden.
ews: Ews;Eigenschaftswert
Hinweise
[ API-Satz: Postfachvorschau ]
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Compose oder Lesen
Wichtig:
Die
ewsEigenschaft steht in Outlook im Web und unter Windows (neu und klassisch (Version 2510, Build 19328.20000 und höher)) als Vorschauversion zur Verfügung.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;
}
});
hostName
Ruft eine Zeichenfolge ab, die den Typ des Outlook-Clients darstellt.
Die Zeichenfolge kann einen der folgenden Werte aufweisen: Outlook,newOutlookWindows , OutlookWebApp, OutlookIOSoder .OutlookAndroid
hostName: string;Eigenschaftswert
string
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Compose oder Lesen
Wichtig: Der Outlook Wert wird für Outlook unter Windows (klassisch) und für Mac zurückgegeben.
newOutlookWindows wird für neues Outlook unter Windows zurückgegeben.
hostVersion
Ruft eine Zeichenfolge ab, die die Version des Outlook-Clients oder des Exchange Server darstellt (z. B. "15.0.468.0").
Wenn das Mail-Add-In in Outlook unter Windows (klassisch), auf Mac oder auf mobilen Geräten ausgeführt wird, gibt die hostVersion Eigenschaft die Version des Outlook-Clients zurück. In Outlook im Web und neuen Outlook unter Windows gibt die Eigenschaft die Version des Exchange Server zurück.
hostVersion: string;Eigenschaftswert
string
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Compose oder Lesen
OWAView
Ruft eine Zeichenfolge ab, die die aktuelle Ansicht von Outlook im Web darstellt.
Die zurückgegebene Zeichenfolge kann einen der folgenden Werte aufweisen: OneColumn, TwoColumnsoder ThreeColumns.
Wenn die Anwendung nicht Outlook im Web ist, führt der Zugriff auf diese Eigenschaft zu undefiniert.
Outlook im Web verfügt über drei Ansichten, die der Breite des Bildschirms und des Fensters sowie der Anzahl der Spalten entsprechen, die angezeigt werden können:
OneColumn, das angezeigt wird, wenn der Bildschirm schmal ist. Outlook im Web verwendet dieses einspaltige Layout auf dem gesamten Bildschirm eines Smartphones.TwoColumns, das angezeigt wird, wenn der Bildschirm breiter ist. Outlook im Web verwendet diese Ansicht auf den meisten Tablets.ThreeColumns, das angezeigt wird, wenn der Bildschirm breit ist. Beispielsweise verwendet Outlook im Web diese Ansicht in einem Vollbildfenster auf einem Desktopcomputer.
OWAView: MailboxEnums.OWAView | "OneColumn" | "TwoColumns" | "ThreeColumns";Eigenschaftswert
Office.MailboxEnums.OWAView | "OneColumn" | "TwoColumns" | "ThreeColumns"
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Compose oder Lesen