context (набор обязательных требований для предварительной версии почтового ящика)

  • Статья

Office.context

Office.context предоставляет общие интерфейсы, которые используются надстройками во всех приложениях Office. В этом списке описаны только те интерфейсы, которые используются надстройками Outlook. Полный список пространства имен Office.context см . в справочнике по Office.context в Common API.

Требования
Требование Значение
Версия минимального набора требований к почтовому ящику 1.1
Применимый режим Outlook Создание или чтение

Свойства

Свойство Режимы Тип возвращаемых данных Minimum
набор обязательных требований
Auth Создание
Чтение		 Auth IdentityAPI 1.3
contentLanguage Создание
Чтение		 String 1.1
диагностика Создание
Чтение		 ContextInformation 1.5
displayLanguage Создание
Чтение		 String 1.1
Узла Создание
Чтение		 HostType 1.5
mailbox Создание
Чтение		 Mailbox 1.1
officeTheme Создание
Чтение		 OfficeTheme Предварительный просмотр
Платформы Создание
Чтение		 PlatformType 1.5
Требования Создание
Чтение		 RequirementSetSupport 1.1
roamingSettings Создание
Чтение		 RoamingSettings 1.1
sensitivityLabelsCatalog Создание SensitivityLabelsCatalog 1.13
ui Создание
Чтение		 UI 1.1
Url Создание
Чтение		 Urls Предварительный просмотр

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

auth: проверка подлинности

Поддерживает единый вход (SSO), предоставляя метод, позволяющий приложению Office получать маркер доступа к веб-приложению надстройки. Косвенно это также дает возможность надстройке получать доступ к данным Microsoft Graph пользователя, вошедшего в систему, не требуя от пользователя еще раз выполнить вход в систему.

Тип
Требования
Требование Значение
Минимальная версия набора требований к почтовому ящику Предварительная версия
Применимый режим Outlook Создание или чтение
Пример
Office.context.auth.getAccessTokenAsync(function(result) {
    if (result.status === "succeeded") {
        const token = result.value;
        // ...
    } else {
        console.log("Error obtaining token", result.error);
    }
});

contentLanguage: String

Возвращает языковой стандарт (язык), заданный пользователем для редактирования элемента.

Значение contentLanguage отражает текущий параметр языка редактирования, указанный в разделе Язык параметров > файла > в клиентском приложении Office.

Тип
  • String
Требования
Требование Значение
Версия минимального набора требований к почтовому ящику 1.1
Применимый режим Outlook Создание или чтение
Пример
function sayHelloWithContentLanguage() {
  const myContentLanguage = Office.context.contentLanguage;
  switch (myContentLanguage) {
    case 'en-US':
      write('Hello!');
      break;
    case 'en-NZ':
      write('G\'day mate!');
      break;
  }
}

// Function that writes to a div with id='message' on the page.
function write(message){
  document.getElementById('message').innerText += message;
}

диагностика: ContextInformation

Возвращает сведения о среде, в которой выполняется надстройка.

Примечание.

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

Тип
Требования
Требование Значение
Минимальная версия набора обязательных элементов для почтового ящика 1.5
Применимый режим Outlook Создание или чтение
Пример
const contextInfo = Office.context.diagnostics;
console.log("Office application: " + contextInfo.host);
console.log("Office version: " + contextInfo.version);
console.log("Platform: " + contextInfo.platform);

displayLanguage: String

Возвращает языковой стандарт (язык) в формате тега языка RFC 1766, заданном пользователем для пользовательского интерфейса клиентского приложения Office.

Значение displayLanguage отражает текущий параметр языка интерфейса, указанный в разделеЯзык параметров>файла> в клиентском приложении Office.

Тип
  • String
Требования
Требование Значение
Версия минимального набора требований к почтовому ящику 1.1
Применимый режим Outlook Создание или чтение
Пример
function sayHelloWithDisplayLanguage() {
  const myDisplayLanguage = Office.context.displayLanguage;
  switch (myDisplayLanguage) {
    case 'en-US':
      write('Hello!');
      break;
    case 'en-NZ':
      write('G\'day mate!');
      break;
  }
}

// Function that writes to a div with id='message' on the page.
function write(message){
  document.getElementById('message').innerText += message;
}

host: HostType

Возвращает приложение Office, в котором размещается надстройка.

Примечание.

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

Тип
Требования
Требование Значение
Минимальная версия набора обязательных элементов для почтового ящика 1.5
Применимый режим Outlook Создание или чтение
Пример
console.log(JSON.stringify(Office.context.host));

officeTheme: OfficeTheme

Предоставляет доступ к свойствам цветов темы Office.

Примечание.

Этот элемент поддерживается только в Outlook для Windows.

С помощью цветов темы Office можно согласовать цветовую схему надстройки с текущей темой Office, выбранной пользователем с помощью пользовательского интерфейса темы Office для учетной записи > Office>, которая применяется во всех клиентских приложениях Office. Using Office theme colors is appropriate for mail and task pane add-ins.

Тип
Свойства
Имя Тип Описание
bodyBackgroundColor String Получает цвет фона текста сообщения для темы Office в виде шестнадцатеричной триады цветов.
bodyForegroundColor String Получает цвет переднего плана текста сообщения для темы Office в виде шестнадцатеричной триады цветов.
controlBackgroundColor String Получает цвет фона элемента управления для темы Office в виде шестнадцатеричной триады цветов.
controlForegroundColor String Получает цвет элемента управления текстом сообщения для темы Office в виде шестнадцатеричной триады цветов.
Требования
Требование Значение
Минимальная версия набора требований к почтовому ящику Предварительная версия
Применимый режим Outlook Создание или чтение
Пример
function applyOfficeTheme(){
  // Get office theme colors.
  const bodyBackgroundColor = Office.context.officeTheme.bodyBackgroundColor;
  const bodyForegroundColor = Office.context.officeTheme.bodyForegroundColor;
  const controlBackgroundColor = Office.context.officeTheme.controlBackgroundColor
  const controlForegroundColor = Office.context.officeTheme.controlForegroundColor;

  // Apply body background color to a CSS class.
  $('.body').css('background-color', bodyBackgroundColor);
}

platform: PlatformType

Предоставляет платформу, на которой выполняется надстройка.

Примечание.

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

Тип
Требования
Требование Значение
Минимальная версия набора обязательных элементов для почтового ящика 1.5
Применимый режим Outlook Создание или чтение
Пример
console.log(JSON.stringify(Office.context.platform));

requirements: RequirementsSetSupport

Предоставляет метод для определения того, какие наборы требований поддерживаются в текущем приложении и платформе.

Тип
Требования
Требование Значение
Версия минимального набора требований к почтовому ящику 1.1
Применимый режим Outlook Создание или чтение
Пример
console.log(JSON.stringify(Office.context.requirements.isSetSupported("mailbox", "1.1")));

roamingSettings: RoamingSettings

Получает объект, представляющий настраиваемые параметры или состояние надстройки почты, сохраненное в почтовом ящике пользователя.

Объект RoamingSettings позволяет хранить и получать доступ к данным для почтовой надстройки, хранящейся в почтовом ящике пользователя, чтобы она была доступна этой надстройке при ее запуске из любого клиента Outlook, используемого для доступа к этому почтовому ящику.

Тип
Требования
Требование Значение
Версия минимального набора требований к почтовому ящику 1.1
Минимальный уровень разрешений Ограничен
Применимый режим Outlook Создание или чтение

sensitivityLabelsCatalog: SensitivityLabelsCatalog

Возвращает объект для проверка состояния каталога меток конфиденциальности в Outlook и получения всех доступных меток конфиденциальности, если каталог включен.

Тип
Требования
Требование Значение
Минимальная версия набора обязательных элементов для почтового ящика 1.13
Минимальный уровень разрешений чтение и запись элемента
Применимый режим Outlook Создание

ui: пользовательский интерфейс

Предоставляет объекты и методы, которые можно использовать для создания компонентов пользовательского интерфейса, таких как диалоговые окна, и управления ими в надстройках Office.

Тип
Требования
Требование Значение
Версия минимального набора требований к почтовому ящику 1.1
Применимый режим Outlook Создание или чтение

urls: URL-адреса

Возвращает объект для получения URL-адресов среды выполнения надстройки.

Тип
Требования
Требование Значение
Минимальная версия набора требований к почтовому ящику Предварительная версия
Применимый режим Outlook Создание или чтение