Office.SensitivityLabel interface

  • Referência
Pacote:
outlook

Fornece métodos para obter ou definir a etiqueta de confidencialidade de uma mensagem ou compromisso. Para obter mais informações sobre etiquetas de confidencialidade, consulte Saiba mais sobre etiquetas de confidencialidade.

Comentários

[ Conjunto de API: Caixa de Correio 1.13 ]

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

Modo Outlook aplicável: Compor

Importante: para utilizar a funcionalidade de etiqueta de confidencialidade no seu suplemento, tem de ter uma subscrição do Microsoft 365 E5.

Para saber mais sobre como gerir etiquetas de confidencialidade no seu suplemento, consulte Gerir a etiqueta de confidencialidade da sua mensagem ou compromisso no modo de composição.

Métodos

getAsync(options, callback)

Obtém o identificador exclusivo (GUID) da etiqueta de confidencialidade aplicada a uma mensagem ou compromisso que está a ser composto.
getAsync(callback)

Obtém o identificador exclusivo (GUID) da etiqueta de confidencialidade aplicada a uma mensagem ou compromisso que está a ser composto.
setAsync(sensitivityLabel, options, callback)

Aplica a etiqueta de confidencialidade especificada à mensagem ou compromisso que está a ser composto.
setAsync(sensitivityLabel, callback)

Aplica a etiqueta de confidencialidade especificada à mensagem ou compromisso que está a ser composto.

Detalhes do método

getAsync(options, callback)

Obtém o identificador exclusivo (GUID) da etiqueta de confidencialidade aplicada a uma mensagem ou compromisso que está a ser 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 programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.

callback

(asyncResult: Office.AsyncResult<string>) => 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 GUID da etiqueta de confidencialidade é devolvido 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/escrita

Modo Outlook aplicável: Compor

Importante: para utilizar a funcionalidade de etiqueta de confidencialidade no seu suplemento, tem de ter uma subscrição do Microsoft 365 E5.

Para saber mais sobre como gerir etiquetas de confidencialidade no seu suplemento, consulte Gerir a etiqueta de confidencialidade da sua mensagem ou compromisso no modo de composição.

getAsync(callback)

Obtém o identificador exclusivo (GUID) da etiqueta de confidencialidade aplicada a uma mensagem ou compromisso que está a ser composto.

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

Parâmetros

callback

(asyncResult: Office.AsyncResult<string>) => 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 GUID da etiqueta de confidencialidade é devolvido 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/escrita

Modo Outlook aplicável: Compor

Importante: para utilizar a funcionalidade de etiqueta de confidencialidade no seu suplemento, tem de ter uma subscrição do Microsoft 365 E5.

Para saber mais sobre como gerir etiquetas de confidencialidade no seu suplemento, consulte Gerir a etiqueta de confidencialidade da sua 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 a etiqueta de confidencialidade especificada à mensagem ou compromisso que está a ser composto.

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

Parâmetros

sensitivityLabel

string | Office.SensitivityLabelDetails

A etiqueta de confidencialidade a aplicar à mensagem ou compromisso que está a ser composto. O valor do parâmetro pode ser o identificador exclusivo (GUID) de uma etiqueta de confidencialidade ou um objeto SensitivityLabelDetails .

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.13 ]

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

Modo Outlook aplicável: Compor

Importante: para utilizar a funcionalidade de etiqueta de confidencialidade no seu suplemento, tem de ter uma subscrição do Microsoft 365 E5.

Sugestão: para determinar as etiquetas de confidencialidade disponíveis para utilização, chame o Office.context.sensitivityLabelsCatalog.getAsync método .

Para saber mais sobre como gerir etiquetas de confidencialidade no seu suplemento, consulte Gerir a etiqueta de confidencialidade da sua mensagem ou compromisso no modo de composição.

setAsync(sensitivityLabel, callback)

Aplica a etiqueta de confidencialidade especificada à mensagem ou compromisso que está a ser composto.

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

Parâmetros

sensitivityLabel

string | Office.SensitivityLabelDetails

A etiqueta de confidencialidade a aplicar à mensagem ou compromisso que está a ser composto. O valor do parâmetro pode ser o identificador exclusivo (GUID) de uma etiqueta de confidencialidade ou um objeto SensitivityLabelDetails .

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.13 ]

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

Modo Outlook aplicável: Compor

Importante: para utilizar a funcionalidade de etiqueta de confidencialidade no seu suplemento, tem de ter uma subscrição do Microsoft 365 E5.

Sugestão: para determinar as etiquetas de confidencialidade disponíveis para utilização, chame o Office.context.sensitivityLabelsCatalog.getAsync método .

Para saber mais sobre como gerir etiquetas de confidencialidade no seu suplemento, consulte Gerir a etiqueta de confidencialidade da sua 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);
  }
});