Поделиться через

Office.Diagnostics interface

Пакет:
outlook

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

Комментарии

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

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

Применимый режим Outlook: Compose или чтение

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

Примеры

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

Свойства

ews

Возвращает объект для определения того, поддерживаются ли маркеры обратного вызова веб-служб Exchange (EWS) в организации.
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 в Интернете использует это представление в полноэкранном окне на настольном компьютере.

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

ews

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Возвращает объект для определения того, поддерживаются ли маркеры обратного вызова веб-служб Exchange (EWS) в организации.

ews: Ews;

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

Office.Ews

Комментарии

[ Набор API: предварительная версия почтового ящика ]

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

Применимый режим Outlook: Compose или чтение

Важно!

  • Свойство ews доступно для предварительной версии в Outlook в Интернете и в Windows (новая и классическая (версия 2510, сборка 19328.20000 и более поздние версии)).

  • Устаревшие Exchange Online маркеры удостоверений пользователей и маркеры обратного вызова больше не поддерживаются и отключены во всех клиентах Microsoft 365. Если надстройке Outlook требуется делегированный доступ или удостоверение пользователя, рекомендуется использовать MSAL (библиотека проверки подлинности Майкрософт) и вложенную проверку подлинности приложения (NAA). Маркеры удостоверений пользователей Exchange по-прежнему поддерживаются для локальной среды Exchange. Дополнительные сведения см. в разделе Часто задаваемые вопросы о проверке подлинности вложенных приложений.

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/get-token-status.yaml

Office.context.mailbox.diagnostics.ews.getTokenStatusAsync({ isRest: false }, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(result.error.message);
    return;
  }
  const status = result.value;
  switch (status) {
    case Office.MailboxEnums.TokenStatus.Enabled:
      console.log("EWS callback tokens are enabled.");
      break;
    case Office.MailboxEnums.TokenStatus.Disabled:
      console.log("EWS callback tokens are disabled.");
      break;
    case Office.MailboxEnums.TokenStatus.Removed:
      console.log(
        "The organization has an Exchange Online environment. Legacy Exchange tokens are no longer supported.",
      );
      break;
  }
});

hostName

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

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

hostName: string;

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

string

Комментарии

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

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

Применимый режим Outlook: Compose или чтение

Важно! Возвращается 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: Compose или чтение

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: Compose или чтение