Compartilhar via

Office.SensitivityLabelsCatalog interface

  • Referência
Pacote:
outlook

Fornece métodos para marcar o status do catálogo de rótulos de confidencialidade no Outlook e recuperar todos os rótulos de confidencialidade disponíveis se o catálogo estiver habilitado.

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 todos os rótulos de confidencialidade habilitados no Outlook.
getAsync(callback)

Obtém todos os rótulos de confidencialidade habilitados no Outlook.
getIsEnabledAsync(options, callback)

Verifica se o catálogo de rótulos de confidencialidade está habilitado no Outlook.
getIsEnabledAsync(callback)

Verifica se o catálogo de rótulos de confidencialidade está habilitado no Outlook.

Detalhes do método

getAsync(options, callback)

Obtém todos os rótulos de confidencialidade habilitados no Outlook.

getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SensitivityLabelDetails[]>) => 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<Office.SensitivityLabelDetails[]>) => 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. Os rótulos de confidencialidade disponíveis e suas propriedades são retornados 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.

Recomendado: para determinar se o catálogo de rótulos de confidencialidade está habilitado no Outlook, chame getIsEnabledAsync antes de usar getAsync.

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 todos os rótulos de confidencialidade habilitados no Outlook.

getAsync(callback: (asyncResult: Office.AsyncResult<SensitivityLabelDetails[]>) => void): void;

Parâmetros

callback

(asyncResult: Office.AsyncResult<Office.SensitivityLabelDetails[]>) => 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. Os rótulos de confidencialidade disponíveis e suas propriedades são retornados 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.

Recomendado: para determinar se o catálogo de rótulos de confidencialidade está habilitado no Outlook, chame getIsEnabledAsync antes de usar getAsync.

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-labels-catalog.yaml

// This snippet gets all available sensitivity labels from the catalog.
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;
        console.log("Sensitivity Labels Catalog:");
        console.log(JSON.stringify(catalog));
      } else {
        console.log("Action failed with error: " + asyncResult.error.message);
      }
    });
  } else {
    console.log("Action failed with error: " + asyncResult.error.message);
  }
});

getIsEnabledAsync(options, callback)

Verifica se o catálogo de rótulos de confidencialidade está habilitado no Outlook.

getIsEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => 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<boolean>) => 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 status do catálogo de rótulos 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: o catálogo de rótulos de confidencialidade é configurado pelo administrador de uma organização. Para obter mais informações, consulte Introdução aos rótulos de confidencialidade.

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.

getIsEnabledAsync(callback)

Verifica se o catálogo de rótulos de confidencialidade está habilitado no Outlook.

getIsEnabledAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;

Parâmetros

callback

(asyncResult: Office.AsyncResult<boolean>) => 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 status do catálogo de rótulos 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: o catálogo de rótulos de confidencialidade é configurado pelo administrador de uma organização. Para obter mais informações, consulte Introdução aos rótulos de confidencialidade.

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-labels-catalog.yaml

// This snippet determines if the sensitivity labels catalog is enabled on the current mailbox.
Office.context.sensitivityLabelsCatalog.getIsEnabledAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log(asyncResult.value);
  } else {
    console.log("Action failed with error: " + asyncResult.error.message);
  }
});