Примечание.
Для доступа к этой странице требуется авторизация. Вы можете попробовать войти или изменить каталоги.
Для доступа к этой странице требуется авторизация. Вы можете попробовать изменить каталоги.
Подмножество API надстройки Outlook API JavaScript для Office включает объекты, методы, свойства и события, которые можно использовать в надстройке Outlook.
Api предварительной версии могут быть изменены и не предназначены для использования в рабочей среде. Рекомендуется использовать их только в тестовой среде и среде разработки. Не используйте предварительные версии API в рабочей среде или в критически важных для бизнеса документах.
Чтобы использовать API предварительной версии:
Необходимо использовать предварительную версию библиотеки API JavaScript для Office из сети доставки содержимого (CDN)Office.js. Файл определения типа для компиляции TypeScript и IntelliSense находится в сети CDN и имеет тип DefinitelyTyped. Эти типы можно установить с
npm install --save-dev @types/office-js-previewпомощью (не забудьте удалить типы для@types/office-js, если они были установлены ранее).Возможно, вам потребуется присоединиться к программе предварительной оценки Microsoft 365 для доступа к более поздним сборкам Office в Outlook в Windows и на Mac.
Возможно, вам потребуется настроить параметр Целевой выпуск в клиенте Microsoft 365 для предварительного просмотра функций в Outlook в Интернете. Дополнительные сведения см. в разделе "Целевой выпуск" статьи Настройка Standard или Целевой выпуск.
Набор предварительных требований включает все функции набора требований 1.15.
Важно!
Эта документация предназначена для набора обязательных предварительных версий. Этот набор требований еще не реализован полностью, и клиенты не будут точно сообщать о его поддержке. Этот набор требований не следует указывать в манифесте надстройки.
Возможности предварительной версии
Ниже перечислены возможности предварительной версии.
- Добавлены события и объекты для поддержки расшифровки сообщения и его вложений.
- Расширена поддержка свойства для
contentIdполучения идентификатора содержимого встроенного вложения в классической версии Outlook в Windows. - Добавлен метод для проверка, поддерживаются ли в организации маркеры веб-служб Exchange (EWS).
- Обновлены API получателей, чтобы увеличить максимальное число получателей в целевом поле до 1000.
- Увеличено ограничение объекта SessionData до 2 621 440 символов.
- Расширена
errorMessageMarkdownподдержка свойстваevent.completedметода для надстроек Smart Alerts в Outlook на Mac. - Добавлено свойство , чтобы получить или задать, является ли встреча событием всего дня.
- Добавлены события для активации надстройки на основе событий в сообщении в режиме чтения, если оно содержит определенные типы вложений или пользовательские заголовки Интернета.
- Добавлены свойства и объекты для временного задания текста или темы, отображаемых в режиме чтения.
Список API
В следующей таблице перечислены API JavaScript для Outlook, которые в настоящее время находятся в предварительной версии. Справочную документацию по API для всех API JavaScript для Outlook (включая интерфейсы API предварительной версии и ранее выпущенные API) см. в разделе API Outlook.
| Класс | Поля | Описание |
|---|---|---|
| AppointmentCompose | isAllDayEvent | Возвращает или задает свойство Office.IsAllDayEvent встречи. |
| AppointmentRead | isAllDayEvent | Возвращает логическое значение, указывающее, является ли событие целым днем. |
| РасшифровкаMessageAttachment | attachmentType | Указывает тип вложения. |
| content | Указывает содержимое вложения в кодировке Base64. | |
| contentId | Указывает идентификатор содержимого встроенного вложения. | |
| isInline | Если задано значение true, то расшифрованное вложение отображается как изображение в тексте сообщения, а не в списке вложений. | |
| name | Указывает имя вложения. | |
| Путь | Указывает путь ссылки НА URL-адрес вложения, если его тип — MailboxEnums.AttachmentType.Cloud. |
|
| РасшифровкаMessageBody | coercionType | Задает формат текста сообщения. |
| content | Указывает содержимое, отображаемое в тексте сообщения. | |
| Диагностика | Ews | Возвращает объект для определения того, поддерживаются ли маркеры обратного вызова веб-служб Exchange (EWS) в организации. |
| Display | body | Возвращает объект для временного задания содержимого, отображаемого в тексте сообщения в режиме чтения. |
| subject | Возвращает объект для временного задания содержимого, отображаемого в теме сообщения в режиме чтения. | |
| DisplayedBody | setAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Временно задает содержимое, отображаемое в тексте сообщения в режиме чтения. |
| setAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Временно задает содержимое, отображаемое в тексте сообщения в режиме чтения. | |
| DisplayedSubject | setAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Временно задает содержимое, отображаемое в теме сообщения в режиме чтения. |
| setAsync(data: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Временно задает содержимое, отображаемое в теме сообщения в режиме чтения. | |
| Ews | getTokenStatusAsync(callback: (asyncResult: Office.AsyncResult<MailboxEnums.TokenStatus>) => void) | Возвращает состояние маркеров обратного вызова EWS в организации. |
| getTokenStatusAsync(options: Office.AsyncContextOptions & { isRest?: boolean }, обратный вызов: (asyncResult: Office.AsyncResult<MailboxEnums.TokenStatus>) => void) | Возвращает состояние маркеров обратного вызова EWS в организации. | |
| IsAllDayEvent | getAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void) | Возвращает логическое значение, указывающее, является ли событие целым днем. |
| getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => void) | Возвращает логическое значение, указывающее, является ли событие целым днем. | |
| setAsync(isAllDayEvent: boolean, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Задает состояние события в течение всего дня встречи. | |
| setAsync(isAllDayEvent: boolean, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Задает состояние события в течение всего дня встречи. | |
| MailboxEvent | completed(options?: SmartAlertsEventCompletedOptions | SpamReportingEventCompletedOptions | MessageDecryptEventCompletedOptions) | Указывает, что надстройка на основе событий, создание отчетов о нежелательной почте или расшифровка (предварительная версия) завершила обработку события. |
| MessageDecryptEventCompletedOptions | allowEvent | При использовании метода completed для сигнала о завершении обработчика событий |
| attachments | При использовании метода completed для сигнала о завершении обработчика событий | |
| contextData | При использовании метода completed для сигнала о завершении обработчика событий | |
| emailBody | При использовании метода completed для сигнала о завершении обработчика событий | |
| MessageRead | Отображения | Возвращает объект для временного задания содержимого, отображаемого в тексте или теме сообщения в режиме чтения. |
| TokenStatus | Отключено | Маркеры обратного вызова EWS или маркеры REST API отключены в организации. |
| Включено | В организации поддерживаются маркеры обратного вызова EWS или маркеры REST API. | |
| Удаленные элементы | Почтовый ящик размещается в среде Exchange Online, где маркеры EWS отключены и больше не поддерживаются. |
См. также
Совместная работа с нами на GitHub
Источник этого содержимого можно найти на GitHub, где также можно создавать и просматривать проблемы и запросы на вытягивание. Дополнительные сведения см. в нашем руководстве для участников.
Office Add-ins