Office.NotificationMessages interface

Пакет:

outlook

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

Комментарии

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

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

Применимый режим Outlook: Compose или чтение

Важно! Дополнительные сведения о различных типах уведомлений, которые можно реализовать, см. в статье "Создание уведомлений для надстройки Outlook".

Используется

• Office.AppointmentCompose: notificationMessages
• Office.AppointmentRead: notificationMessages
• Office.LoadedMessageCompose: notificationMessages
• Office.LoadedMessageRead: notificationMessages
• Office.MessageCompose: notificationMessages
• Office.MessageRead: 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

Комментарии

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

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

Применимый режим Outlook: Compose или чтение

Важно!

• В 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

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

JSONmessage

Office.NotificationMessageDetails

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

callback

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

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

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

void

Комментарии

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

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

Применимый режим Outlook: Compose или чтение

Важно!

• В 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

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

callback

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

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

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

void

Комментарии

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

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

Применимый режим Outlook: Compose или чтение

Примеры

// 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

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

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

void

Комментарии

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

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

Применимый режим Outlook: Compose или чтение

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: Compose или чтение

Важно! Этот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

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

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

void

Комментарии

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

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

Применимый режим Outlook: Compose или чтение

Важно! ЭтотremoveAsync метод не поддерживается в сообщениях, которые в настоящее время загружаются с помощью этого методаloadItemByIdAsync. Дополнительные сведения см. в статье "Активация надстройки 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: Compose или чтение

Важно! Этот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

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

callback

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

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

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

void

Комментарии

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

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

Применимый режим Outlook: Compose или чтение

Важно! ЭтотreplaceAsync метод не поддерживается в сообщениях, которые в настоящее время загружаются с помощью этого методаloadItemByIdAsync. Дополнительные сведения см. в статье "Активация надстройки Outlook для нескольких сообщений".