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

if (Office.context.requirements.isSetSupported("Mailbox", "1.16")) {
  const ewsTokenStatus = diagnostics.ews;
  ewsTokenStatus.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 token status: EWS callback tokens are enabled.");
        break;
      case Office.MailboxEnums.TokenStatus.Disabled:
        console.log("EWS token status: EWS callback tokens are disabled.");
        break;
      case Office.MailboxEnums.TokenStatus.Removed:
        console.log("EWS token status: The organization has an Exchange Online environment. Legacy Exchange tokens are no longer supported.");
        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

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

ews: Ews;

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

Office.Ews

Комментарии

Набор API: почтовый ящик 1.16

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

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

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

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/89-other-mailbox-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 или чтение