类 ProtectionEngine

  • 项目

管理与特定标识相关的保护操作。

总结

成员 说明
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设置&<settings） 获取用户可用于标签 ID 的权限集合。
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设置& settings， const std：：shared_ptr<ProtectionHandler：：Observer>& observer， const std：：shared_ptr<void>& context）< 创建一个保护处理程序，其中将权限/角色分配给特定用户。
public std：：shared_ptr<ProtectionHandler CreateProtectionHandlerForPublishing>（const ProtectionHandler：:P ublishing设置& settings， 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） 抢先加载用户许可方证书，在后台加载其他使用预许可证可能会导致额外的网络调用时很有用。
public std：：shared_ptr<AsyncControl> LoadUserCertAsync（const std：：shared_ptr<ProtectionEngine：：Observer>& observer， const std：：shared_ptr<void>& context， const ProtectionCommon设置& settings） 抢先加载用户许可方证书，在后台加载其他使用预许可证可能会导致额外的网络调用时很有用。
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设置& settings） 对内容执行吊销。
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设置& settings， const std：：shared_ptr<void>& context） 加载用户许可证书并返回有关租户的信息。
public std：：shared_ptr<AsyncControl> GetTenantInformationAsync（const ProtectionCommon设置& settings， 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） 获取许可证权限数据。

成员

GetSettings 函数

获取引擎设置。

返回：引擎设置

GetTemplatesAsync 函数

获取可供用户使用的模板集合。

参数：

  • observer：实现 ProtectionEngine：：Observer 接口的类

  • context：将不透明地传回观察者和可选的 HttpDelegate 的客户端上下文

  • templateSettings：获取模板时使用的设置

返回结果：异步控制对象。

GetTemplatesAsync 函数

获取可供用户使用的模板集合。

参数：

  • observer：实现 ProtectionEngine：：Observer 接口的类

  • context：将不透明地传回观察者和可选的 HttpDelegate 的客户端上下文

返回结果：异步控制对象。

GetTemplates 函数

获取可供用户使用的模板集合。

参数：

  • context：将不透明地传递给可选 HttpDelegate 的客户端上下文

  • templateSettings：获取模板时使用的设置

返回：模板 ID 列表

GetTemplates 函数

获取可供用户使用的模板集合。

参数：

  • context：将不透明地传递给可选 HttpDelegate 的客户端上下文

返回：模板 ID 列表

IsFeatureSupported 函数

检查是否支持功能。

参数：

  • featureId：要检查的功能的 ID

返回结果：布尔结果

GetRightsForLabelIdAsync 函数

获取用户可用于标签 ID 的权限集合。

参数：

  • documentId：与文档元数据关联的文档 ID

  • labelId：与创建文档的文档元数据关联的标签 ID

  • ownerEmail：文档的所有者

  • A：当身份验证用户/应用程序代表另一个用户进行操作时，指定委托用户，如果没有则为空

  • observer：实现 ProtectionEngine：：Observer 接口的类

  • context：同一上下文将转发到 ProtectionEngine：：Observer：：OnGetRightsForLabelIdSuccess 或 ProtectionEngine：：Observer：：OnGetRightsForLabelIdFailure

返回结果：异步控制对象。

GetRightsForLabelId 函数

获取用户对 labelId 可用的权限集合。

参数：

  • documentId：与文档元数据关联的文档 ID

  • labelId：与创建文档的文档元数据关联的标签 ID

  • ownerEmail：文档的所有者

  • A：当身份验证用户/应用程序代表另一个用户进行操作时，指定委托用户，如果没有则为空

  • context：此相同上下文将转发到可选的 HttpDelegate

返回：权限列表

CreateProtectionHandlerForPublishingAsync 函数

创建一个保护处理程序，其中将权限/角色分配给特定用户。

参数：

  • settings：保护设置

  • observer：实现 ProtectionHandler：：Observer 接口的类

  • context：将不透明地转发给观察者和可选 HttpDelegate 的客户端上下文

返回结果：异步控制对象。 如果设置仅脱机，引擎需要以前称为 GetTemplatesAsync 和 LoadUserCertAsync

CreateProtectionHandlerForPublishing 函数

创建一个保护处理程序，其中将权限/角色分配给特定用户。

参数:

  • settings：保护设置

  • context：将不透明地转发到可选 HttpDelegate 的客户端上下文

返回：ProtectionHandler 如果设置仅处于脱机状态，引擎需要以前称为 GetTemplates 和 LoadUserCert

CreateProtectionHandlerForConsumptionAsync 函数

创建一个保护处理程序，其中将权限/角色分配给特定用户。

参数:

  • settings：保护设置

  • observer：实现 ProtectionHandler：：Observer 接口的类

  • context：将不透明地转发给观察者和可选 HttpDelegate 的客户端上下文

返回结果：异步控制对象。

CreateProtectionHandlerForConsumption 函数

创建一个保护处理程序，其中将权限/角色分配给特定用户。

参数:

  • settings：保护设置

  • context：将不透明地转发到可选 HttpDelegate 的客户端上下文

返回结果：ProtectionHandler

LoadUserCert 函数

抢先加载用户许可方证书，在后台加载其他使用预许可证可能会导致额外的网络调用时很有用。

参数：

  • context：将不透明地转发到可选 HttpDelegate 的客户端上下文

返回结果：如果加载成功，则为 true，否则为 false。

LoadUserCertAsync 函数

抢先加载用户许可方证书，在后台加载其他使用预许可证可能会导致额外的网络调用时很有用。

参数:

  • observer：实现 ProtectionHandler：：Observer 接口的类

  • context：将不透明地转发给观察者和可选 HttpDelegate 的客户端上下文

返回结果：异步控制对象。

RegisterContentForTrackingAndRevocation 函数

注册发布许可证（PL），以便进行文档跟踪和吊销。

参数：

  • contentName：与 serializedPublishingLicense 指定的内容关联的名称。 如果 serializedPublishingLicense 指定内容名称，则该值优先。

  • isOwnerNotificationEnabled：设置为 true 以在文档被解密时通过电子邮件通知所有者，或设置为 false 以不发送通知。

  • context：将不透明地转发到可选 HttpDelegate 的客户端上下文

RegisterContentForTrackingAndRevocationAsync 函数

注册发布许可证（PL），以便进行文档跟踪和吊销。

参数：

  • serializedPublishingLicense：受保护内容的序列化发布许可证

  • contentName：与 serializedPublishingLicense 指定的内容关联的名称。 如果 serializedPublishingLicense 指定内容名称，则该值优先

  • isOwnerNotificationEnabled：设置为 true 以在文档被解密时通过电子邮件通知所有者，或设置为 false 以不发送通知。

  • observer：实现 ProtectionHandler：：Observer 接口的类

  • context：将不透明地转发给观察者和可选 HttpDelegate 的客户端上下文

返回结果：异步控制对象。

RevokeContent 函数

对内容执行吊销。

参数:

  • serializedPublishingLicense：受保护内容的序列化发布许可证

  • context：将不透明地转发到可选 HttpDelegate 的客户端上下文

RevokeContentAsync 函数

对内容执行吊销。

参数：

  • serializedPublishingLicense：受保护内容的序列化发布许可证

  • observer：实现 ProtectionHandler：：Observer 接口的类

  • context：将不透明地转发给观察者和可选 HttpDelegate 的客户端上下文

返回结果：异步控制对象。

CreateDelegationLicenses 函数

创建委托许可证。

参数：

  • settings：委派设置

  • context：将不透明地转发给观察者和可选 HttpDelegate 的客户端上下文

返回结果：委派许可证的向量。使用此方法为用户列表创建许可证

CreateDelegationLicensesAsync 函数

创建委托许可证。

参数：

  • settings：委派设置

  • observer：实现 ProtectionHandler：：Observer 接口的类

  • context：将不透明地转发给观察者和可选 HttpDelegate 的客户端上下文

返回结果：异步控制对象。 使用此方法为用户列表创建许可证。 在回调中接收 DelegationLicense 向量 OnCreateDelegatedLicensesSuccess 失败在 OnCreateDelegatedLicensesFailure 中发送

GetTenantInformation 函数

加载用户许可证书并返回有关租户的信息。

参数:

  • 设置：常见设置

  • context：将不透明地转发到可选 HttpDelegate 的客户端上下文

返回：TenantInformation

GetTenantInformationAsync 函数

加载用户许可证书并返回有关租户的信息。

参数：

  • 设置：常见设置

  • observer：实现 ProtectionHandler：：Observer 接口的类

  • context：将不透明地转发给观察者和可选 HttpDelegate 的客户端上下文

返回结果：异步控制对象。

  • ProtectionEngine：：Observer：：OnGetTenantInformationAsyncSuccess 将在失败时调用 Success ProtectionEngine：：Observer：：OnGetTenantInformationAsyncFailure

GetLicenseRightsData 函数

获取许可证权限数据。

参数:

  • serializedPublishingLicense：受保护内容的序列化发布许可证

  • context：将不透明地转发到可选 HttpDelegate 的客户端上下文

  • 设置：常见设置

返回：许可证权限数据

GetLicenseRightsDataAsync 函数

获取许可证权限数据。

参数：

  • serializedPublishingLicense：受保护内容的序列化发布许可证

  • observer：实现 ProtectionHandler：：Observer 接口的类

  • context：将不透明地转发给观察者和可选 HttpDelegate 的客户端上下文

  • 设置：常见设置

返回结果：异步控制对象。