Office.DisplayedSubject interface

Pacote:

outlook

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Fornece um método para definir temporariamente o conteúdo exibido no assunto de uma mensagem no modo de leitura.

Comentários

[ Conjunto de API: visualização da caixa de correio ]

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

Modo outlook aplicável: Leitura de mensagem

Métodos

setAsync(data, options, callback)	Define temporariamente o conteúdo exibido no assunto de uma mensagem no modo de leitura. O conteúdo definido permanecerá visível até que o usuário mude para uma mensagem diferente ou feche a janela da mensagem atual.
setAsync(data, callback)	Define temporariamente o conteúdo exibido no assunto de uma mensagem no modo de leitura. O conteúdo definido permanecerá visível até que o usuário mude para uma mensagem diferente ou feche a janela da mensagem atual.

Detalhes do método

setAsync(data, options, callback)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Define temporariamente o conteúdo exibido no assunto de uma mensagem no modo de leitura. O conteúdo definido permanecerá visível até que o usuário mude para uma mensagem diferente ou feche a janela da mensagem atual.

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

Parâmetros

data

string

A cadeia de caracteres a ser exibida temporariamente no assunto de uma mensagem. A cadeia de caracteres está limitada a 255 caracteres.

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, , asyncResultque é um Office.AsyncResult objeto. Quaisquer erros encontrados serão fornecidos na propriedade asyncResult.error.

Retornos

void

Comentários

[ Conjunto de API: visualização da caixa de correio ]

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

Modo outlook aplicável: Leitura de mensagem

Importante:

• Se vários suplementos que implementam a execução setAsync simultaneamente, o conteúdo definido pelo último suplemento que conclui a setAsync operação será exibido no campo de assunto.

• O conteúdo definido pelo setAsync método só é exibido enquanto o usuário está exibindo o item. Ele não é armazenado em cache no Outlook e não é sincronizado com outros clientes do Outlook.

• Se você salvar uma mensagem depois de chamar setAsync, o assunto original será exibido no item salvo.

• O setAsync método não tem suporte em várias mensagens selecionadas.

setAsync(data, callback)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Define temporariamente o conteúdo exibido no assunto de uma mensagem no modo de leitura. O conteúdo definido permanecerá visível até que o usuário mude para uma mensagem diferente ou feche a janela da mensagem atual.

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

Parâmetros

data

string

A cadeia de caracteres a ser exibida temporariamente no assunto de uma mensagem. A cadeia de caracteres está limitada a 255 caracteres.

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, , asyncResultque é um Office.AsyncResult objeto. Quaisquer erros encontrados serão fornecidos na propriedade asyncResult.error.

Retornos

void

Comentários

[ Conjunto de API: visualização da caixa de correio ]

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

Modo outlook aplicável: Leitura de mensagem

Importante:

• Se vários suplementos que implementam a execução setAsync simultaneamente, o conteúdo definido pelo último suplemento que conclui a setAsync operação será exibido no campo de assunto.

• O conteúdo definido pelo setAsync método só é exibido enquanto o usuário está exibindo o item. Ele não é armazenado em cache no Outlook e não é sincronizado com outros clientes do Outlook.

• Se você salvar uma mensagem depois de chamar setAsync, o assunto original será exibido no item salvo.

• O setAsync método não tem suporte em várias mensagens selecionadas.

Exemplos

// 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 subject field 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 subjectText = $("#subject-text-field")
  .val()
  .toString();
Office.context.mailbox.item.display.subject.setAsync(subjectText, (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 subject field.");
});