Набор обязательных элементов API для надстройки Outlook 1.3

Подмножество API надстройки Outlook API JavaScript для Office включает объекты, методы, свойства и события, которые можно использовать в надстройке Outlook.

Примечание.

В этой документации рассматривается не последняя версия набора обязательных элементов.

Новые возможности версии 1.3

Набор обязательных для почтового ящика 1.3 включает все функции набора требований 1.2. В нем добавлены перечисленные ниже возможности.

Список API

В следующей таблице перечислены API, представленные в наборе обязательных почтовых ящиков 1.3. Справочную документацию по API для всех API, поддерживаемых набором обязательных для почтовых ящиков версии 1.3 или более ранней версии, см. в разделе API Outlook.

Класс Поля Описание
AppointmentCompose close() Закрывает текущий создаваемый элемент.
notificationMessages Получает сообщения уведомления для элемента.
saveAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Асинхронно сохраняет элемент.
saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Строка Office.AsyncResult<) => void)> Асинхронно сохраняет элемент.
AppointmentRead notificationMessages Получает сообщения уведомления для элемента.
Основной текст getAsync(coercionType: Office.CoercionType | string, callback?: (asyncResult: Office.AsyncResult<string>) => void) Возвращает весь текущий текст в формате, указанном параметром coercionType.
getAsync(coercionType: Office.CoercionType | string, options: Office.AsyncContextOptions & { bodyMode?: MailboxEnums.BodyMode }, callback?: (asyncResult: Office.AsyncResult<string>) => void) Возвращает весь текущий текст в формате, указанном параметром coercionType.
setAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) Заменяет весь текст указанным текстом.
setAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions & { bodyMode?: MailboxEnums.BodyMode }, callback?: (asyncResult: Office.AsyncResult<void>) => void) Заменяет весь текст указанным текстом.
Mailbox convertToEwsId(id: string, restVersion: MailboxEnums.RestVersion | string) Преобразует поддерживаемый идентификатор в формат веб-служб Exchange (EWS).
convertToRestId(id: string, restVersion: MailboxEnums.RestVersion | string) Преобразует поддерживаемый идентификатор в формат REST.
MessageCompose close() Закрывает текущий создаваемый элемент.
notificationMessages Получает сообщения уведомления для элемента.
saveAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Асинхронно сохраняет текущее сообщение в виде черновика.
saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Строка Office.AsyncResult<) => void)> Асинхронно сохраняет текущее сообщение в виде черновика.
MessageRead notificationMessages Получает сообщения уведомления для элемента.
NotificationMessageDetails icon Ссылка на пользовательский значок, определенный в манифесте.
key Идентификатор для сообщения уведомления.
message Текст сообщения уведомления.
Постоянные Указывает, должно ли сообщение быть постоянным.
type Указывает значение ItemNotificationMessageType сообщения.
NotificationMessages addAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult<void>) => void) Добавляет уведомление к элементу.
addAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Добавляет уведомление к элементу.
getAllAsync(callback?: (asyncResult: Office.AsyncResult<NotificationMessageDetails[]>) => void) Возвращает все ключи и сообщения для элемента.
getAllAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<NotificationMessageDetails[]>) => void) Возвращает все ключи и сообщения для элемента.
removeAsync(key: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) Удаляет сообщение уведомления для элемента.
removeAsync(key: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Удаляет сообщение уведомления для элемента.
replaceAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult<void>) => void) Заменяет сообщение уведомления с заданным ключом на другое сообщение.
replaceAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Заменяет сообщение уведомления с заданным ключом на другое сообщение.
ItemNotificationMessageType ErrorMessage Уведомление представляет собой сообщение об ошибке.
Информационныйmessage Уведомление представляет собой информационное сообщение.
ProgressIndicator Уведомление является индикатором хода выполнения.
RestVersion Бета Beta.
v1_0 Версия 1.0.
v2_0 Версия 2.0.

См. также