Office.Sensitivity interface
Fornece métodos para obter e definir o nível de confidencialidade de um compromisso. Para saber mais sobre os níveis de confidencialidade, consulte Marcar o seu e-mail como Normal, Pessoal, Privado ou Confidencial.
Comentários
[ Conjunto de API: Caixa de Correio 1.14 ]
Nível mínimo de permissão: ler item
Modo Outlook aplicável: Compose
Métodos
| get |
Obtém o nível de confidencialidade de um compromisso. |
| get |
Obtém o nível de confidencialidade de um compromisso. |
| set |
Define o nível de confidencialidade de um compromisso. |
| set |
Define o nível de confidencialidade de um compromisso. |
Detalhes do método
getAsync(options, callback)
Obtém o nível de confidencialidade de um compromisso.
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<MailboxEnums.AppointmentSensitivityType>) => void): void;Parâmetros
- options
- Office.AsyncContextOptions
Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.
- callback
-
(asyncResult: Office.AsyncResult<Office.MailboxEnums.AppointmentSensitivityType>) => void
Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro, asyncResult, que é um Office.AsyncResult objeto. O nível de confidencialidade do compromisso é devolvido na asyncResult.value propriedade .
Retornos
void
Comentários
[ Conjunto de API: Caixa de Correio 1.14 ]
Nível mínimo de permissão: ler item
Modo Outlook aplicável: Compose
Importante: Outlook na Web, o novo Outlook no Windows e o Outlook no Mac só suportam níveis de confidencialidade Normal e Privado. Se ligar getAsync para um compromisso que tenha um nível de confidencialidade Confidencial ou Pessoal destes clientes, o nível de confidencialidade Normal é devolvido na asyncResult.value propriedade .
getAsync(callback)
Obtém o nível de confidencialidade de um compromisso.
getAsync(callback: (asyncResult: Office.AsyncResult<MailboxEnums.AppointmentSensitivityType>) => void): void;Parâmetros
- callback
-
(asyncResult: Office.AsyncResult<Office.MailboxEnums.AppointmentSensitivityType>) => void
Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro, asyncResult, que é um Office.AsyncResult objeto. O nível de confidencialidade do compromisso é devolvido na asyncResult.value propriedade .
Retornos
void
Comentários
[ Conjunto de API: Caixa de Correio 1.14 ]
Nível mínimo de permissão: ler item
Modo Outlook aplicável: Compose
Importante: Outlook na Web, o novo Outlook no Windows e o Outlook no Mac só suportam níveis de confidencialidade Normal e Privado. Se ligar getAsync para um compromisso que tenha um nível de confidencialidade Confidencial ou Pessoal destes clientes, o nível de confidencialidade Normal é devolvido na asyncResult.value propriedade .
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-sensitivity-level.yaml
Office.context.mailbox.item.sensitivity.getAsync(function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
console.log("Sensitivity: " + asyncResult.value);
} else {
console.log("Failed to get sensitivity: " + JSON.stringify(asyncResult.error));
}
});
setAsync(sensitivity, options, callback)
Define o nível de confidencialidade de um compromisso.
setAsync(sensitivity: MailboxEnums.AppointmentSensitivityType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Parâmetros
- sensitivity
O nível de confidencialidade como uma enumeração ou cadeia.
- options
- Office.AsyncContextOptions
Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro, asyncResult, que é um Office.AsyncResult objeto.
Retornos
void
Comentários
[ Conjunto de API: Caixa de Correio 1.14 ]
Nível mínimo de permissão: item de leitura/escrita
Modo Outlook aplicável: Compose
Importante: Outlook na Web, o novo Outlook no Windows e o Outlook no Mac só suportam níveis de confidencialidade Normal e Privado.
Erros:
-
Unsupported API parameter: a definição do nível de confidencialidade de um compromisso não é suportada.
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-sensitivity-level.yaml
Office.context.mailbox.item.sensitivity.setAsync(
Office.MailboxEnums.AppointmentSensitivityType.Private,
function callback(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Failed) {
console.log("Failed to set appointment sensitivity: " + JSON.stringify(asyncResult.error));
} else {
console.log("Successfully set appointment sensitivity.");
}
}
);
setAsync(sensitivity, callback)
Define o nível de confidencialidade de um compromisso.
setAsync(sensitivity: MailboxEnums.AppointmentSensitivityType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Parâmetros
- sensitivity
O nível de confidencialidade como uma enumeração ou cadeia.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro, asyncResult, que é um Office.AsyncResult objeto.
Retornos
void
Comentários
[ Conjunto de API: Caixa de Correio 1.14 ]
Nível mínimo de permissão: item de leitura/escrita
Modo Outlook aplicável: Compose
Importante: Outlook na Web, o novo Outlook no Windows e o Outlook no Mac só suportam níveis de confidencialidade Normal e Privado.
Erros:
-
Unsupported API parameter: a definição do nível de confidencialidade de um compromisso não é suportada.