class ProtectionEngine

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

摘要

成员 说明
public const 设置 & GetSettings () const 获取引擎设置。
public std::shared_ptr < AsyncControl > GetTemplatesAsync (const std::shared_ptr < ProtectionEngine::Observer >& 观察者,const std::shared_ptr < void >& 上下文) 获取可供用户使用的模板集合。
public std::vector < std::shared_ptr < TemplateDescriptor >> GetTemplates (const std::shared_ptr < void >& context, const std::shared_ptr < const GetTemplatesSettings >& templateSettings) 获取可供用户使用的模板集合。
public std::shared_ptr < AsyncControl > GetTemplatesAsync (const std::shared_ptr < ProtectionEngine::Observer >& 观察者,const std::shared_ptr void <>& 上下文,const std::shared_ptr < const GetTemplatesSettings >& templateSettings) 获取可供用户使用的模板集合。
public std::vector < std::shared_ptr < TemplateDescriptor >> GetTemplates (const std::shared_ptr < void >& 上下文) 获取可供用户使用的模板集合。
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 >& 观察者, const std::shared_ptr < void >& 上下文, const ProtectionCommonSettings & 设置) 获取可用于标签 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 ProtectionCommonSettings & settings) 获取可用于 labelId 的用户权限集合。
public < std::shared_ptr AsyncControl > CreateProtectionHandlerForPublishingAsync (const ProtectionHandler::P ublishingSettings & 设置, const std::shared_ptr < ProtectionHandler::Observer >& 观察者, const std::shared_ptr < void 上下文 >&) 创建一个保护处理程序,将权限/角色分配给特定用户。
public std::shared_ptr < ProtectionHandler > CreateProtectionHandlerForPublishing (const ProtectionHandler::P ublishingSettings & 设置, const std::shared_ptr < void >& 上下文) 创建一个保护处理程序,将权限/角色分配给特定用户。
public std::shared_ptr < AsyncControl > CreateProtectionHandlerForConsumptionAsync (const ProtectionHandler::ConsumptionSettings & 设置, const std::shared_ptr < ProtectionHandler::Observer >& 观察者, const std::shared_ptr < void 上下文 >&) 创建一个保护处理程序,将权限/角色分配给特定用户。
public std::shared_ptr < ProtectionHandler > CreateProtectionHandlerForConsumption (const ProtectionHandler::ConsumptionSettings & 设置, const std::shared_ptr < void >& 上下文) 创建一个保护处理程序,将权限/角色分配给特定用户。
public bool LoadUserCert (const std::shared_ptr < void >& 上下文,const ProtectionCommonSettings & 设置) 预先加载用户许可方证书,当后台加载其他使用预授权时,可能会产生额外的网络调用时很有用。
public std::shared_ptr < AsyncControl > LoadUserCertAsync (const std::shared_ptr < ProtectionEngine::Observer >& 观察者,const std::shared_ptr void <>& 上下文,const ProtectionCommonSettings & 设置) 预先加载用户许可方证书,当后台加载其他使用预授权时,可能会产生额外的网络调用时很有用。
public void RegisterContentForTrackingAndRevocation (const std::vector < uint8_t >& serializedPublishingLicense, const std::string & contentName, bool isOwnerNotificationEnabled, const std::shared_ptr < void >& 上下文, const ProtectionCommonSettings & 设置) 注册发布许可证 (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 >& 观察者, const std::shared_ptr < void >& 上下文, const ProtectionCommonSettings & 设置) 注册发布许可证 (PL) 文档跟踪 & 吊销。
public void RevokeContent (const std::vector < uint8_t >& serializedPublishingLicense, const std::shared_ptr < void >& 上下文, const ProtectionCommonSettings & 设置) 对内容执行吊销。
public std::shared_ptr < AsyncControl > RevokeContentAsync (const std::vector < uint8_t >& serializedPublishingLicense, const std::shared_ptr < ProtectionEngine::Observer >& 观察者, const std::shared_ptr < void >& 上下文, const ProtectionCommonSettings 设置 &) 对内容执行吊销。
public std::vector < std::shared_ptr <>> DelegationLicense CreateDelegationLicenses (const DelegationLicenseSettings & 设置,const std::shared_ptr < void >& 上下文) 创建委托的许可证。
public std::shared_ptr < AsyncControl > CreateDelegationLicensesAsync (const DelegationLicenseSettings & 设置, const std::shared_ptr < ProtectionEngine::Observer >& 观察者, const std::shared_ptr < void >& 上下文) 创建委托的许可证。

成员

GetSettings 函数

获取引擎设置。

返回:引擎设置

GetTemplatesAsync 函数

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

参数:

  • 观察者:实现 ProtectionEngine::Observer 接口的类

  • 上下文:将不透明传递回执行组件和可选 HttpDelegate 的客户端上下文

返回:异步控件对象。

GetTemplates 函数

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

参数:

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

  • templateSettings:设置模板时使用

返回:模板 ID 列表

GetTemplatesAsync 函数

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

参数:

  • 观察者:实现 ProtectionEngine::Observer 接口的类

  • 上下文:将不透明传递回执行组件和可选 HttpDelegate 的客户端上下文

  • templateSettings:设置模板时使用

返回:异步控件对象。

GetTemplates 函数

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

参数:

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

返回:模板 ID 列表

IsFeatureSupported 函数

"检查"功能受支持。

参数:

  • featureId:要检查的功能的 ID

返回:布尔结果

GetRightsForLabelIdAsync 函数

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

参数:

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

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

  • ownerEmail:文档的所有者

  • 当身份验证用户/应用程序代表其他用户操作时指定委托用户,如果没有,则为空

  • 观察者:实现 ProtectionEngine::Observer 接口的类

  • 上下文:此相同的上下文将转发到 ProtectionEngine::Observer::OnGetRightsForLabelIdSuccess 或 [ProtectionEngine::Observer::OnGetRightsForLabelIdFailure

返回:异步控件对象。

GetRightsForLabelId 函数

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

参数:

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

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

  • ownerEmail:文档的所有者

  • 当身份验证用户/应用程序代表其他用户操作时指定委托用户,如果没有,则为空

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

返回:权限列表

CreateProtectionHandlerForPublishingAsync 函数

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

参数:

  • 设置:保护设置

  • 观察者:实现 ProtectionHandler::Observer 接口的类

  • context:将不透明转发给执行组件和可选 HttpDelegate 的客户端上下文

返回:异步控件对象。

CreateProtectionHandlerForPublishing 函数

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

参数:

  • 设置:保护设置

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

返回:ProtectionHandler

CreateProtectionHandlerForConsumptionAsync 函数

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

参数:

  • 设置:保护设置

  • 观察者:实现 ProtectionHandler::Observer 接口的类

  • context:将不透明转发给执行组件和可选 HttpDelegate 的客户端上下文

返回:异步控件对象。

CreateProtectionHandlerForConsumption 函数

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

参数:

  • 设置:保护设置

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

返回:ProtectionHandler

LoadUserCert 函数

预先加载用户许可方证书,当后台加载其他使用预授权时,可能会产生额外的网络调用时很有用。

参数:

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

如果加载成功,则返回 :True,否则返回 false。

LoadUserCertAsync 函数

预先加载用户许可方证书,当后台加载其他使用预授权时,可能会产生额外的网络调用时很有用。

参数:

  • 观察者:实现 ProtectionHandler::Observer 接口的类

  • context:将不透明转发给执行组件和可选 HttpDelegate 的客户端上下文

返回:异步控件对象。

RegisterContentForTrackingAndRevocation 函数

注册发布许可证 (PL) 文档跟踪 & 吊销。

参数:

  • contentName:与 serializedPublishingLicense 指定的内容关联的名称。 如果 serializedPublishingLicense 指定了内容名称,该值将优先。

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

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

RegisterContentForTrackingAndRevocationAsync 函数

注册发布许可证 (PL) 文档跟踪 & 吊销。

参数:

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

  • contentName:与 serializedPublishingLicense 指定的内容关联的名称。 如果 serializedPublishingLicense 指定了内容名称,该值将优先

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

  • 观察者:实现 ProtectionHandler::Observer 接口的类

  • context:将不透明转发给执行组件和可选 HttpDelegate 的客户端上下文

返回:异步控件对象。

RevokeContent 函数

对内容执行吊销。

参数:

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

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

RevokeContentAsync 函数

对内容执行吊销。

参数:

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

  • 观察者:实现 ProtectionHandler::Observer 接口的类

  • context:将不透明转发给执行组件和可选 HttpDelegate 的客户端上下文

返回:异步控件对象。

CreateDelegationLicenses 函数

创建委托的许可证。

参数:

  • 设置:委派设置

  • context:将不透明转发给执行组件和可选 HttpDelegate 的客户端上下文

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

CreateDelegationLicensesAsync 函数

创建委托的许可证。

参数:

  • 设置:委派设置

  • 观察者:实现 ProtectionHandler::Observer 接口的类

  • context:将不透明转发给执行组件和可选 HttpDelegate 的客户端上下文

返回:异步控件对象。 使用此方法为用户列表创建许可证。 在 OnCreateDelegatedLicensesSuccess Failures Failures in OnCreateDelegatedLicensesFailure 中接收回调中的 DelegationLicense 向量