Office.Diagnostics interface

  • Ссылка
Пакет:
outlook

Предоставляет надстройке Outlook диагностические сведения.

Комментарии

[ Набор API: Почтовый ящик 1.1 ]

Минимальный уровень разрешений: чтение элемента

Применимый режим Outlook: создание или чтение

Начиная с набора обязательных для почтового ящика 1.5, вы также можете использовать свойство Office.context.diagnostics для получения аналогичных сведений.

Примеры

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

Свойства

hostName

Возвращает строку, представляющую тип клиента Outlook.

Строка может иметь одно из следующих значений: Outlook,newOutlookWindows , OutlookWebApp, OutlookIOSили .OutlookAndroid
hostVersion

Возвращает строку, представляющую версию клиента Outlook или Exchange Server (например, "15.0.468.0").

Если почтовая надстройка работает в Outlook в Windows (классической), на Mac или на мобильных устройствах, hostVersion свойство возвращает версию клиента Outlook. В Outlook в Интернете и новом Outlook в Windows свойство возвращает версию Exchange Server.
OWAView

Возвращает строку, представляющую текущее представление Outlook в Интернете.

Возвращаемая строка может иметь одно из следующих значений: OneColumn, TwoColumnsили ThreeColumns.

Если приложение не является Outlook в Интернете, доступ к этому свойству будет неопределенным.

Outlook в Интернете содержит три представления, которые соответствуют ширине экрана и окна, а также количеству отображаемых столбцов:

  • OneColumn , который отображается, когда экран является узким. Outlook в Интернете использует этот макет с одним столбцом на всем экране смартфона.

  • TwoColumns , который отображается, когда экран шире. Outlook в Интернете использует это представление на большинстве планшетов.

  • ThreeColumns , который отображается при ширине экрана. Например, Outlook в Интернете использует это представление в полноэкранном окне на настольном компьютере.

Сведения о свойстве

hostName

Возвращает строку, представляющую тип клиента Outlook.

Строка может иметь одно из следующих значений: Outlook,newOutlookWindows , OutlookWebApp, OutlookIOSили .OutlookAndroid

hostName: string;

Значение свойства

string

Комментарии

[ Набор API: Почтовый ящик 1.1 ]

Минимальный уровень разрешений: чтение элемента

Применимый режим Outlook: создание или чтение

Важно! Возвращается Outlook значение для классических клиентов Outlook в Windows и Mac. newOutlookWindows возвращается для нового классического клиента Outlook для Windows.

hostVersion

Возвращает строку, представляющую версию клиента Outlook или Exchange Server (например, "15.0.468.0").

Если почтовая надстройка работает в Outlook в Windows (классической), на Mac или на мобильных устройствах, hostVersion свойство возвращает версию клиента Outlook. В Outlook в Интернете и новом Outlook в Windows свойство возвращает версию Exchange Server.

hostVersion: string;

Значение свойства

string

Комментарии

[ Набор API: Почтовый ящик 1.1 ]

Минимальный уровень разрешений: чтение элемента

Применимый режим Outlook: создание или чтение

OWAView

Возвращает строку, представляющую текущее представление Outlook в Интернете.

Возвращаемая строка может иметь одно из следующих значений: OneColumn, TwoColumnsили ThreeColumns.

Если приложение не является Outlook в Интернете, доступ к этому свойству будет неопределенным.

Outlook в Интернете содержит три представления, которые соответствуют ширине экрана и окна, а также количеству отображаемых столбцов:

  • OneColumn , который отображается, когда экран является узким. Outlook в Интернете использует этот макет с одним столбцом на всем экране смартфона.

  • TwoColumns , который отображается, когда экран шире. Outlook в Интернете использует это представление на большинстве планшетов.

  • ThreeColumns , который отображается при ширине экрана. Например, Outlook в Интернете использует это представление в полноэкранном окне на настольном компьютере.

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

Значение свойства

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

Комментарии

[ Набор API: Почтовый ящик 1.1 ]

Минимальный уровень разрешений: чтение элемента

Применимый режим Outlook: создание или чтение