Office.DisplayedBody interface

  • Ссылка
Пакет:
outlook

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Предоставляет метод для временного задания содержимого, отображаемого в тексте сообщения, в режиме чтения.

Комментарии

[ Набор API: предварительная версия почтового ящика ]

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

Применимый режим Outlook: чтение сообщений

Методы

setAsync(data, options, callback)

Временно задает содержимое, отображаемое в тексте сообщения в режиме чтения. Содержимое набора остается видимым до тех пор, пока пользователь не переключит на другое сообщение или не закроет окно текущего сообщения.
setAsync(data, callback)

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

Сведения о методе

setAsync(data, options, callback)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

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

setAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

data

string

Строка, которая временно отображается в тексте сообщения. Максимальная длина — 1 000 000 символов.

options

Office.AsyncContextOptions & Office.CoercionTypeOptions

Литерал объекта, содержащий одно или несколько следующих свойств:- asyncContext: разработчики могут предоставить любой объект, к которому они хотят получить доступ в функции обратного вызова. coercionType: формат временно отображаемых данных. Строка в параметре data будет преобразована в этот формат.

callback

(asyncResult: Office.AsyncResult<void>) => void

Необязательный параметр. После завершения метода функция, переданная в callback параметре, вызывается с одним параметром Office.AsyncResult , asyncResultкоторый является объектом . Все обнаруженные ошибки будут указаны в свойстве asyncResult.error.

Возвращаемое значение

void

Комментарии

[ Набор API: предварительная версия почтового ящика ]

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

Применимый режим Outlook: чтение сообщений

Рекомендуется: вызовите Office.context.mailbox.item.body.getTypeAsync, а затем передайте возвращаемое значение в options.coercionType параметр.

Важно!

  • Если одновременно выполняется несколько надстроек, реализующих setAsync , содержимое, заданное последней надстройкой, завершившей setAsync операцию, отображается в тексте.

  • Содержимое, заданное методом setAsync , отображается только во время просмотра пользователем элемента. Он не кэширован в Outlook и не синхронизируется с другими клиентами Outlook.

  • Если сохранить сообщение после вызова setAsync, исходное содержимое текста сообщения отображается в сохраненном элементе.

  • Метод setAsync не поддерживается для нескольких выбранных сообщений.

setAsync(data, callback)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

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

setAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

data

string

Строка, которая временно отображается в тексте сообщения. Максимальная длина — 1 000 000 символов.

callback

(asyncResult: Office.AsyncResult<void>) => void

Необязательный параметр. После завершения метода функция, переданная в callback параметре, вызывается с одним параметром Office.AsyncResult , asyncResultкоторый является объектом . Все обнаруженные ошибки будут указаны в свойстве asyncResult.error.

Возвращаемое значение

void

Комментарии

[ Набор API: предварительная версия почтового ящика ]

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

Применимый режим Outlook: чтение сообщений

Важно!

  • Если одновременно выполняется несколько надстроек, реализующих setAsync , содержимое, заданное последней надстройкой, завершившей setAsync операцию, отображается в тексте.

  • Содержимое, заданное методом setAsync , отображается только во время просмотра пользователем элемента. Он не кэширован в Outlook и не синхронизируется с другими клиентами Outlook.

  • Если сохранить сообщение после вызова setAsync, исходное содержимое текста сообщения отображается в сохраненном элементе.

  • Метод setAsync не поддерживается для нескольких выбранных сообщений.

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/set-displayed-body-subject.yaml

// This snippet temporarily sets the content displayed in the body of a message in read mode.
// The set content will remain visible until the user switches to a different message in the Reading Pane or closes the window of the current message.
const bodyText = $("#body-text-field")
  .val()
  .toString();
Office.context.mailbox.item.display.body.setAsync(bodyText, (asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log(`Action failed with error: ${asyncResult.error.message}`);
    return;
  }

  console.log("Temporarily set the content displayed in the body.");
});