Office.NotificationMessages interface

Пакет:: outlook

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

Методы

addAsync(key, JSONmessage, options, callback)	Добавляет уведомление к элементу.
addAsync(key, JSONmessage, callback)	Добавляет уведомление к элементу.
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)

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

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

В Outlook в Интернете в Windows (новой и классической версии) и на Mac можно задать не более пяти уведомлений на сообщение. При установке дополнительного значения возвращается NumberOfNotificationMessagesExceeded ошибка. В Outlook для Android и iOS можно задать только одно уведомление для каждого сообщения. Установка дополнительного уведомления заменяет предыдущее.
Для каждой надстройки разрешено только одно уведомление типа InsightMessage . Попытка добавить дополнительные сведения приведет к ошибке.
В современных Outlook в Интернете и новом Outlook в Windows уведомление можно добавлять InsightMessage только в режиме Compose.
В Outlook для Android и в iOS поддерживаются только ProgressIndicatorтипы уведомлений , InformationalMessageи ErrorMessage .
В режиме создания, хотя стиль каждого типа уведомлений зависит от других клиентов Outlook, уведомления в Outlook для Android и iOS используют один и тот же стиль. Уведомление всегда имеет префикс с информационным значком.
Метод addAsync не поддерживается в сообщении, загруженном с помощью loadItemByIdAsync метода . Дополнительные сведения см. в разделе Активация надстройки Outlook для нескольких сообщений.

Примеры

// 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 = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.ProgressIndicator,
    message: "Progress indicator with id = " + id
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to add progress notification with id = ${id}. Try using a different ID.`);
    return;
  }
  console.log(`Added progress notification with id = ${id}.`);
});

...

// Adds an informational notification to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Non-persistent informational notification message with id = " + id,
    icon: "PG.Icon.16",
    persistent: false
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to add informational notification with id = ${id}. Try using a different ID.`);
    return;
  }
  console.log(`Added informational notification with id = ${id}.`);
});

...

// Adds a persistent information notification to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Persistent informational notification message with id = " + id,
    icon: "PG.Icon.16",
    persistent: true
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to add persistent informational notification with id = ${id}. Try using a different ID.`);
    return;
  }
  console.log(`Added persistent informational notification with id = ${id}.`);
});

...

// Adds an error notification to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.ErrorMessage,
    message: "Error notification message with id = " + id
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to add error notification with id = ${id}. Try using a different ID.`);
    return;
  }
  console.log(`Added error notification with id = ${id}.`);
});

addAsync(key, JSONmessage, callback)

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

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

Параметры

key: string

JSONmessage: Office.NotificationMessageDetails

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

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

void

В Outlook в Интернете в Windows (новой и классической версии) и на Mac можно задать не более пяти уведомлений на сообщение. При установке дополнительного значения возвращается NumberOfNotificationMessagesExceeded ошибка. В Outlook для Android и iOS можно задать только одно уведомление для каждого сообщения. Установка дополнительного уведомления заменяет предыдущее.
Для каждой надстройки разрешено только одно уведомление типа InsightMessage . Попытка добавить дополнительные сведения приведет к ошибке.
В современных Outlook в Интернете и новом Outlook в Windows уведомление можно добавлять InsightMessage только в режиме Compose.
В Outlook для Android и в iOS поддерживаются только ProgressIndicatorтипы уведомлений , InformationalMessageи ErrorMessage .
В режиме создания, хотя стиль каждого типа уведомлений зависит от других клиентов Outlook, уведомления в Outlook для Android и iOS используют один и тот же стиль. Уведомление всегда имеет префикс с информационным значком.
Метод addAsync не поддерживается в сообщении, загруженном с помощью loadItemByIdAsync метода . Дополнительные сведения см. в разделе Активация надстройки Outlook для нескольких сообщений.

getAllAsync(options, callback)

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

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

Параметры

options: Office.AsyncContextOptions

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

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

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

void

Примеры

// 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(JSON.stringify(asyncResult.value));
});

getAllAsync(callback)

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

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

Параметры

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

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

void

removeAsync(key, options, callback)

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

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

Параметры

key: string

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

options: Office.AsyncContextOptions

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

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

void

Важно! Метод removeAsync не поддерживается в сообщении, загруженном с помощью loadItemByIdAsync метода . Дополнительные сведения см. в разделе Активация надстройки 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 = (document.getElementById("notificationId") as HTMLInputElement).value;
Office.context.mailbox.item.notificationMessages.removeAsync(id, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to remove notification with id = ${id}. ${result.error.message}.`);
    return;
  }
  console.log(`Removed notification with id = ${id}.`);
});

removeAsync(key, callback)

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

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

Параметры

key: string

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

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

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

void

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

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

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

void

Важно! Метод replaceAsync не поддерживается в сообщении, загруженном с помощью loadItemByIdAsync метода . Дополнительные сведения см. в разделе Активация надстройки 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 = (document.getElementById("notificationId") as HTMLInputElement).value;
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
  },
  (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.log(`Failed to replace notification with id = ${id}. ${result.error.message}.`);
      return;
    }
    console.log(`Replaced notification with id = ${id}.`);
  });

replaceAsync(key, JSONmessage, callback)

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

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

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

Параметры

key: string

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

JSONmessage: Office.NotificationMessageDetails

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

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

void

Обратная связь

Была ли эта страница полезна?

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

Комментарии

Методы

addAsync(key, JSONmessage, options, callback)

Параметры

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

Комментарии

Примеры

addAsync(key, JSONmessage, callback)

Параметры

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

Комментарии

getAllAsync(options, callback)

Параметры

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

Комментарии

Примеры

getAllAsync(callback)

Параметры

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

Комментарии

removeAsync(key, options, callback)

Параметры

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

Комментарии

Примеры

removeAsync(key, callback)

Параметры

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

Комментарии

replaceAsync(key, JSONmessage, options, callback)

Параметры

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

Комментарии

Примеры

replaceAsync(key, JSONmessage, callback)

Параметры

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

Комментарии