Office.SensitivityLabel interface

  • Referência
Pacote:
outlook

Fornece métodos para obter ou definir o rótulo de confidencialidade de uma mensagem ou compromisso. Para obter mais informações sobre rótulos de confidencialidade, consulte Saiba mais sobre rótulos de confidencialidade.

Comentários

[ Conjunto de API: Caixa de correio 1.13 ]

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

Modo outlook aplicável: compose

Importante: para usar o recurso de rótulo de confidencialidade no suplemento, você deve ter uma assinatura Microsoft 365 E5.

Para saber mais sobre como gerenciar rótulos de confidencialidade no suplemento, consulte Gerenciar o rótulo de confidencialidade da mensagem ou compromisso no modo de composição.

Métodos

getAsync(options, callback)

Obtém o GUID (identificador exclusivo) do rótulo de confidencialidade aplicado a uma mensagem ou compromisso que está sendo composto.
getAsync(callback)

Obtém o GUID (identificador exclusivo) do rótulo de confidencialidade aplicado a uma mensagem ou compromisso que está sendo composto.
setAsync(sensitivityLabel, options, callback)

Aplica o rótulo de confidencialidade especificado à mensagem ou ao compromisso que está sendo composto.
setAsync(sensitivityLabel, callback)

Aplica o rótulo de confidencialidade especificado à mensagem ou ao compromisso que está sendo composto.

Detalhes do método

getAsync(options, callback)

Obtém o GUID (identificador exclusivo) do rótulo de confidencialidade aplicado a uma mensagem ou compromisso que está sendo composto.

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, , asyncResultque é um Office.AsyncResult objeto. O GUID do rótulo de confidencialidade é retornado na asyncResult.value propriedade.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.13 ]

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

Modo outlook aplicável: compose

Importante: para usar o recurso de rótulo de confidencialidade no suplemento, você deve ter uma assinatura Microsoft 365 E5.

Para saber mais sobre como gerenciar rótulos de confidencialidade no suplemento, consulte Gerenciar o rótulo de confidencialidade da mensagem ou compromisso no modo de composição.

getAsync(callback)

Obtém o GUID (identificador exclusivo) do rótulo de confidencialidade aplicado a uma mensagem ou compromisso que está sendo composto.

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, , asyncResultque é um Office.AsyncResult objeto. O GUID do rótulo de confidencialidade é retornado na asyncResult.value propriedade.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.13 ]

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

Modo outlook aplicável: compose

Importante: para usar o recurso de rótulo de confidencialidade no suplemento, você deve ter uma assinatura Microsoft 365 E5.

Para saber mais sobre como gerenciar rótulos de confidencialidade no suplemento, consulte Gerenciar o rótulo de confidencialidade da mensagem ou compromisso no modo de composição.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/60-sensitivity-label/sensitivity-label.yaml

// This snippet gets the current mail item's sensitivity label.
Office.context.sensitivityLabelsCatalog.getIsEnabledAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded && asyncResult.value == true) {
    Office.context.mailbox.item.sensitivityLabel.getAsync((asyncResult) => {
      if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
        console.log(asyncResult.value);
      } else {
        console.log("Action failed with error: " + asyncResult.error.message);
      }
    });
  } else {
    console.log("Action failed with error: " + asyncResult.error.message);
  }
});

setAsync(sensitivityLabel, options, callback)

Aplica o rótulo de confidencialidade especificado à mensagem ou ao compromisso que está sendo composto.

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

Parâmetros

sensitivityLabel

string | Office.SensitivityLabelDetails

O rótulo de confidencialidade a ser aplicado à mensagem ou ao compromisso que está sendo composto. O valor do parâmetro pode ser o GUID (identificador exclusivo) de um rótulo de confidencialidade ou um objeto SensitivityLabelDetails .

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.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.13 ]

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

Modo outlook aplicável: compose

Importante: para usar o recurso de rótulo de confidencialidade no suplemento, você deve ter uma assinatura Microsoft 365 E5.

Dica: para determinar os rótulos de confidencialidade disponíveis para uso, chame o Office.context.sensitivityLabelsCatalog.getAsync método.

Para saber mais sobre como gerenciar rótulos de confidencialidade no suplemento, consulte Gerenciar o rótulo de confidencialidade da mensagem ou compromisso no modo de composição.

setAsync(sensitivityLabel, callback)

Aplica o rótulo de confidencialidade especificado à mensagem ou ao compromisso que está sendo composto.

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

Parâmetros

sensitivityLabel

string | Office.SensitivityLabelDetails

O rótulo de confidencialidade a ser aplicado à mensagem ou ao compromisso que está sendo composto. O valor do parâmetro pode ser o GUID (identificador exclusivo) de um rótulo de confidencialidade ou um objeto SensitivityLabelDetails .

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.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.13 ]

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

Modo outlook aplicável: compose

Importante: para usar o recurso de rótulo de confidencialidade no suplemento, você deve ter uma assinatura Microsoft 365 E5.

Dica: para determinar os rótulos de confidencialidade disponíveis para uso, chame o Office.context.sensitivityLabelsCatalog.getAsync método.

Para saber mais sobre como gerenciar rótulos de confidencialidade no suplemento, consulte Gerenciar o rótulo de confidencialidade da mensagem ou compromisso no modo de composição.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/60-sensitivity-label/sensitivity-label.yaml

// This snippet sets the sensitivity label on the current mail item.
Office.context.sensitivityLabelsCatalog.getIsEnabledAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded && asyncResult.value == true) {
    Office.context.sensitivityLabelsCatalog.getAsync((asyncResult) => {
      if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
        const catalog = asyncResult.value;
        if (catalog.length > 0) {
          var id = catalog[0].id;
          Office.context.mailbox.item.sensitivityLabel.setAsync(id, (asyncResult) => {
            if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
              console.log(asyncResult.status);
            } else {
              console.log("Action failed with error: " + asyncResult.error.message);
            }
          });
        }
        else {
          console.log("Catalog list is empty");
        }
      } else {
        console.log("Action failed with error: " + asyncResult.error.message);
      }
    });
  } else {
    console.log("Action failed with error: " + asyncResult.error.message);
  }
});