Office.SensitivityLabel interface
Предоставляет методы для получения или настройки метки конфиденциальности сообщения или встречи. Дополнительные сведения о метках конфиденциальности см. в разделе Сведения о метках конфиденциальности.
Комментарии
Минимальный уровень разрешений: элемент для чтения и записи
Применимый режим Outlook: Compose
Важно! Чтобы использовать функцию меток конфиденциальности в надстройке, необходима подписка на Microsoft 365 E5.
Дополнительные сведения об управлении метками конфиденциальности в надстройке см. в разделе Управление меткой конфиденциальности сообщения или встречи в режиме создания.
Используется
Методы
| get |
Получает уникальный идентификатор (GUID) метки конфиденциальности, применяемой к составляемому сообщению или встрече. |
| get |
Получает уникальный идентификатор (GUID) метки конфиденциальности, применяемой к составляемому сообщению или встрече. |
| set |
Применяет указанную метку конфиденциальности к составляемому сообщению или встрече. |
| set |
Применяет указанную метку конфиденциальности к составляемому сообщению или встрече. |
Сведения о методе
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 , вызывается с единственным параметром, asyncResultкоторый является объектом Office.AsyncResult . GUID метки конфиденциальности возвращается в свойстве asyncResult.value .
Возвращаемое значение
void
Комментарии
Минимальный уровень разрешений: элемент для чтения и записи
Применимый режим Outlook: Compose
Важно! Чтобы использовать функцию меток конфиденциальности в надстройке, необходима подписка на Microsoft 365 E5.
Дополнительные сведения об управлении метками конфиденциальности в надстройке см. в разделе Управление меткой конфиденциальности сообщения или встречи в режиме создания.
getAsync(callback)
Получает уникальный идентификатор (GUID) метки конфиденциальности, применяемой к составляемому сообщению или встрече.
getAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
Параметры
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
Когда метод завершается, функция, переданная в параметре callback , вызывается с единственным параметром, asyncResultкоторый является объектом Office.AsyncResult . GUID метки конфиденциальности возвращается в свойстве asyncResult.value .
Возвращаемое значение
void
Комментарии
Минимальный уровень разрешений: элемент для чтения и записи
Применимый режим Outlook: Compose
Важно! Чтобы использовать функцию меток конфиденциальности в надстройке, необходима подписка на 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 , вызывается с единственным параметром, asyncResultкоторый является объектом Office.AsyncResult .
Возвращаемое значение
void
Комментарии
Минимальный уровень разрешений: элемент для чтения и записи
Применимый режим Outlook: Compose
Важно!
Чтобы использовать функцию меток конфиденциальности в надстройке, необходима подписка на Microsoft 365 E5.
Этот
setAsyncметод не поддерживается для сообщений, которые сейчас загружаются с помощью этогоloadItemByIdAsyncметода. Дополнительные сведения см. в статье "Активация надстройки Outlook для нескольких сообщений".
Совет. Чтобы определить, какие метки конфиденциальности доступны для использования, вызовите 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 , вызывается с единственным параметром, asyncResultкоторый является объектом Office.AsyncResult .
Возвращаемое значение
void
Комментарии
Минимальный уровень разрешений: элемент для чтения и записи
Применимый режим Outlook: Compose
Важно!
Чтобы использовать функцию меток конфиденциальности в надстройке, необходима подписка на Microsoft 365 E5.
Этот
setAsyncметод не поддерживается для сообщений, которые сейчас загружаются с помощью этогоloadItemByIdAsyncметода. Дополнительные сведения см. в статье "Активация надстройки Outlook для нескольких сообщений".
Совет. Чтобы определить, какие метки конфиденциальности доступны для использования, вызовите 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);
}
});