Наборы обязательных элементов API JavaScript для OutlookOutlook JavaScript API requirement sets

Для надстроек Outlook требуются определенные версии API, которые указываются в элементе Requirements в их манифесте. Надстройки Outlook всегда включают элемент Set с атрибутом , для которого задано значение , и атрибутом , для которого установлен минимальный набор требований API, поддерживающий сценарии надстройки.Outlook add-ins declare what API versions they require by using the Requirements element in their manifest. Outlook add-ins always include a Set element with a Name attribute set to Mailbox and a MinVersion attribute set to the minimum API requirement set that supports the add-in's scenarios.

Например, в следующем фрагменте манифеста указан минимальный набор обязательных элементов 1.1.For example, the following manifest snippet indicates a minimum requirement set of 1.1:

<Requirements>
  <Sets>
    <Set Name="Mailbox" MinVersion="1.1" />
  </Sets>
</Requirements>

Все API-интерфейсы Outlook приведены в Mailboxнаборе требований. У набора требований Mailbox есть версии, а каждый новый выпускаемый набор API-интерфейсов приведен в наборе более поздней версии. Не все клиенты Outlook поддерживают новейший набор API-интерфейсов, но если для клиента Outlook объявлена поддержка набора требований, то он будет поддерживать все API-интерфейсы в этом наборе.All Outlook APIs belong to the Mailbox requirement set. The Mailbox requirement set has versions, and each new set of APIs that we release belongs to a higher version of the set. Not all Outlook clients support the newest set of APIs, but if an Outlook client declares support for a requirement set, it supports all of the APIs in that requirement set.

Задайте версию минимального набора требований в манифесте, чтобы указать клиент Outlook, в котором появится надстройка. Если клиент не поддерживает минимальный набор требований, он не загружает надстройку. Например, если указана версия набора требований 1.3, надстройка не отобразится в каком-либо клиенте Outlook, который не поддерживает версии 1.3. и нижеSetting a minimum requirement set version in the manifest controls which Outlook client the add-in will appear in. If a client does not support the minimum requirement set, it does not load the add-in. For example, if requirement set version 1.3 is specified, this means the add-in will not show up in any Outlook client that doesn't support at least 1.3.

Примечание

Чтобы использовать API в любом из нумерованных наборов обязательных элементов, следует ссылаться на рабочую библиотеку в сети CDN (https://appsforoffice.microsoft.com/lib/1/hosted/office.js).To use APIs in any of the numbered requirement sets, you should reference the production library on the CDN: https://appsforoffice.microsoft.com/lib/1/hosted/office.js).

Сведения об использовании API предварительных версий см. в разделе Использование предварительных версий API далее в этой статье.For information about using preview APIs, see the Excel JavaScript preview APIs section within this article.

Использование API из наборов обязательных элементов более поздних версийUsing APIs from later requirement sets

Установка набора обязательных элементов не ограничивает доступные API, которые может использовать надстройка.Setting a requirement set does not limit the available APIs that the add-in can use. Например, если для надстройки указан набор обязательных элементов "Mailbox 1.1", но она выполняется в клиенте Outlook, который поддерживает набор "Mailbox 1.3", надстройка может использовать API из набора обязательных элементов "Mailbox 1.3".For example, if the add-in specifies requirement set 1.1, but it is running in an Outlook client which support 1.3, the add-in can use APIs from requirement set 1.3.

Чтобы использовать более новые API, разработчики могут проверить, поддерживает ли ведущее приложение набор обязательных элементов, выполнив следующее.To use a newer API, developers can check if a particular host supports the requirement set by doing the following.

if (Office.context.requirements.isSetSupported('Mailbox', '1.3')) {
  // Perform actions.
}
else {
  // Provide alternate flow/logic.
}

Кроме того, разработчики могут проверить наличие более новых API с помощью стандартных методов JavaScript.Alternatively, developers can check for the existence of a newer API by using standard JavaScript technique.

if (item.somePropertyOrFunction !== undefined) {
  // Use item.somePropertyOrFunction.
  item.somePropertyOrFunction;
}

Такие проверки не нужно выполнять для API-интерфейсов, присутствующих в версии набора обязательных элементов, указанной в манифесте.No such checks are necessary for any APIs which are present in the requirement set version specified in in the manifest.

Выбор минимального набора обязательных элементовChoosing a minimum requirement set

Разработчикам следует использовать набор обязательных элементов самой ранней версии, содержащий набор критически важных API для сценария их работы, без которого надстройка не будет работать.Developers should use the earliest requirement set that contains the critical set of APIs for their scenario, without which the add-in won't work.

КлиентыClients

Указанные ниже клиенты поддерживают надстройки Outlook.The following clients support Outlook add-ins.

КлиентClient Поддерживаемые наборы обязательных элементов APISupported API requirement sets
Outlook для Windows (версия, подключенная к подписке на Office 365)Outlook on Windows (connected to Office 365) 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.71.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7
Outlook 2019 для Windows (единовременная покупка)Outlook 2019 on Windows (one-time purchase) 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.71.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7
Outlook 2016 для Windows (единовременная покупка)Outlook 2016 on Windows (one-time purchase) 1.1, 1.2, 1.3, 1.41.1, 1.2, 1.3, 1.4
Outlook 2013 для Windows (единовременная покупка)Outlook 2013 on Windows (one-time purchase) 1.1, 1.2, 1.3, 1.41.1, 1.2, 1.3, 1.4
Outlook для Mac (версия, подключенная к подписке на Office 365)Outlook on Mac (connected to Office 365 subscription) 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.71.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7
Outlook 2019 для Mac (единовременная покупка)Outlook 2019 for Mac (one-time purchase) 1.1, 1.2, 1.3, 1.4, 1.5, 1.61.1, 1.2, 1.3, 1.4, 1.5, 1.6
Outlook 2016 для Mac (единовременная покупка)Outlook 2016 for Mac (one-time purchase) 1.1, 1.2, 1.3, 1.4, 1.5, 1.61.1, 1.2, 1.3, 1.4, 1.5, 1.6
Outlook для iOSRe-access Outlook on the iOS device. 1.1, 1.2, 1.3, 1.4, 1.51.1, 1.2, 1.3, 1.4, 1.5
Outlook для AndroidOpen Outlook on the Android device. 1.1, 1.2, 1.3, 1.4, 1.51.1, 1.2, 1.3, 1.4, 1.5
Outlook в Интернете (современная версия)Outlook on the web 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.71.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7
Outlook в Интернете (классическая версия)Outlook on the web (Classic) 1.1, 1.2, 1.3, 1.4, 1.5, 1.61.1, 1.2, 1.3, 1.4, 1.5, 1.6
Любой клиент Outlook, подключенный к локальному серверу Exchange 2019Any Outlook client connected to Exchange 2019 on-premises 1.1, 1.2, 1.3, 1.4, 1.51.1, 1.2, 1.3, 1.4, 1.5
Любой клиент Outlook, подключенный к локальному серверу Exchange 2016Any Outlook client connected to Exchange 2016 on-premises 1.1, 1.2, 1.31.1, 1.2, 1.3
Любой клиент Outlook, подключенный к локальному серверу Exchange 2013Any Outlook client connected to Exchange 2013 on-premises 1.11.1

Примечание

Поддержка версии 1.3 в Outlook 2013 добавлена в рамках обновления для Outlook 2013 (KB3114349) от 8 декабря 2015 г.Support for 1.3 in Outlook 2013 was added as part of the December 8, 2015, update for Outlook 2013 (KB3114349). Поддержка версии 1.4 в Outlook 2013 добавлена в рамках обновления для Outlook 2013 (KB3118280) от 13 сентября 2016 г.Support for 1.4 in Outlook 2013 was added as part of the September 13, 2016, update for Outlook 2013 (KB3118280). Поддержка версии 1.4 в Outlook 2016 (MSI) добавлена в рамках обновления для Office 2016 (KB4022223) от 3 июля 2018 г..Support for 1.4 in Outlook 2016 (MSI) was added as part of the July 3, 2018, update for Office 2016 (KB4022223).

Совет

Классическую и современную версии Outlook в веб-браузере можно различить по внешнему виду панели инструментов почтового ящика.You can distinguish between classic and modern Outlook in a web browser by checking your mailbox toolbar.

современная версияModern

снимок части экрана с изображением панели инструментов современной версии Outlook

классическая версияclassic

снимок части экрана с изображением панели инструментов классической версии Outlook

Использование предварительных версий APIUsing preview APIs

Новые API JavaScript для Outlook сначала выпускаются в "предварительной версии", а затем становятся частью определенного нумерованного набора обязательных элементов после выполнения достаточного тестирования и получения отзывов пользователей.New Outlook JavaScript APIs are first introduced in "preview" and later become part of a specific, numbered requirement set after sufficient testing occurs and user feedback is acquired. Чтобы отправить отзыв о предварительной версии API, используйте способ обратной связи, представленный в конце веб-страницы с описанием API.To provide feedback about a preview API, please use the feedback mechanism at the end of the web page where the API is documented.

Примечание

API предварительной версии могут быть изменены и не предназначены для использования в рабочей среде.Preview APIs are subject to change and are not intended for use in a production environment.

Дополнительные сведения о предварительных версиях интерфейсов API см. в статье Предварительная версия набора обязательных элементов API для Outlook.For more details about the preview APIs, see Outlook API Preview requirement set.