Office.Diagnostics interface

  • Referenz
Paket:
outlook

Stellt einem Outlook-Add-In Diagnoseinformationen bereit.

Hinweise

[ API-Satz: Postfach 1.1 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen 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

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
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 auf einem Desktop- oder mobilen Client ausgeführt wird, gibt die hostVersion Eigenschaft die Version des Outlook-Clients zurück. In Outlook im Web gibt die -Eigenschaft die Version des Exchange Server zurück.
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.

Details zur Eigenschaft

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

[ API-Satz: Postfach 1.1 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen oder Lesen

Wichtig: Der Outlook Wert wird für Outlook-Desktopclients unter Windows und macos zurückgegeben. newOutlookWindows wird für den neuen Outlook auf Windows-Desktopclient zurückgegeben, der sich derzeit in der Vorschau befindet.

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 auf einem Desktop- oder mobilen Client ausgeführt wird, gibt die hostVersion Eigenschaft die Version des Outlook-Clients zurück. In Outlook im Web gibt die -Eigenschaft die Version des Exchange Server zurück.

hostVersion: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: Postfach 1.1 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen 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

[ API-Satz: Postfach 1.1 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen oder Lesen