Office.SensitivityLabelsCatalog interface
Предоставляет методы для проверка состояния каталога меток конфиденциальности в Outlook и получения всех доступных меток конфиденциальности, если каталог включен.
Комментарии
[ Набор API: Почтовый ящик 1.13 ]
Минимальный уровень разрешений: чтение и запись элемента
Применимый режим Outlook: Compose
Важно! Чтобы использовать функцию метки конфиденциальности в надстройке, у вас должна быть Microsoft 365 E5 подписка.
Дополнительные сведения об управлении метками конфиденциальности в надстройке см. в статье Управление метками конфиденциальности сообщения или встречи в режиме создания.
Методы
get |
Возвращает все метки конфиденциальности, включенные в Outlook. |
get |
Возвращает все метки конфиденциальности, включенные в Outlook. |
get |
Проверяет, включен ли каталог меток конфиденциальности в Outlook. |
get |
Проверяет, включен ли каталог меток конфиденциальности в Outlook. |
Сведения о методе
getAsync(options, callback)
Возвращает все метки конфиденциальности, включенные в Outlook.
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SensitivityLabelDetails[]>) => void): void;
Параметры
- options
- Office.AsyncContextOptions
Литерал объекта, содержащий одно или несколько следующих свойств:- asyncContext
: разработчики могут предоставить любой объект, к которому они хотят получить доступ в функции обратного вызова.
- callback
-
(asyncResult: Office.AsyncResult<Office.SensitivityLabelDetails[]>) => void
После завершения метода функция, переданная в callback
параметре, вызывается с одним параметром Office.AsyncResult
, asyncResult
который является объектом . Доступные метки конфиденциальности и их свойства возвращаются в свойстве asyncResult.value
.
Возвращаемое значение
void
Комментарии
[ Набор API: Почтовый ящик 1.13 ]
Минимальный уровень разрешений: чтение и запись элемента
Применимый режим Outlook: Compose
Важно! Чтобы использовать функцию метки конфиденциальности в надстройке, у вас должна быть Microsoft 365 E5 подписка.
Рекомендуется. Чтобы определить, включен ли каталог меток конфиденциальности в Outlook, вызовите getIsEnabledAsync
перед использованием getAsync
.
Дополнительные сведения об управлении метками конфиденциальности в надстройке см. в статье Управление метками конфиденциальности сообщения или встречи в режиме создания.
getAsync(callback)
Возвращает все метки конфиденциальности, включенные в Outlook.
getAsync(callback: (asyncResult: Office.AsyncResult<SensitivityLabelDetails[]>) => void): void;
Параметры
- callback
-
(asyncResult: Office.AsyncResult<Office.SensitivityLabelDetails[]>) => void
После завершения метода функция, переданная в callback
параметре, вызывается с одним параметром Office.AsyncResult
, asyncResult
который является объектом . Доступные метки конфиденциальности и их свойства возвращаются в свойстве asyncResult.value
.
Возвращаемое значение
void
Комментарии
[ Набор API: Почтовый ящик 1.13 ]
Минимальный уровень разрешений: чтение и запись элемента
Применимый режим Outlook: Compose
Важно! Чтобы использовать функцию метки конфиденциальности в надстройке, у вас должна быть Microsoft 365 E5 подписка.
Рекомендуется. Чтобы определить, включен ли каталог меток конфиденциальности в Outlook, вызовите getIsEnabledAsync
перед использованием getAsync
.
Дополнительные сведения об управлении метками конфиденциальности в надстройке см. в статье Управление метками конфиденциальности сообщения или встречи в режиме создания.
Примеры
// 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)
Проверяет, включен ли каталог меток конфиденциальности в Outlook.
getIsEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;
Параметры
- options
- Office.AsyncContextOptions
Литерал объекта, содержащий одно или несколько следующих свойств:- asyncContext
: разработчики могут предоставить любой объект, к которому они хотят получить доступ в функции обратного вызова.
- callback
-
(asyncResult: Office.AsyncResult<boolean>) => void
После завершения метода функция, переданная в callback
параметре, вызывается с одним параметром Office.AsyncResult
, asyncResult
который является объектом . Состояние каталога меток конфиденциальности возвращается в свойстве asyncResult.value
.
Возвращаемое значение
void
Комментарии
[ Набор API: Почтовый ящик 1.13 ]
Минимальный уровень разрешений: чтение и запись элемента
Применимый режим Outlook: Compose
Важно! Каталог меток конфиденциальности настраивается администратором организации. Дополнительные сведения см. в статье Начало работы с метками конфиденциальности.
Важно! Чтобы использовать функцию метки конфиденциальности в надстройке, у вас должна быть Microsoft 365 E5 подписка.
Дополнительные сведения об управлении метками конфиденциальности в надстройке см. в статье Управление метками конфиденциальности сообщения или встречи в режиме создания.
getIsEnabledAsync(callback)
Проверяет, включен ли каталог меток конфиденциальности в Outlook.
getIsEnabledAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;
Параметры
- callback
-
(asyncResult: Office.AsyncResult<boolean>) => void
После завершения метода функция, переданная в callback
параметре, вызывается с одним параметром Office.AsyncResult
, asyncResult
который является объектом . Состояние каталога меток конфиденциальности возвращается в свойстве asyncResult.value
.
Возвращаемое значение
void
Комментарии
[ Набор API: Почтовый ящик 1.13 ]
Минимальный уровень разрешений: чтение и запись элемента
Применимый режим Outlook: Compose
Важно! Каталог меток конфиденциальности настраивается администратором организации. Дополнительные сведения см. в статье Начало работы с метками конфиденциальности.
Важно! Чтобы использовать функцию метки конфиденциальности в надстройке, у вас должна быть Microsoft 365 E5 подписка.
Дополнительные сведения об управлении метками конфиденциальности в надстройке см. в статье Управление метками конфиденциальности сообщения или встречи в режиме создания.
Примеры
// 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);
}
});
Office Add-ins