class ProtectionEngine::设置

设置 [ProtectionEngine 在其创建期间及其整个生命周期内使用。

摘要

成员 说明
public 设置 (const Identity & identity, const std::shared_ptr < AuthDelegate >& authDelegate, const std::string & clientData, const std::string & locale) ProtectionEngine::设置用于创建新引擎的构造函数。
public 设置 (const std::string & engineId, const std::shared_ptr < AuthDelegate >& authDelegate, const std::string & clientData, const std::string & 区域设置) ProtectionEngine::设置加载现有引擎的构造函数。
public const std::string & GetEngineId () const 获取引擎 ID。
public void SetEngineId (const std::string & engineId) 设置引擎 ID。
public const Identity & GetIdentity () const 获取与引擎关联的用户标识。
public void SetIdentity (const & Identity identity) 设置与引擎关联的用户标识。
public const std::string & GetClientData () const 获取客户端指定的自定义数据。
public void SetClientData (const std::string & clientData) 设置客户端指定的自定义数据。
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 SetCloudEndpointBaseUrl (const std::string & cloudEndpointBaseUrl) 设置自定义云的云终结点基 URL。
public const std::string & GetCloudEndpointBaseUrl () const 获取所有服务请求使用的云基 URL(如果已指定)。
public void SetAuthDelegate (const std::shared_ptr < AuthDelegate >& authDelegate) 设置引擎身份验证委托。
public std::shared_ptr < AuthDelegate > GetAuthDelegate () const 获取引擎身份验证委托。
public const std::string & GetUnderlyingApplicationId () const 获取基础应用程序 ID。
public void SetUnderlyingApplicationId (const std::string & underlyingApplicationId) 设置基础应用程序 ID。
public bool GetAllowCloudServiceOnly () const 获取是否仅允许云服务。
public void SetAllowCloudServiceOnly (bool allowCloudServiceOnly) 设置是否仅允许云服务。
public const std::shared_ptr < void >& GetLoggerContext () const 获取将不透明传递给与所创建引擎关联的日志的记录器委托的记录器上下文。
public void SetLoggerContext (const std::shared_ptr < void >& loggerContext) 设置记录器上下文,该上下文将不透明传递给与所创建引擎关联的日志的记录器委托。

成员

设置 函数

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

参数:

  • identity:与 [ProtectionEngine) 关联的标识

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

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

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

设置 函数

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

参数:

  • engineId:要加载的引擎的唯一标识符

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

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

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

GetEngineId 函数

获取引擎 ID。

返回:引擎 ID

SetEngineId 函数

设置引擎 ID。

参数:

  • engineId:引擎 ID。

GetIdentity 函数

获取与引擎关联的用户标识。

返回:与引擎关联的用户标识

SetIdentity 函数

设置与引擎关联的用户标识。

参数:

  • identity:与引擎关联的用户标识

GetClientData 函数

获取客户端指定的自定义数据。

返回:客户端指定的自定义数据

SetClientData 函数

设置客户端指定的自定义数据。

参数:

  • 自定义:客户端指定的数据

GetLocale 函数

获取将写入引擎数据区域设置。

返回:将写入引擎数据区域设置

SetCustomSettings 函数

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

参数:

  • customSettings:用于测试和试验的名称/值对

GetCustomSettings 函数

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

返回:用于测试和试验的名称/值对

SetSessionId 函数

设置引擎会话 ID,用于记录/遥测关联。

参数:

  • sessionId:引擎会话 ID,用于记录/遥测关联

GetSessionId 函数

获取引擎会话 ID。

返回:引擎会话 ID

SetCloud 函数

(可选)设置目标云。

参数:

  • :云

如果未指定云,则由引擎标识域的 DNS 查找(如果可能)确定,否则会回退到全局云。

GetCloud 函数

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

返回:云

SetCloudEndpointBaseUrl 函数

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

参数:

  • cloudEndpointBaseUrl:所有服务请求使用的基本 URL (例如 ";)

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

GetCloudEndpointBaseUrl 函数

获取所有服务请求使用的云基 URL(如果已指定)。

返回:基 URL

SetAuthDelegate 函数

设置引擎身份验证委托。

参数:

  • authDelegate:Auth委托

GetAuthDelegate 函数

获取引擎身份验证委托。

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

GetUnderlyingApplicationId 函数

获取基础应用程序 ID。

返回:基础应用程序 ID

SetUnderlyingApplicationId 函数

设置基础应用程序 ID。

参数:

  • UnderlyingApplicationId:基础应用程序 ID。

GetAllowCloudServiceOnly 函数

获取是否仅允许云服务。

返回:一个布尔值,指示是否仅允许云服务

SetAllowCloudServiceOnly 函数

设置是否仅允许云服务。

参数:

  • allowCloudServiceOnly:一个布尔值,指示是否仅允许云服务

GetLoggerContext 函数

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

返回:记录器上下文

SetLoggerContext 函数

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

参数:

  • loggerContext:记录器上下文