Office.Diagnostics interface

  • Referencia
Paquete:
outlook

Proporciona información de diagnóstico a un complemento de Outlook.

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción o lectura

A partir del conjunto de requisitos de buzón 1.5, también puede usar la propiedad Office.context.diagnostics para obtener información similar.

Ejemplos

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

Propiedades

hostName

Obtiene una cadena que representa el tipo de cliente de Outlook.

La cadena puede ser uno de los siguientes valores: Outlook, newOutlookWindows, OutlookWebApp, OutlookIOSo OutlookAndroid.
hostVersion

Obtiene una cadena que representa la versión del cliente de Outlook o de la Exchange Server (por ejemplo, "15.0.468.0").

Si el complemento de correo se ejecuta en Outlook en un cliente de escritorio o móvil, la hostVersion propiedad devuelve la versión del cliente de Outlook. En Outlook en la Web, la propiedad devuelve la versión del Exchange Server.
OWAView

Obtiene una cadena que representa la vista actual de Outlook en la Web.

La cadena devuelta puede ser uno de los siguientes valores: OneColumn, TwoColumnso ThreeColumns.

Si la aplicación no está Outlook en la Web, el acceso a esta propiedad da como resultado undefined.

Outlook en la Web tiene tres vistas que se corresponden con el ancho de la pantalla y la ventana, y el número de columnas que se pueden mostrar:

  • OneColumn, que se muestra cuando la pantalla es estrecha. Outlook en la Web usa este diseño de una sola columna en toda la pantalla de un smartphone.

  • TwoColumns, que se muestra cuando la pantalla es más ancha. Outlook en la Web usa esta vista en la mayoría de los comprimidos.

  • ThreeColumns, que se muestra cuando la pantalla es ancha. Por ejemplo, Outlook en la Web usa esta vista en una ventana de pantalla completa en un equipo de escritorio.

Detalles de las propiedades

hostName

Obtiene una cadena que representa el tipo de cliente de Outlook.

La cadena puede ser uno de los siguientes valores: Outlook, newOutlookWindows, OutlookWebApp, OutlookIOSo OutlookAndroid.

hostName: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción o lectura

Importante: El Outlook valor se devuelve para los clientes de escritorio de Outlook en Windows y en Mac. newOutlookWindows se devuelve para el nuevo cliente de escritorio de Outlook en Windows actualmente en versión preliminar.

hostVersion

Obtiene una cadena que representa la versión del cliente de Outlook o de la Exchange Server (por ejemplo, "15.0.468.0").

Si el complemento de correo se ejecuta en Outlook en un cliente de escritorio o móvil, la hostVersion propiedad devuelve la versión del cliente de Outlook. En Outlook en la Web, la propiedad devuelve la versión del Exchange Server.

hostVersion: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción o lectura

OWAView

Obtiene una cadena que representa la vista actual de Outlook en la Web.

La cadena devuelta puede ser uno de los siguientes valores: OneColumn, TwoColumnso ThreeColumns.

Si la aplicación no está Outlook en la Web, el acceso a esta propiedad da como resultado undefined.

Outlook en la Web tiene tres vistas que se corresponden con el ancho de la pantalla y la ventana, y el número de columnas que se pueden mostrar:

  • OneColumn, que se muestra cuando la pantalla es estrecha. Outlook en la Web usa este diseño de una sola columna en toda la pantalla de un smartphone.

  • TwoColumns, que se muestra cuando la pantalla es más ancha. Outlook en la Web usa esta vista en la mayoría de los comprimidos.

  • ThreeColumns, que se muestra cuando la pantalla es ancha. Por ejemplo, Outlook en la Web usa esta vista en una ventana de pantalla completa en un equipo de escritorio.

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

Valor de propiedad

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

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción o lectura