Compartilhar via


Office.Subject interface

Fornece métodos para obter e definir o assunto de um compromisso ou uma mensagem em um suplemento do Outlook.

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

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

Modo outlook aplicável: compose

Métodos

getAsync(options, callback)

Obtém o assunto de um compromisso ou uma mensagem.

O método getAsync inicia uma chamada assíncrona para o Exchange Server para obter o assunto de um compromisso ou uma mensagem.

getAsync(callback)

Obtém o assunto de um compromisso ou uma mensagem.

O método getAsync inicia uma chamada assíncrona para o Exchange Server para obter o assunto de um compromisso ou uma mensagem.

setAsync(subject, options, callback)

Define o assunto de um compromisso ou uma mensagem.

O método setAsync inicia uma chamada assíncrona para o Exchange Server para definir o assunto de um compromisso ou uma mensagem. Definir o assunto substitui o assunto atual, mas mantém quaisquer prefixos, tais como "Enc:" ou "Res:".

setAsync(subject, callback)

Define o assunto de um compromisso ou uma mensagem.

O método setAsync inicia uma chamada assíncrona para o Exchange Server para definir o assunto de um compromisso ou uma mensagem. Definir o assunto substitui o assunto atual, mas mantém quaisquer prefixos, tais como "Enc:" ou "Res:".

Detalhes do método

getAsync(options, callback)

Obtém o assunto de um compromisso ou uma mensagem.

O método getAsync inicia uma chamada assíncrona para o Exchange Server para obter o assunto de um compromisso ou uma mensagem.

getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => 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<string>) => void

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 é o assunto do item.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

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

Modo outlook aplicável: compose

getAsync(callback)

Obtém o assunto de um compromisso ou uma mensagem.

O método getAsync inicia uma chamada assíncrona para o Exchange Server para obter o assunto de um compromisso ou uma mensagem.

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

Parâmetros

callback

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

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 é o assunto do item.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

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

Modo outlook aplicável: compose

Exemplos

Office.context.mailbox.item.subject.getAsync(callback);

function callback(asyncResult) {
    const subject = asyncResult.value;
}

setAsync(subject, options, callback)

Define o assunto de um compromisso ou uma mensagem.

O método setAsync inicia uma chamada assíncrona para o Exchange Server para definir o assunto de um compromisso ou uma mensagem. Definir o assunto substitui o assunto atual, mas mantém quaisquer prefixos, tais como "Enc:" ou "Res:".

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

Parâmetros

subject

string

O assunto do compromisso ou da 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 do tipo Office.AsyncResult. Se a configuração do assunto falhar, a propriedade asyncResult.error conterá um código de erro.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

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

Modo outlook aplicável: compose

Importante: no Outlook no Android e no iOS, esse método não tem suporte no modo de Composição de Mensagens. Há suporte apenas para o modo Organizador de Compromissos. Para obter mais informações sobre APIs com suporte no Outlook mobile, consulte APIs JavaScript do Outlook com suporte no Outlook em dispositivos móveis.

Erros:

  • DataExceedsMaximumSize: o parâmetro de assunto é maior que 255 caracteres.

Exemplos

Office.context.mailbox.item.subject.setAsync("New subject!", function (asyncResult) {
    if (asyncResult.status === "failed") {
        console.log("Action failed with error: " + asyncResult.error.message);
    }
});

setAsync(subject, callback)

Define o assunto de um compromisso ou uma mensagem.

O método setAsync inicia uma chamada assíncrona para o Exchange Server para definir o assunto de um compromisso ou uma mensagem. Definir o assunto substitui o assunto atual, mas mantém quaisquer prefixos, tais como "Enc:" ou "Res:".

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

Parâmetros

subject

string

O assunto do compromisso ou da 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 do tipo Office.AsyncResult. Se a configuração do assunto falhar, a propriedade asyncResult.error conterá um código de erro.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

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

Modo outlook aplicável: compose

Importante: no Outlook no Android e no iOS, esse método não tem suporte no modo de Composição de Mensagens. Há suporte apenas para o modo Organizador de Compromissos. Para obter mais informações sobre APIs com suporte no Outlook mobile, consulte APIs JavaScript do Outlook com suporte no Outlook em dispositivos móveis.

Erros:

  • DataExceedsMaximumSize: o parâmetro de assunto é maior que 255 caracteres.