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 , вызывается с единственным параметром, asyncResultкоторый является объектом Office.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 , вызывается с единственным параметром, asyncResultкоторый является объектом Office.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 = (document.getElementById("body-text-field") as HTMLInputElement).value;
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.");
});