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: item de leitura

Modo outlook aplicável: compor ou ler

Começando com o conjunto de requisitos da caixa de correio 1.5, você também pode usar 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 de caracteres que representa o tipo de cliente do Outlook.

A cadeia de caracteres pode ser um dos seguintes valores: Outlook,newOutlookWindows , , OutlookWebApp, OutlookIOSou .OutlookAndroid
hostVersion

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

Se o suplemento de email estiver em execução no Outlook em um cliente de área de trabalho ou móvel, a hostVersion propriedade retornará a versão do cliente do Outlook. Em Outlook na Web, a propriedade retorna a versão do Exchange Server.
OWAView

Obtém uma cadeia de caracteres que representa a exibição atual de Outlook na Web.

A cadeia de caracteres retornada pode ser um dos seguintes valores: OneColumn, TwoColumnsou ThreeColumns.

Se o aplicativo não estiver Outlook na Web, o acesso a essa propriedade resultará em indefinido.

Outlook na Web tem três exibições que correspondem à largura da tela e da janela e ao número de colunas que podem ser exibidas:

  • OneColumn, que é exibido quando a tela é estreita. Outlook na Web usa esse layout de coluna única em toda a tela de um smartphone.

  • TwoColumns, que é exibido quando a tela é mais ampla. Outlook na Web usa essa exibição na maioria dos tablets.

  • ThreeColumns, que é exibido quando a tela é ampla. Por exemplo, Outlook na Web usa essa exibição em uma janela de tela inteira em um computador de área de trabalho.

Detalhes da propriedade

hostName

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

A cadeia de caracteres pode ser um dos seguintes valores: Outlook,newOutlookWindows , , OutlookWebApp, OutlookIOSou .OutlookAndroid

hostName: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

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

Modo outlook aplicável: compor ou ler

Importante: o Outlook valor é retornado para clientes da área de trabalho do Outlook no Windows e no Mac. newOutlookWindows é retornado para o novo cliente do Outlook na área de trabalho do Windows atualmente em versão prévia.

hostVersion

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

Se o suplemento de email estiver em execução no Outlook em um cliente de área de trabalho ou móvel, a hostVersion propriedade retornará a versão do cliente do Outlook. Em Outlook na Web, a propriedade retorna 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: item de leitura

Modo outlook aplicável: compor ou ler

OWAView

Obtém uma cadeia de caracteres que representa a exibição atual de Outlook na Web.

A cadeia de caracteres retornada pode ser um dos seguintes valores: OneColumn, TwoColumnsou ThreeColumns.

Se o aplicativo não estiver Outlook na Web, o acesso a essa propriedade resultará em indefinido.

Outlook na Web tem três exibições que correspondem à largura da tela e da janela e ao número de colunas que podem ser exibidas:

  • OneColumn, que é exibido quando a tela é estreita. Outlook na Web usa esse layout de coluna única em toda a tela de um smartphone.

  • TwoColumns, que é exibido quando a tela é mais ampla. Outlook na Web usa essa exibição na maioria dos tablets.

  • ThreeColumns, que é exibido quando a tela é ampla. Por exemplo, Outlook na Web usa essa exibição em uma janela de tela inteira em um computador de área de trabalho.

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: item de leitura

Modo outlook aplicável: compor ou ler