class FileEngine::设置

摘要

成员 说明
public 设置 (const std::string & engineId, const std::shared_ptr < AuthDelegate >& authDelegate, const std::string & clientData, const std::string & locale, bool loadSensitivityTypes) FileEngine::设置加载现有引擎的构造函数。
public 设置 (identity & identity, const std::shared_ptr < AuthDelegate >& authDelegate, const std::string & clientData, const std::string & locale, bool loadSensitivityTypes) FileProfile::设置用于创建新引擎的构造函数。
public const std::string & GetEngineId () const 返回引擎 ID。
public void SetEngineId (const std::string & id) 设置引擎 ID。
public const Identity & GetIdentity () const 返回引擎标识。
public void SetIdentity (const & Identity identity) 设置引擎标识。
public const std::string & GetClientData () const 返回引擎客户端数据。
public const std::string & GetLocale () const 返回引擎区域设置。
public void SetCustomSettings (const std::vector < std::p air < std::string, std::string >>& value) 设置用于测试和试验的名称/值对列表。
public const std::vector < std::p air < std::string, std::string >>& GetCustomSettings () const 获取用于测试和试验的名称/值对列表。
public void SetSessionId (const std::string & sessionId) 设置引擎会话 ID。
public const std::string & GetSessionId () const 返回引擎会话 ID。
public void SetCloud (Cloud Cloud) (可选)设置目标云。
public Cloud GetCloud () const 获取所有服务请求使用的目标云。
public void SetProtectionCloudEndpointBaseUrl (const std::string & protectionCloudEndpointBaseUrl) 设置自定义云的保护云终结点基 URL。
public const std::string & GetProtectionCloudEndpointBaseUrl () const 获取保护云终结点基 URL。
public void SetPolicyCloudEndpointBaseUrl (const std::string & policyCloudEndpointBaseUrl) 设置自定义云的策略云终结点基 URL。
public const std::string & GetPolicyCloudEndpointBaseUrl () const 获取策略云终结点基 URL。
public void SetProtectionOnlyEngine (bool protectionOnly) 设置仅保护引擎指示器 - 无策略/标签。
public const bool IsProtectionOnlyEngine () const 仅返回保护引擎指示器 - 无策略/标签。
public bool IsLoadSensitivityTypesEnabled () const 获取指示是否启用了负载敏感度标签的标志。
public void EnablePFile (bool 值) 设置指示是否生成 PFile 的标志。
public const bool IsPFileEnabled () 获取指示是否生成 PFile 的标志。
public void SetDelegatedUserEmail (const std::string & delegatedUserEmail) 设置委托的用户。
public const std::string & GetDelegatedUserEmail () const 获取委派的用户。
public void SetLabelFilter (const std::vector < LabelFilterType >& deprecatedLabelFilters) 设置标签筛选器。
public const std::vector < LabelFilterType >& GetLabelFilter () const 获取通过已弃用函数 SetLabelFilter 设置的标签筛选器。
public void ConfigureFunctionality (FunctionalityFilterType functionalityFilterType, bool enabled) 启用或禁用功能。
public const std::map < FunctionalityFilterType, bool >& GetConfiguredFunctionality () const 获取配置的功能。
public void SetAuthDelegate (const std::shared_ptr < AuthDelegate >& authDelegate) 设置引擎身份验证委托。
public std::shared_ptr < AuthDelegate > GetAuthDelegate () const 获取引擎身份验证委托。
public const std::shared_ptr < void >& GetLoggerContext () const 获取将不透明传递给与所创建引擎关联的日志的记录器委托的记录器上下文。
public void SetLoggerContext (const std::shared_ptr < void >& loggerContext) 设置记录器上下文,该上下文将不透明传递给与所创建引擎关联的日志的记录器委托。

成员

设置 函数

FileEngine::设置加载现有引擎的构造函数。

参数:

  • engineId:将其设置为 AddEngineAsync 生成的唯一引擎 ID。

  • authDelegate:SDK用于获取身份验证令牌的身份验证委托将覆盖 PolicyProfile::设置::authDelegate(如果两者均提供)

  • clientData:可在卸载时随引擎一起存储的可自定义客户端数据,可以从加载的引擎中检索。

  • 区域设置:将在此区域设置中提供引擎可本地化输出。

  • loadSensitivityTypes:可选标志,指示何时加载引擎还应加载自定义敏感度类型,如果在更新自定义敏感度类型以及策略更改时调用配置文件上的 true OnPolicyChange 观察者。 如果为 false,ListSensitivityTypes 调用将始终返回空列表。

设置 函数

FileProfile::设置用于创建新引擎的构造函数。

参数:

  • identity:与新引擎关联的用户的标识信息。

  • authDelegate:SDK用于获取身份验证令牌的身份验证委托将覆盖 PolicyProfile::设置::authDelegate(如果两者均提供)

  • clientData:可在卸载时随引擎一起存储的可自定义客户端数据,可以从加载的引擎中检索。

  • 区域设置:将在此区域设置中提供引擎可本地化输出。

  • loadSensitivityTypes:可选标志,指示何时加载引擎还应加载自定义敏感度类型,如果在更新自定义敏感度类型以及策略更改时调用配置文件上的 true OnPolicyChange 观察者。 如果为 false,ListSensitivityTypes 调用将始终返回空列表。

GetEngineId 函数

返回引擎 ID。

SetEngineId 函数

设置引擎 ID。

参数:

  • id:引擎 ID。

GetIdentity 函数

返回引擎标识。

SetIdentity 函数

设置引擎标识。

GetClientData 函数

返回引擎客户端数据。

GetLocale 函数

返回引擎区域设置。

SetCustomSettings 函数

设置用于测试和试验的名称/值对列表。

GetCustomSettings 函数

获取用于测试和试验的名称/值对列表。

SetSessionId 函数

设置引擎会话 ID。

GetSessionId 函数

返回引擎会话 ID。

SetCloud 函数

(可选)设置目标云。

参数:

  • :云

如果未指定云,则默认为全局云。

GetCloud 函数

获取所有服务请求使用的目标云。

返回:云

SetProtectionCloudEndpointBaseUrl 函数

设置自定义云的保护云终结点基 URL。

参数:

  • protectionCloudEndpointBaseUrl:与保护终结点关联的基 URL

此值将仅读取,并且必须为 Cloud = Custom 设置

GetProtectionCloudEndpointBaseUrl 函数

获取保护云终结点基 URL。

返回:与保护终结点关联的基 URL 此值将仅读取,并且必须为 Cloud = 自定义设置

SetPolicyCloudEndpointBaseUrl 函数

设置自定义云的策略云终结点基 URL。

参数:

  • policyCloudEndpointBaseUrl:与策略终结点关联的基 URL

GetPolicyCloudEndpointBaseUrl 函数

获取策略云终结点基 URL。

返回:与策略终结点关联的基 URL

SetProtectionOnlyEngine 函数

设置仅保护引擎指示器 - 无策略/标签。

IsProtectionOnlyEngine 函数

仅返回保护引擎指示器 - 无策略/标签。

IsLoadSensitivityTypesEnabled 函数

获取指示是否启用了负载敏感度标签的标志。

如果已启用 else false,则返回 :True。

EnablePFile 函数

设置指示是否生成 PFile 的标志。

IsPFileEnabled 函数

获取指示是否生成 PFile 的标志。

如果已启用 else false,则返回 :True。

SetDelegatedUserEmail 函数

设置委托的用户。

参数:

  • delegatedUserEmail:委派电子邮件。

当身份验证用户/应用程序代表其他用户操作时,指定委托用户

GetDelegatedUserEmail 函数

获取委派的用户。

返回:委托用户 当身份验证用户/应用程序代表其他用户操作时,指定委托用户

SetLabelFilter 函数

设置标签筛选器。

参数:

  • labelFilter:标签筛选器。

默认情况下,标签是范围筛选器,此 API 允许通过可能的操作进行筛选。 如果未设置 HyokProtection,则筛选 DoubleKeyProtection。

GetLabelFilter 函数

获取通过已弃用函数 SetLabelFilter 设置的标签筛选器。

返回:标签筛选器。 默认情况下,标签是范围筛选器,此 API 允许通过可能的操作进行筛选。

ConfigureFunctionality 函数

启用或禁用功能。

参数:

  • functionalityFilterType:功能的类型。

  • enabled:True可启用,false 表示禁用

HyokProtection、DoubleKeyProtection、DoubleKeyUserDefinedProtection 在默认情况下处于禁用状态,必须启用

GetConfiguredFunctionality 函数

获取配置的功能。

返回:类型映射到布尔值,指示是否已启用

SetAuthDelegate 函数

设置引擎身份验证委托。

参数:

  • authDelegate:Auth委托

GetAuthDelegate 函数

获取引擎身份验证委托。

返回:引擎身份验证委托。

GetLoggerContext 函数

获取将不透明传递给与所创建引擎关联的日志的记录器委托的记录器上下文。

返回:记录器上下文

SetLoggerContext 函数

设置记录器上下文,该上下文将不透明传递给与所创建引擎关联的日志的记录器委托。

参数:

  • loggerContext:记录器上下文