Office.Diagnostics interface

  • Référence
Paquet:
outlook

Fournit des informations de diagnostic à un complément Outlook.

Remarques

[ Ensemble d’API : Boîte aux lettres 1.1 ]

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

Mode Outlook applicable : Rédiger ou Lire

À compter de l’ensemble de conditions requises pour la boîte aux lettres 1.5, vous pouvez également utiliser la propriété Office.context.diagnostics pour obtenir des informations similaires.

Exemples

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

Propriétés

hostName

Obtient une chaîne qui représente le type de client Outlook.

La chaîne peut être l’une des valeurs suivantes : Outlook,newOutlookWindows , OutlookWebApp, OutlookIOSou .OutlookAndroid
hostVersion

Obtient une chaîne qui représente la version du client Outlook ou du Exchange Server (par exemple, « 15.0.468.0 »).

Si le complément de messagerie s’exécute dans Outlook sur un client de bureau ou mobile, la hostVersion propriété renvoie la version du client Outlook. Dans Outlook sur le web, la propriété retourne la version du Exchange Server.
OWAView

Obtient une chaîne qui représente l’affichage actuel de Outlook sur le web.

La chaîne retournée peut être l’une des valeurs suivantes : OneColumn, TwoColumnsou ThreeColumns.

Si l’application n’est pas Outlook sur le web, l’accès à cette propriété n’est pas défini.

Outlook sur le web a trois vues qui correspondent à la largeur de l’écran et de la fenêtre, ainsi qu’au nombre de colonnes qui peuvent être affichées :

  • OneColumn, qui s’affiche lorsque l’écran est étroit. Outlook sur le web utilise cette disposition en une seule colonne sur tout l’écran d’un smartphone.

  • TwoColumns, qui s’affiche lorsque l’écran est plus large. Outlook sur le web utilise cette vue sur la plupart des tablettes.

  • ThreeColumns, qui s’affiche lorsque l’écran est large. Par exemple, Outlook sur le web utilise cette vue dans une fenêtre plein écran sur un ordinateur de bureau.

Détails de la propriété

hostName

Obtient une chaîne qui représente le type de client Outlook.

La chaîne peut être l’une des valeurs suivantes : Outlook,newOutlookWindows , OutlookWebApp, OutlookIOSou .OutlookAndroid

hostName: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : Boîte aux lettres 1.1 ]

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

Mode Outlook applicable : Rédiger ou Lire

Important : la Outlook valeur est retournée pour les clients de bureau Outlook sur Windows et sur Mac. newOutlookWindows est retourné pour le nouveau client de bureau Outlook sur Windows actuellement en préversion.

hostVersion

Obtient une chaîne qui représente la version du client Outlook ou du Exchange Server (par exemple, « 15.0.468.0 »).

Si le complément de messagerie s’exécute dans Outlook sur un client de bureau ou mobile, la hostVersion propriété renvoie la version du client Outlook. Dans Outlook sur le web, la propriété retourne la version du Exchange Server.

hostVersion: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : Boîte aux lettres 1.1 ]

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

Mode Outlook applicable : Rédiger ou Lire

OWAView

Obtient une chaîne qui représente l’affichage actuel de Outlook sur le web.

La chaîne retournée peut être l’une des valeurs suivantes : OneColumn, TwoColumnsou ThreeColumns.

Si l’application n’est pas Outlook sur le web, l’accès à cette propriété n’est pas défini.

Outlook sur le web a trois vues qui correspondent à la largeur de l’écran et de la fenêtre, ainsi qu’au nombre de colonnes qui peuvent être affichées :

  • OneColumn, qui s’affiche lorsque l’écran est étroit. Outlook sur le web utilise cette disposition en une seule colonne sur tout l’écran d’un smartphone.

  • TwoColumns, qui s’affiche lorsque l’écran est plus large. Outlook sur le web utilise cette vue sur la plupart des tablettes.

  • ThreeColumns, qui s’affiche lorsque l’écran est large. Par exemple, Outlook sur le web utilise cette vue dans une fenêtre plein écran sur un ordinateur de bureau.

OWAView: MailboxEnums.OWAView | "OneColumn" | "TwoColumns" | "ThreeColumns";

Valeur de propriété

Office.MailboxEnums.OWAView | "OneColumn" | "TwoColumns" | "ThreeColumns"

Remarques

[ Ensemble d’API : Boîte aux lettres 1.1 ]

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

Mode Outlook applicable : Rédiger ou Lire