Office.SensitivityLabel interface

  • Ссылка
Пакет:
outlook

Предоставляет методы для получения или задания метки конфиденциальности сообщения или встречи. Дополнительные сведения о метках конфиденциальности см. в статье Сведения о метках конфиденциальности.

Комментарии

[ Набор API: Почтовый ящик 1.13 ]

Минимальный уровень разрешений: чтение и запись элемента

Применимый режим Outlook: Создание

Важно! Чтобы использовать функцию метки конфиденциальности в надстройке, у вас должна быть подписка Microsoft 365 E5.

Дополнительные сведения об управлении метками конфиденциальности в надстройке см. в статье Управление метками конфиденциальности сообщения или встречи в режиме создания.

Методы

getAsync(options, callback)

Возвращает уникальный идентификатор (GUID) метки конфиденциальности, применяемой к создаваемому сообщению или встрече.
getAsync(callback)

Возвращает уникальный идентификатор (GUID) метки конфиденциальности, применяемой к создаваемому сообщению или встрече.
setAsync(sensitivityLabel, options, callback)

Применяет указанную метку конфиденциальности к создаваемому сообщению или встрече.
setAsync(sensitivityLabel, callback)

Применяет указанную метку конфиденциальности к создаваемому сообщению или встрече.

Сведения о методе

getAsync(options, callback)

Возвращает уникальный идентификатор (GUID) метки конфиденциальности, применяемой к создаваемому сообщению или встрече.

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

Параметры

options
Office.AsyncContextOptions

Литерал объекта, содержащий одно или несколько следующих свойств:- asyncContext: разработчики могут предоставить любой объект, к которому они хотят получить доступ в функции обратного вызова.

callback

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

После завершения метода функция, переданная в callback параметре, вызывается с одним параметром Office.AsyncResult , asyncResultкоторый является объектом . Guid метки конфиденциальности возвращается в свойстве asyncResult.value .

Возвращаемое значение

void

Комментарии

[ Набор API: Почтовый ящик 1.13 ]

Минимальный уровень разрешений: чтение и запись элемента

Применимый режим Outlook: Создание

Важно! Чтобы использовать функцию метки конфиденциальности в надстройке, у вас должна быть подписка Microsoft 365 E5.

Дополнительные сведения об управлении метками конфиденциальности в надстройке см. в статье Управление метками конфиденциальности сообщения или встречи в режиме создания.

getAsync(callback)

Возвращает уникальный идентификатор (GUID) метки конфиденциальности, применяемой к создаваемому сообщению или встрече.

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

Параметры

callback

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

После завершения метода функция, переданная в callback параметре, вызывается с одним параметром Office.AsyncResult , asyncResultкоторый является объектом . Guid метки конфиденциальности возвращается в свойстве asyncResult.value .

Возвращаемое значение

void

Комментарии

[ Набор API: Почтовый ящик 1.13 ]

Минимальный уровень разрешений: чтение и запись элемента

Применимый режим Outlook: Создание

Важно! Чтобы использовать функцию метки конфиденциальности в надстройке, у вас должна быть подписка Microsoft 365 E5.

Дополнительные сведения об управлении метками конфиденциальности в надстройке см. в статье Управление метками конфиденциальности сообщения или встречи в режиме создания.

Примеры

// 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)

Применяет указанную метку конфиденциальности к создаваемому сообщению или встрече.

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

Параметры

sensitivityLabel

string | Office.SensitivityLabelDetails

Метка конфиденциальности, применяемая к создаваемому сообщению или встрече. Значение параметра может быть уникальным идентификатором (GUID) метки конфиденциальности или объектом SensitivityLabelDetails .

options
Office.AsyncContextOptions

Литерал объекта, содержащий одно или несколько следующих свойств:- asyncContext: разработчики могут предоставить любой объект, к которому они хотят получить доступ в функции обратного вызова.

callback

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

Необязательный параметр. После завершения метода функция, переданная в callback параметре, вызывается с одним параметром Office.AsyncResult , asyncResultкоторый является объектом .

Возвращаемое значение

void

Комментарии

[ Набор API: Почтовый ящик 1.13 ]

Минимальный уровень разрешений: чтение и запись элемента

Применимый режим Outlook: Создание

Важно! Чтобы использовать функцию метки конфиденциальности в надстройке, у вас должна быть подписка Microsoft 365 E5.

Совет. Чтобы определить метки конфиденциальности, доступные для использования, вызовите Office.context.sensitivityLabelsCatalog.getAsync метод .

Дополнительные сведения об управлении метками конфиденциальности в надстройке см. в статье Управление метками конфиденциальности сообщения или встречи в режиме создания.

setAsync(sensitivityLabel, callback)

Применяет указанную метку конфиденциальности к создаваемому сообщению или встрече.

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

Параметры

sensitivityLabel

string | Office.SensitivityLabelDetails

Метка конфиденциальности, применяемая к создаваемому сообщению или встрече. Значение параметра может быть уникальным идентификатором (GUID) метки конфиденциальности или объектом SensitivityLabelDetails .

callback

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

Необязательный параметр. После завершения метода функция, переданная в callback параметре, вызывается с одним параметром Office.AsyncResult , asyncResultкоторый является объектом .

Возвращаемое значение

void

Комментарии

[ Набор API: Почтовый ящик 1.13 ]

Минимальный уровень разрешений: чтение и запись элемента

Применимый режим Outlook: Создание

Важно! Чтобы использовать функцию метки конфиденциальности в надстройке, у вас должна быть подписка Microsoft 365 E5.

Совет. Чтобы определить метки конфиденциальности, доступные для использования, вызовите Office.context.sensitivityLabelsCatalog.getAsync метод .

Дополнительные сведения об управлении метками конфиденциальности в надстройке см. в статье Управление метками конфиденциальности сообщения или встречи в режиме создания.

Примеры

// 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);
  }
});