Office.NotificationMessages interface

Referência

Pacote:: outlook

O objeto NotificationMessages é retornado como a propriedade notificationMessages de um item.

Comentários

[ Conjunto de API: Caixa de correio 1.3 ]

Nível mínimo de permissão: item de leitura

Modo outlook aplicável: compor ou ler

Métodos

addAsync(key, JSONmessage, options, callback)	Adiciona uma notificação a um item. Há um máximo de 5 notificações por mensagem. Definir mais retornará um erro `NumberOfNotificationMessagesExceeded`.
addAsync(key, JSONmessage, callback)	Adiciona uma notificação a um item. Há um máximo de 5 notificações por mensagem. Definir mais retornará um erro `NumberOfNotificationMessagesExceeded`.
getAllAsync(options, callback)	Retorna todas as chaves e mensagens de um item.
getAllAsync(callback)	Retorna todas as chaves e mensagens de um item.
removeAsync(key, options, callback)	Obtém uma mensagem de notificação de um item.
removeAsync(key, callback)	Obtém uma mensagem de notificação de um item.
replaceAsync(key, JSONmessage, options, callback)	Substitui uma mensagem de notificação que tenha uma determinada chave com outra mensagem. Se uma mensagem de notificação com a chave especificada não existir, `replaceAsync` adicionará a notificação.
replaceAsync(key, JSONmessage, callback)	Substitui uma mensagem de notificação que tenha uma determinada chave com outra mensagem. Se uma mensagem de notificação com a chave especificada não existir, `replaceAsync` adicionará a notificação.

Detalhes do método

addAsync(key, JSONmessage, options, callback)

Adiciona uma notificação a um item.

Há um máximo de 5 notificações por mensagem. Definir mais retornará um erro NumberOfNotificationMessagesExceeded.

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

Parâmetros

key: string

Uma chave especificada pelo desenvolvedor usada para fazer referência a essa mensagem de notificação. Os desenvolvedores podem usá-la para modificar esta mensagem mais tarde. Ela não pode ter mais de 32 caracteres.

JSONmessage: Office.NotificationMessageDetails

Um objeto JSON que contém a mensagem de notificação a ser adicionada ao item. Ele contém um NotificationMessageDetails objeto.

options: Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades:- asyncContext: Os desenvolvedores podem fornecer qualquer objeto que desejam acessar na função de retorno de chamada.

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

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.3 ]

Nível mínimo de permissão: item de leitura

Modo outlook aplicável: compor ou ler

Importante:

Apenas uma notificação do tipo InsightMessage é permitida por suplemento. Tentar adicionar mais gerará um erro.
No Outlook na Web moderno, você pode adicionar uma InsightMessage notificação somente no modo Compose.
Somente o InformationalMessage tipo tem suporte no Outlook no Android e no iOS.

Exemplos

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

Adiciona uma notificação a um item.

Há um máximo de 5 notificações por mensagem. Definir mais retornará um erro NumberOfNotificationMessagesExceeded.

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

Parâmetros

key: string

JSONmessage: Office.NotificationMessageDetails

Um objeto JSON que contém a mensagem de notificação a ser adicionada ao item. Ele contém um NotificationMessageDetails objeto.

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

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.3 ]

Nível mínimo de permissão: item de leitura

Modo outlook aplicável: compor ou ler

Importante:

Apenas uma notificação do tipo InsightMessage é permitida por suplemento. Tentar adicionar mais gerará um erro.
No Outlook na Web moderno, você pode adicionar uma InsightMessage notificação somente no modo Compose.
Somente o InformationalMessage tipo tem suporte no Outlook no Android e no iOS.

getAllAsync(options, callback)

Retorna todas as chaves e mensagens de um item.

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

Parâmetros

options: Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades:- asyncContext: Os desenvolvedores podem fornecer qualquer objeto que desejam acessar na função de retorno de chamada.

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

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult. A value propriedade do resultado é uma matriz de NotificationMessageDetails objetos.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.3 ]

Nível mínimo de permissão: item de leitura

Modo outlook aplicável: compor ou ler

Exemplos

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

Retorna todas as chaves e mensagens de um item.

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

Parâmetros

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

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.3 ]

Nível mínimo de permissão: item de leitura

Modo outlook aplicável: compor ou ler

removeAsync(key, options, callback)

Obtém uma mensagem de notificação de um item.

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

Parâmetros

key: string

A chave para a mensagem de notificação a remover.

options: Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades:- asyncContext: Os desenvolvedores podem fornecer qualquer objeto que desejam acessar na função de retorno de chamada.

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

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.3 ]

Nível mínimo de permissão: item de leitura

Modo outlook aplicável: compor ou ler

Exemplos

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

Obtém uma mensagem de notificação de um item.

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

Parâmetros

key: string

A chave para a mensagem de notificação a remover.

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

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.3 ]

Nível mínimo de permissão: item de leitura

Modo outlook aplicável: compor ou ler

replaceAsync(key, JSONmessage, options, callback)

Substitui uma mensagem de notificação que tenha uma determinada chave com outra mensagem.

Se uma mensagem de notificação com a chave especificada não existir, replaceAsync adicionará a notificação.

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

Parâmetros

key: string

A chave para a mensagem de notificação a substituir. Ela não pode ter mais de 32 caracteres.

JSONmessage: Office.NotificationMessageDetails

Um objeto JSON que contém a nova mensagem de notificação para substituir a mensagem existente. Ele contém um NotificationMessageDetails objeto.

options: Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades:- asyncContext: Os desenvolvedores podem fornecer qualquer objeto que desejam acessar na função de retorno de chamada.

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

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.3 ]

Nível mínimo de permissão: item de leitura

Modo outlook aplicável: compor ou ler

Exemplos

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

Substitui uma mensagem de notificação que tenha uma determinada chave com outra mensagem.

Se uma mensagem de notificação com a chave especificada não existir, replaceAsync adicionará a notificação.

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

Parâmetros

key: string

A chave para a mensagem de notificação a substituir. Ela não pode ter mais de 32 caracteres.

JSONmessage: Office.NotificationMessageDetails

Um objeto JSON que contém a nova mensagem de notificação para substituir a mensagem existente. Ele contém um NotificationMessageDetails objeto.

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

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.3 ]

Nível mínimo de permissão: item de leitura

Modo outlook aplicável: compor ou ler

Office.NotificationMessages interface

Comentários

Métodos

Detalhes do método

addAsync(key, JSONmessage, options, callback)

Parâmetros

Retornos

Comentários

Exemplos

addAsync(key, JSONmessage, callback)

Parâmetros

Retornos

Comentários

getAllAsync(options, callback)

Parâmetros

Retornos

Comentários

Exemplos

getAllAsync(callback)

Parâmetros

Retornos

Comentários

removeAsync(key, options, callback)

Parâmetros

Retornos

Comentários

Exemplos

removeAsync(key, callback)

Parâmetros

Retornos

Comentários

replaceAsync(key, JSONmessage, options, callback)

Parâmetros

Retornos

Comentários

Exemplos

replaceAsync(key, JSONmessage, callback)

Parâmetros

Retornos

Comentários

Comentários

Recursos adicionais