Поделиться через


Office.NotificationMessages interface

Объект NotificationMessages возвращается в качестве свойства notificationMessages элемента.

Комментарии

[ Набор API: Почтовый ящик 1.3 ]

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

Применимый режим Outlook: создание или чтение

Методы

addAsync(key, JSONmessage, options, callback)

Добавляет уведомление к элементу.

Для каждого сообщения можно задать не более 5 уведомлений. Если задать больше, будет возвращена ошибка NumberOfNotificationMessagesExceeded.

addAsync(key, JSONmessage, callback)

Добавляет уведомление к элементу.

Для каждого сообщения можно задать не более 5 уведомлений. Если задать больше, будет возвращена ошибка NumberOfNotificationMessagesExceeded.

getAllAsync(options, callback)

Возвращает все ключи и сообщения для элемента.

getAllAsync(callback)

Возвращает все ключи и сообщения для элемента.

removeAsync(key, options, callback)

Удаляет сообщение уведомления для элемента.

removeAsync(key, callback)

Удаляет сообщение уведомления для элемента.

replaceAsync(key, JSONmessage, options, callback)

Заменяет сообщение уведомления с заданным ключом на другое сообщение.

Если сообщение уведомления с указанным ключом не существует, replaceAsync добавит уведомление.

replaceAsync(key, JSONmessage, callback)

Заменяет сообщение уведомления с заданным ключом на другое сообщение.

Если сообщение уведомления с указанным ключом не существует, replaceAsync добавит уведомление.

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

addAsync(key, JSONmessage, options, callback)

Добавляет уведомление к элементу.

Для каждого сообщения можно задать не более 5 уведомлений. Если задать больше, будет возвращена ошибка NumberOfNotificationMessagesExceeded.

addAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

key

string

Указанный разработчиком ключ, используемый для ссылки на это сообщение уведомления. Разработчики могут использовать его для изменения этого сообщения в дальнейшем. Его длина не должна превышать 32 символа.

JSONmessage
Office.NotificationMessageDetails

Объект JSON, содержащий сообщение уведомления, которое необходимо добавить к элементу. Он содержит NotificationMessageDetails объект .

options
Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

[ Набор API: Почтовый ящик 1.3 ]

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

Применимый режим Outlook: создание или чтение

Важно!

  • Для каждой надстройки разрешено только одно уведомление типа InsightMessage . Попытка добавить дополнительные сведения приведет к ошибке.

  • В современных Outlook в Интернете и новых Outlook в Windows уведомление можно добавлять InsightMessage только в режиме создания.

  • InformationalMessage В Outlook для Android и iOS поддерживается только тип .

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/35-notifications/add-getall-remove.yaml

// Adds a progress indicator to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.ProgressIndicator,
    message: "Progress indicator with id = " + id
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds an informational notification to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Non-persistent informational notification message with id = " + id,
    icon: "icon1",
    persistent: false
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds a persistent information notification to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Persistent informational notification message with id = " + id,
    icon: "icon1",
    persistent: true
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds an error notification to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.ErrorMessage,
    message: "Error notification message with id = " + id
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

addAsync(key, JSONmessage, callback)

Добавляет уведомление к элементу.

Для каждого сообщения можно задать не более 5 уведомлений. Если задать больше, будет возвращена ошибка NumberOfNotificationMessagesExceeded.

addAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

key

string

Указанный разработчиком ключ, используемый для ссылки на это сообщение уведомления. Разработчики могут использовать его для изменения этого сообщения в дальнейшем. Его длина не должна превышать 32 символа.

JSONmessage
Office.NotificationMessageDetails

Объект JSON, содержащий сообщение уведомления, которое необходимо добавить к элементу. Он содержит NotificationMessageDetails объект .

callback

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

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

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

void

Комментарии

[ Набор API: Почтовый ящик 1.3 ]

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

Применимый режим Outlook: создание или чтение

Важно!

  • Для каждой надстройки разрешено только одно уведомление типа InsightMessage . Попытка добавить дополнительные сведения приведет к ошибке.

  • В современных Outlook в Интернете и новых Outlook в Windows уведомление можно добавлять InsightMessage только в режиме создания.

  • InformationalMessage В Outlook для Android и iOS поддерживается только тип .

getAllAsync(options, callback)

Возвращает все ключи и сообщения для элемента.

getAllAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<NotificationMessageDetails[]>) => void): void;

Параметры

options
Office.AsyncContextOptions

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

callback

(asyncResult: Office.AsyncResult<Office.NotificationMessageDetails[]>) => void

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

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

void

Комментарии

[ Набор API: Почтовый ящик 1.3 ]

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

Применимый режим Outlook: создание или чтение

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/35-notifications/add-getall-remove.yaml

// Gets all the notification messages and their keys for the current mail item.
Office.context.mailbox.item.notificationMessages.getAllAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log(asyncResult.error.message);
    return;
  }

  console.log(asyncResult.value);
});

getAllAsync(callback)

Возвращает все ключи и сообщения для элемента.

getAllAsync(callback?: (asyncResult: Office.AsyncResult<NotificationMessageDetails[]>) => void): void;

Параметры

callback

(asyncResult: Office.AsyncResult<Office.NotificationMessageDetails[]>) => void

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

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

void

Комментарии

[ Набор API: Почтовый ящик 1.3 ]

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

Применимый режим Outlook: создание или чтение

removeAsync(key, options, callback)

Удаляет сообщение уведомления для элемента.

removeAsync(key: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

key

string

Ключ для удаления сообщения уведомления.

options
Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

[ Набор API: Почтовый ящик 1.3 ]

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

Применимый режим Outlook: создание или чтение

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/35-notifications/add-getall-remove.yaml

// Removes a notification message from the current mail item.
const id = $("#notificationId").val().toString();
Office.context.mailbox.item.notificationMessages.removeAsync(id, handleResult);

removeAsync(key, callback)

Удаляет сообщение уведомления для элемента.

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

Параметры

key

string

Ключ для удаления сообщения уведомления.

callback

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

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

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

void

Комментарии

[ Набор API: Почтовый ящик 1.3 ]

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

Применимый режим Outlook: создание или чтение

replaceAsync(key, JSONmessage, options, callback)

Заменяет сообщение уведомления с заданным ключом на другое сообщение.

Если сообщение уведомления с указанным ключом не существует, replaceAsync добавит уведомление.

replaceAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

key

string

Ключ для заменяемого сообщения уведомления. Максимальная длина — 32 символа.

JSONmessage
Office.NotificationMessageDetails

Объект JSON, содержащий новое сообщение уведомления, которое заменяет существующее сообщение. Он содержит NotificationMessageDetails объект .

options
Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

[ Набор API: Почтовый ящик 1.3 ]

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

Применимый режим Outlook: создание или чтение

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/35-notifications/add-getall-remove.yaml

// Replaces a notification message of a given key with another message.
const id = $("#notificationId").val().toString();
Office.context.mailbox.item.notificationMessages.replaceAsync(
  id,
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Notification message with id = " + id + " has been replaced with an informational message.",
    icon: "icon2",
    persistent: false
  },
  handleResult);

replaceAsync(key, JSONmessage, callback)

Заменяет сообщение уведомления с заданным ключом на другое сообщение.

Если сообщение уведомления с указанным ключом не существует, replaceAsync добавит уведомление.

replaceAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

key

string

Ключ для заменяемого сообщения уведомления. Максимальная длина — 32 символа.

JSONmessage
Office.NotificationMessageDetails

Объект JSON, содержащий новое сообщение уведомления, которое заменяет существующее сообщение. Он содержит NotificationMessageDetails объект .

callback

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

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

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

void

Комментарии

[ Набор API: Почтовый ящик 1.3 ]

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

Применимый режим Outlook: создание или чтение