Office.Diagnostics interface

  • Referência
Pacote:
outlook

Fornece informações de diagnóstico para um suplemento do Outlook.

Comentários

[ Conjunto de API: Caixa de Correio 1.1 ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Compose ou Leitura

A partir do conjunto de requisitos da Caixa de Correio 1.5, também pode utilizar a propriedade Office.context.diagnóstico para obter informações semelhantes.

Exemplos

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

Propriedades

hostName

Obtém uma cadeia que representa o tipo de cliente do Outlook.

A cadeia pode ser um dos seguintes valores: Outlook, , newOutlookWindowsOutlookWebApp, ou OutlookIOSOutlookAndroid.
hostVersion

Obtém uma cadeia que representa a versão do cliente outlook ou do Exchange Server (por exemplo, "15.0.468.0").

Se o suplemento de correio estiver a ser executado no Outlook no Windows (clássico), no Mac ou em dispositivos móveis, a hostVersion propriedade devolve a versão do cliente Outlook. No Outlook na Web e no novo Outlook no Windows, a propriedade devolve a versão do Exchange Server.
OWAView

Obtém uma cadeia que representa a vista atual de Outlook na Web.

A cadeia devolvida pode ser um dos seguintes valores: OneColumn, TwoColumnsou ThreeColumns.

Se a aplicação não estiver Outlook na Web, aceder a esta propriedade resultará em indefinido.

Outlook na Web tem três vistas que correspondem à largura do ecrã e da janela e o número de colunas que podem ser apresentadas:

  • OneColumn , que é apresentado quando o ecrã é estreito. Outlook na Web utiliza este esquema de coluna única em todo o ecrã de um smartphone.

  • TwoColumns , que é apresentado quando o ecrã é mais largo. Outlook na Web utiliza esta vista na maioria dos tablets.

  • ThreeColumns , que é apresentado quando o ecrã é largo. Por exemplo, Outlook na Web utiliza esta vista numa janela de ecrã inteiro num computador de secretária.

Detalhes da propriedade

hostName

Obtém uma cadeia que representa o tipo de cliente do Outlook.

A cadeia pode ser um dos seguintes valores: Outlook, , newOutlookWindowsOutlookWebApp, ou OutlookIOSOutlookAndroid.

hostName: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: Caixa de Correio 1.1 ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Compose ou Leitura

Importante: o Outlook valor é devolvido para o Outlook no Windows (clássico) e no Mac. newOutlookWindows é devolvido para o novo Outlook no Windows.

hostVersion

Obtém uma cadeia que representa a versão do cliente outlook ou do Exchange Server (por exemplo, "15.0.468.0").

Se o suplemento de correio estiver a ser executado no Outlook no Windows (clássico), no Mac ou em dispositivos móveis, a hostVersion propriedade devolve a versão do cliente Outlook. No Outlook na Web e no novo Outlook no Windows, a propriedade devolve a versão do Exchange Server.

hostVersion: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: Caixa de Correio 1.1 ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Compose ou Leitura

OWAView

Obtém uma cadeia que representa a vista atual de Outlook na Web.

A cadeia devolvida pode ser um dos seguintes valores: OneColumn, TwoColumnsou ThreeColumns.

Se a aplicação não estiver Outlook na Web, aceder a esta propriedade resultará em indefinido.

Outlook na Web tem três vistas que correspondem à largura do ecrã e da janela e o número de colunas que podem ser apresentadas:

  • OneColumn , que é apresentado quando o ecrã é estreito. Outlook na Web utiliza este esquema de coluna única em todo o ecrã de um smartphone.

  • TwoColumns , que é apresentado quando o ecrã é mais largo. Outlook na Web utiliza esta vista na maioria dos tablets.

  • ThreeColumns , que é apresentado quando o ecrã é largo. Por exemplo, Outlook na Web utiliza esta vista numa janela de ecrã inteiro num computador de secretária.

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

Valor da propriedade

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

Comentários

[ Conjunto de API: Caixa de Correio 1.1 ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Compose ou Leitura