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 zu erhalten.
Verwendet von
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;
}
if (Office.context.requirements.isSetSupported("Mailbox", "1.16")) {
const ewsTokenStatus = diagnostics.ews;
ewsTokenStatus.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 token status: EWS callback tokens are enabled.");
break;
case Office.MailboxEnums.TokenStatus.Disabled:
console.log("EWS token status: EWS callback tokens are disabled.");
break;
case Office.MailboxEnums.TokenStatus.Removed:
console.log("EWS token status: The organization has an Exchange Online environment. Legacy Exchange tokens are no longer supported.");
break;
}
});
}
Eigenschaften
| host |
Ruft eine Zeichenfolge ab, die den Typ des Outlook-Clients darstellt. Die Zeichenfolge kann einer der folgenden Werte sein: |
| host |
Ruft eine Zeichenfolge ab, die die Version des Outlook-Clients oder des Exchange Server angibt (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 einer der folgenden Werte sein: Wenn es sich bei der Anwendung nicht um Outlook im Web handelt, führt der Zugriff auf diese Eigenschaft dazu, dass sie nicht definiert ist. Outlook im Web verfügt über drei Ansichten, die der Breite des Bildschirms und des Fensters sowie der Anzahl der anzuzeigenden Spalten entsprechen:
|
Details zur Eigenschaft
hostName
Ruft eine Zeichenfolge ab, die den Typ des Outlook-Clients darstellt.
Die Zeichenfolge kann einer der folgenden Werte sein: 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 das neue Outlook unter Windows zurückgegeben.
hostVersion
Ruft eine Zeichenfolge ab, die die Version des Outlook-Clients oder des Exchange Server angibt (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 im 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 einer der folgenden Werte sein: OneColumn, TwoColumns, oder ThreeColumns.
Wenn es sich bei der Anwendung nicht um Outlook im Web handelt, führt der Zugriff auf diese Eigenschaft dazu, dass sie nicht definiert ist.
Outlook im Web verfügt über drei Ansichten, die der Breite des Bildschirms und des Fensters sowie der Anzahl der anzuzeigenden Spalten entsprechen:
OneColumn, der angezeigt wird, wenn der Bildschirm schmal ist. Outlook im Web verwendet dieses einspaltige Layout auf dem gesamten Bildschirm eines Smartphones.TwoColumns, die angezeigt wird, wenn der Bildschirm breiter ist. Outlook im Web verwendet diese Ansicht auf den meisten Tablets.ThreeColumns, die 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