class ProtectionEngine

Управляет действиями, связанными с защитой, связанными с определенным удостоверением.

Итоги

Участники Descriptions
public const Параметры& Get Параметры() const Возвращает параметры обработчика.
public std::shared_ptr AsyncControl> GetTemplatesAsync(const std::shared_ptr<<ProtectionEngine::Observer>& observer, const std::shared_ptr void>&context, const std::shared_ptr<<const GetTemplates Параметры>&template Параметры) Получение коллекции шаблонов, доступных пользователю.
public std::shared_ptr AsyncControl> GetTemplatesAsync(const std:::<shared_ptr<ProtectionEngine::Observer>&observer, const std::shared_ptr<void>&context) Получение коллекции шаблонов, доступных пользователю.
public std::vector<std:::shared_ptr<TemplateDescriptor>> GetTemplates(const std::shared_ptr<void>&context, const std::shared_ptr<const GetTemplates Параметры>&template Параметры) Получение коллекции шаблонов, доступных пользователю.
public std::vector<std::shared_ptr TemplateDescriptor>> GetTemplates(const std::shared_ptr<<void>&context) Получение коллекции шаблонов, доступных пользователю.
public bool IsFeatureSupported(FeatureId featureId) Проверка поддерживается.
public std::shared_ptr AsyncControl> GetRightsForLabelIdAsync(const std::string&documentId, const std::string& labelId, const std::string&ownerEmail, const std::string& delegatedUserEmail, const std::shared_ptr<ProtectionEngine::Observer>& observer, const std::shared_ptr<void>&context, const ProtectionCommon Параметры><параметры) Получение коллекции прав, доступных пользователю для идентификатора метки.
public std::vector<std::string> GetRightsForLabelId(const std::string& documentId, const std::string& labelId, const std::string&ownerEmail, const std::string& delegatedUserEmail, const std::shared_ptr<void>&context, const ProtectionCommon Параметры&settings) Получение коллекции прав, доступных пользователю для labelId.
public std::shared_ptr AsyncControl CreateProtectionHandlerForPublishingAsync(const ProtectionHandler::P<ublishing Параметры>, const std::shared_ptr ProtectionHandler::Observer>& observer, const std::shared_ptr<<void>&context)> Создает обработчик защиты, где права и роли назначаются определенным пользователям.
public std::shared_ptr ProtectionHandler CreateProtectionHandlerForPublishing(const ProtectionHandler>::P<ublishing Параметры>, const std::shared_ptr<void>&context) Создает обработчик защиты, где права и роли назначаются определенным пользователям.
public std::shared_ptr AsyncControl CreateProtectionHandlerForConsumptionAsync(const ProtectionHandler::Consumption Параметры& settings, const std::shared_ptr ProtectionHandler::Observer>& observer, const std::shared_ptr<<void>&context)>< Создает обработчик защиты, где права и роли назначаются определенным пользователям.
public std::shared_ptr<ProtectionHandler CreateProtectionHandlerForConsumption(const ProtectionHandler>::Consumption Параметры& settings, const std::shared_ptr<void>&context) Создает обработчик защиты, где права и роли назначаются определенным пользователям.
public bool LoadUserCert(const std::shared_ptr<void>&context, const ProtectionCommon Параметры> settings) Предварительная загрузка сертификата лицензиара пользователя, полезного при фоновой загрузке с помощью prelicense, может привести к дополнительному сетевому вызову.
public std::shared_ptr AsyncControl> LoadUserCertAsync(const std::shared_ptr<<ProtectionEngine::Observer>& observer, const std::shared_ptr<void>&context, const ProtectionCommon Параметры& settings) Предварительная загрузка сертификата лицензиара пользователя, полезного при фоновой загрузке с помощью prelicense, может привести к дополнительному сетевому вызову.
public void RegisterContentForTrackingAndRevocation(const std::vector<uint8_t>&serializedPublishingLicense, const std::string&contentName, bool isOwnerNotificationEnabled, const std::shared_ptr<void>&context, const ProtectionCommon Параметры> settings) Регистрация лицензии публикации (PL) для отслеживания документов и отзыва.
public std::shared_ptr AsyncControl RegisterContentForTrackingAndRevocationAsync(const std::vector<uint8_t>& serializedPublishingLicense, const std::string& contentName, bool isOwnerNotificationEnabled, const std::shared_ptr<ProtectionEngine::Observer>& observer, const std::shared_ptr<void>&context, const ProtectionCommon Параметры&settings>)< Регистрация лицензии публикации (PL) для отслеживания документов и отзыва.
public void RevokeContent(const std::vector<uint8_t>& serializedPublishingLicense, const std::shared_ptr<void>&context, const ProtectionCommon Параметры& settings) Выполните отзыв для содержимого.
public std::shared_ptr<AsyncControl> RevokeContentAsync(const std::vector<uint8_t>&serializedPublishingLicense, const std::shared_ptr ProtectionEngine::Observer>& observer, const std::shared_ptr<<void>&context, const ProtectionCommon Параметры> Выполните отзыв для содержимого.
public std::vector<std:::shared_ptr DelegationLicense CreateDelegationLicenses(const DelegationLicense>> Параметры& settings, const std::shared_ptr<<void>&context) Создает делегированную лицензию.
public std::shared_ptr AsyncControl CreateDelegationLicensesAsync(const DelegationLicense Параметры& settings, const std::shared_ptr ProtectionEngine::Observer>& observer, const std::shared_ptr<<void>&context)>< Создает делегированную лицензию.
public std::shared_ptr TenantInformation GetTenantInformation>(const ProtectionCommon Параметры>, const std::shared_ptr<<void>&context) Загружает сертификат лицензиара пользователя и возвращает сведения о клиенте.
public std::shared_ptr AsyncControl> GetTenantInformationAsync(const ProtectionCommon Параметры>, const std::shared_ptr<ProtectionEngine::Observer>& observer, const std::shared_ptr<<void>&context) Загружает сертификат лицензиара пользователя и возвращает сведения о клиенте.
public std::shared_ptr<LicenseRightsData GetLicenseRightsData>(const std::vector<uint8_t>& serializedPublishingLicense, const std::shared_ptr<void>&context, const ProtectionCommon Параметры& settings) Получение данных о правах лицензии.
public std::shared_ptr<AsyncControl> GetLicenseRightsDataAsync(const std::vector<uint8_t>& serializedPublishingLicense, const std::shared_ptr<ProtectionEngine::Observer>& observer, const std::shared_ptr<void>&context, const ProtectionCommon Параметры&settings) Получение данных о правах лицензии.

Участники

Функция Get Параметры

Возвращает параметры обработчика.

Возвращается: параметры ядра

Функция GetTemplatesAsync

Получение коллекции шаблонов, доступных пользователю.

Параметры:

  • наблюдатель: класс, реализующий интерфейс ProtectionEngine::Observer

  • контекст клиента, который будет непрозрачно передан наблюдателям и необязательным HttpDelegate

  • template Параметры: Параметры использовать при получении шаблонов

Возвращает: объект элемента управления Async.

Функция GetTemplatesAsync

Получение коллекции шаблонов, доступных пользователю.

Параметры:

  • наблюдатель: класс, реализующий интерфейс ProtectionEngine::Observer

  • контекст клиента, который будет непрозрачно передан наблюдателям и необязательным HttpDelegate

Возвращает: объект элемента управления Async.

Функция GetTemplates

Получение коллекции шаблонов, доступных пользователю.

Параметры:

  • контекст клиента, который будет непрозрачно передан в необязательный httpDelegate

  • template Параметры: Параметры использовать при получении шаблонов

Возвращается: список идентификаторов шаблонов

Функция GetTemplates

Получение коллекции шаблонов, доступных пользователю.

Параметры:

  • контекст клиента, который будет непрозрачно передан в необязательный httpDelegate

Возвращается: список идентификаторов шаблонов

Функция IsFeatureSupported

Проверка поддерживается.

Параметры:

  • featureId: идентификатор компонента для проверка

Возвращает: логический результат

Функция GetRightsForLabelIdAsync

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

Параметры:

  • documentId: идентификатор документа, связанный с метаданными документа

  • labelId: идентификатор метки, связанный с метаданными документа, с помощью которых был создан документ

  • ownerEmail: владелец документа

  • Ответ. Делегированный пользователь указывается, когда проверка подлинности пользователя или приложения действует от имени другого пользователя, пуста, если нет.

  • наблюдатель: класс, реализующий интерфейс ProtectionEngine::Observer

  • контекст: этот же контекст будет переадресован в ProtectionEngine::Observer::OnGetRightsForLabelIdSuccess или ProtectionEngine::Observer::OnGetRightsForLabelIdFailure

Возвращает: объект элемента управления Async.

Функция GetRightsForLabelId

Получение коллекции прав, доступных пользователю для labelId.

Параметры:

  • documentId: идентификатор документа, связанный с метаданными документа

  • labelId: идентификатор метки, связанный с метаданными документа, с помощью которых был создан документ

  • ownerEmail: владелец документа

  • Ответ. Делегированный пользователь указывается, когда проверка подлинности пользователя или приложения действует от имени другого пользователя, пуста, если нет.

  • контекст: этот же контекст будет перенаправлен в необязательный httpDelegate

Возвращается: список прав

Функция CreateProtectionHandlerForPublishingAsync

Создает обработчик защиты, где права и роли назначаются определенным пользователям.

Параметры:

  • параметры: параметры защиты

  • наблюдатель: класс, реализующий интерфейс ProtectionHandler::Observer

  • контекст клиента, который будет непрозрачно пересылаться наблюдателям и необязательным HttpDelegate

Возвращает: объект элемента управления Async. Если параметры находятся только в автономном режиме, подсистеме необходимо ранее вызвать GetTemplatesAsync и LoadUserCertAsync.

Функция CreateProtectionHandlerForPublishing

Создает обработчик защиты, где права и роли назначаются определенным пользователям.

Параметры:

  • параметры: параметры защиты

  • контекст клиента, который будет непрозрачно перенаправлен в необязательный HttpDelegate

Возвращает: ProtectionHandler, если параметры находятся только в автономном режиме, подсистема должна ранее называтьСя GetTemplates и LoadUserCert

Функция CreateProtectionHandlerForConsumptionAsync

Создает обработчик защиты, где права и роли назначаются определенным пользователям.

Параметры:

  • параметры: параметры защиты

  • наблюдатель: класс, реализующий интерфейс ProtectionHandler::Observer

  • контекст клиента, который будет непрозрачно пересылаться наблюдателям и необязательным HttpDelegate

Возвращает: объект элемента управления Async.

Функция CreateProtectionHandlerForConsumption

Создает обработчик защиты, где права и роли назначаются определенным пользователям.

Параметры:

  • параметры: параметры защиты

  • контекст клиента, который будет непрозрачно перенаправлен в необязательный HttpDelegate

Возвращает: ProtectionHandler

Функция LoadUserCert

Предварительная загрузка сертификата лицензиара пользователя, полезного при фоновой загрузке с помощью prelicense, может привести к дополнительному сетевому вызову.

Параметры:

  • контекст клиента, который будет непрозрачно перенаправлен в необязательный HttpDelegate

Возвращает: значение True, если загружено успешно значение false.

Функция LoadUserCertAsync

Предварительная загрузка сертификата лицензиара пользователя, полезного при фоновой загрузке с помощью prelicense, может привести к дополнительному сетевому вызову.

Параметры:

  • наблюдатель: класс, реализующий интерфейс ProtectionHandler::Observer

  • контекст клиента, который будет непрозрачно пересылаться наблюдателям и необязательным HttpDelegate

Возвращает: объект элемента управления Async.

Функция RegisterContentForTrackingAndRevocation

Регистрация лицензии публикации (PL) для отслеживания документов и отзыва.

Параметры:

  • contentName: имя, связанное с содержимым, указанным сериализованнымPublishingLicense. Если сериализованныйPublishingLicense указывает имя содержимого, это значение будет иметь приоритет.

  • isOwnerNotificationEnabled: установите значение true, чтобы уведомить владельца по электронной почте при расшифровке документа или false, чтобы не отправлять уведомление.

  • контекст клиента, который будет непрозрачно перенаправлен в необязательный HttpDelegate

Функция RegisterContentForTrackingAndRevocationAsync

Регистрация лицензии публикации (PL) для отслеживания документов и отзыва.

Параметры:

  • serializedPublishingLicense: сериализованная лицензия на публикацию из защищенного содержимого

  • contentName: имя, связанное с содержимым, указанным сериализованнымPublishingLicense. Если сериализованныйPublishingLicense указывает имя содержимого, это значение будет иметь приоритет

  • isOwnerNotificationEnabled: установите значение true, чтобы уведомить владельца по электронной почте при расшифровке документа или false, чтобы не отправлять уведомление.

  • наблюдатель: класс, реализующий интерфейс ProtectionHandler::Observer

  • контекст клиента, который будет непрозрачно пересылаться наблюдателям и необязательным HttpDelegate

Возвращает: объект элемента управления Async.

Функция RevokeContent

Выполните отзыв для содержимого.

Параметры:

  • serializedPublishingLicense: сериализованная лицензия на публикацию из защищенного содержимого

  • контекст клиента, который будет непрозрачно перенаправлен в необязательный HttpDelegate

Функция RevokeContentAsync

Выполните отзыв для содержимого.

Параметры:

  • serializedPublishingLicense: сериализованная лицензия на публикацию из защищенного содержимого

  • наблюдатель: класс, реализующий интерфейс ProtectionHandler::Observer

  • контекст клиента, который будет непрозрачно пересылаться наблюдателям и необязательным HttpDelegate

Возвращает: объект элемента управления Async.

Функция CreateDelegationLicenses

Создает делегированную лицензию.

Параметры:

  • параметры: параметры делегирования

  • контекст клиента, который будет непрозрачно пересылаться наблюдателям и необязательным HttpDelegate

Возвращает: вектор лицензий делегирования с помощью этого метода для создания лицензий для списка пользователей

Функция CreateDelegationLicensesAsync

Создает делегированную лицензию.

Параметры:

  • параметры: параметры делегирования

  • наблюдатель: класс, реализующий интерфейс ProtectionHandler::Observer

  • контекст клиента, который будет непрозрачно пересылаться наблюдателям и необязательным HttpDelegate

Возвращает: объект элемента управления Async. Используйте этот метод для создания лицензий для списка пользователей. Получение вектора Делегирования в обратном вызове OnCreateDelegatedLicensesSuccess Failures отправляются в OnCreateDelegatedLicensesFailure

Функция GetTenantInformation

Загружает сертификат лицензиара пользователя и возвращает сведения о клиенте.

Параметры:

  • параметры: общие параметры

  • контекст клиента, который будет непрозрачно перенаправлен в необязательный HttpDelegate

Возвращается: TenantInformation

Функция GetTenantInformationAsync

Загружает сертификат лицензиара пользователя и возвращает сведения о клиенте.

Параметры:

  • параметры: общие параметры

  • наблюдатель: класс, реализующий интерфейс ProtectionHandler::Observer

  • контекст клиента, который будет непрозрачно пересылаться наблюдателям и необязательным HttpDelegate

Возвращает: объект элемента управления Async.

  • ProtectionEngine::Observer::OnGetTenantInformationAsyncSuccess будет вызываться для успешного вызова ProtectionEngine::Observer::OnGetTenantInformationAsyncFailure будет вызываться при сбое

Функция GetLicenseRightsData

Получение данных о правах лицензии.

Параметры:

  • serializedPublishingLicense: сериализованная лицензия на публикацию из защищенного содержимого

  • контекст клиента, который будет непрозрачно перенаправлен в необязательный HttpDelegate

  • параметры: общие параметры

Возвращается: данные о правах лицензии

Функция GetLicenseRightsDataAsync

Получение данных о правах лицензии.

Параметры:

  • serializedPublishingLicense: сериализованная лицензия на публикацию из защищенного содержимого

  • наблюдатель: класс, реализующий интерфейс ProtectionHandler::Observer

  • контекст клиента, который будет непрозрачно пересылаться наблюдателям и необязательным HttpDelegate

  • параметры: общие параметры

Возвращает: объект элемента управления Async.