com.tencentcloudapi.car.v20220110.models

Class CreateSessionRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.car.v20220110.models.CreateSessionRequest

public class CreateSessionRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
CreateSessionRequest()
CreateSessionRequest(CreateSessionRequest source) NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

Modifier and Type	Method and Description
String	getApplicationParameters() Get 应用启动参数。 如果请求的是多应用共享项目，此参数生效； 如果请求的是关闭预启动的单应用独享项目，此参数生效； 如果请求的是开启预启动的单应用独享项目，此参数失效。 注意：在此参数生效的情况下，将会被追加到控制台应用或项目配置的启动参数的后面。 例如，对于某关闭预启动的单应用独享项目，若在控制台中项目配置的启动参数为bar=0，而ApplicationParameters参数为foo=1，则实际应用启动参数为bar=0 foo=1。
String	getClientSession() Get 客户端session信息，从SDK请求中获得。特殊的，当 RunMode 参数为 RunWithoutClient 时，该字段可以为空
String	getHostUserId() Get 【多人互动】房主用户ID，在多人互动模式下为必填字段。 如果该用户是房主，HostUserId需要和UserId保持一致； 如果该用户非房主，HostUserId需要填写房主的HostUserId。
String	getRole() Get 【多人互动】角色。 Player：玩家（可通过键鼠等操作应用） Viewer：观察者（只能观看，无法操作）
String	getRunMode() Get 云端运行模式。 RunWithoutClient：允许无客户端连接的情况下仍保持云端 App 运行 默认值（空）：要求必须有客户端连接才会保持云端 App 运行。
String	getUserId() Get 唯一用户身份标识，由业务方自定义，平台不予理解。（可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成；在用户重连时应保持UserId不变）
String	getUserIp() Get 用户IP，用户客户端的公网IP，用于就近调度
void	setApplicationParameters(String ApplicationParameters) Set 应用启动参数。 如果请求的是多应用共享项目，此参数生效； 如果请求的是关闭预启动的单应用独享项目，此参数生效； 如果请求的是开启预启动的单应用独享项目，此参数失效。 注意：在此参数生效的情况下，将会被追加到控制台应用或项目配置的启动参数的后面。 例如，对于某关闭预启动的单应用独享项目，若在控制台中项目配置的启动参数为bar=0，而ApplicationParameters参数为foo=1，则实际应用启动参数为bar=0 foo=1。
void	setClientSession(String ClientSession) Set 客户端session信息，从SDK请求中获得。特殊的，当 RunMode 参数为 RunWithoutClient 时，该字段可以为空
void	setHostUserId(String HostUserId) Set 【多人互动】房主用户ID，在多人互动模式下为必填字段。 如果该用户是房主，HostUserId需要和UserId保持一致； 如果该用户非房主，HostUserId需要填写房主的HostUserId。
void	setRole(String Role) Set 【多人互动】角色。 Player：玩家（可通过键鼠等操作应用） Viewer：观察者（只能观看，无法操作）
void	setRunMode(String RunMode) Set 云端运行模式。 RunWithoutClient：允许无客户端连接的情况下仍保持云端 App 运行 默认值（空）：要求必须有客户端连接才会保持云端 App 运行。
void	setUserId(String UserId) Set 唯一用户身份标识，由业务方自定义，平台不予理解。（可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成；在用户重连时应保持UserId不变）
void	setUserIp(String UserIp) Set 用户IP，用户客户端的公网IP，用于就近调度
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CreateSessionRequest

public CreateSessionRequest()

CreateSessionRequest

public CreateSessionRequest(CreateSessionRequest source)

NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Detail

getUserId

public String getUserId()

Get 唯一用户身份标识，由业务方自定义，平台不予理解。（可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成；在用户重连时应保持UserId不变）

Returns:

UserId 唯一用户身份标识，由业务方自定义，平台不予理解。（可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成；在用户重连时应保持UserId不变）

setUserId

public void setUserId(String UserId)

Set 唯一用户身份标识，由业务方自定义，平台不予理解。（可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成；在用户重连时应保持UserId不变）

Parameters:

UserId - 唯一用户身份标识，由业务方自定义，平台不予理解。（可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成；在用户重连时应保持UserId不变）

getUserIp

public String getUserIp()

Get 用户IP，用户客户端的公网IP，用于就近调度

Returns:

UserIp 用户IP，用户客户端的公网IP，用于就近调度

setUserIp

public void setUserIp(String UserIp)

Set 用户IP，用户客户端的公网IP，用于就近调度

Parameters:

UserIp - 用户IP，用户客户端的公网IP，用于就近调度

getClientSession

public String getClientSession()

Get 客户端session信息，从SDK请求中获得。特殊的，当 RunMode 参数为 RunWithoutClient 时，该字段可以为空

Returns:

ClientSession 客户端session信息，从SDK请求中获得。特殊的，当 RunMode 参数为 RunWithoutClient 时，该字段可以为空

setClientSession

public void setClientSession(String ClientSession)

Set 客户端session信息，从SDK请求中获得。特殊的，当 RunMode 参数为 RunWithoutClient 时，该字段可以为空

Parameters:

ClientSession - 客户端session信息，从SDK请求中获得。特殊的，当 RunMode 参数为 RunWithoutClient 时，该字段可以为空

getRunMode

public String getRunMode()

Get 云端运行模式。 RunWithoutClient：允许无客户端连接的情况下仍保持云端 App 运行 默认值（空）：要求必须有客户端连接才会保持云端 App 运行。

Returns:

RunMode 云端运行模式。 RunWithoutClient：允许无客户端连接的情况下仍保持云端 App 运行 默认值（空）：要求必须有客户端连接才会保持云端 App 运行。

setRunMode

public void setRunMode(String RunMode)

Set 云端运行模式。 RunWithoutClient：允许无客户端连接的情况下仍保持云端 App 运行 默认值（空）：要求必须有客户端连接才会保持云端 App 运行。

Parameters:

RunMode - 云端运行模式。 RunWithoutClient：允许无客户端连接的情况下仍保持云端 App 运行 默认值（空）：要求必须有客户端连接才会保持云端 App 运行。

getApplicationParameters

public String getApplicationParameters()

Get 应用启动参数。 如果请求的是多应用共享项目，此参数生效； 如果请求的是关闭预启动的单应用独享项目，此参数生效； 如果请求的是开启预启动的单应用独享项目，此参数失效。 注意：在此参数生效的情况下，将会被追加到控制台应用或项目配置的启动参数的后面。 例如，对于某关闭预启动的单应用独享项目，若在控制台中项目配置的启动参数为bar=0，而ApplicationParameters参数为foo=1，则实际应用启动参数为bar=0 foo=1。

Returns:

ApplicationParameters 应用启动参数。 如果请求的是多应用共享项目，此参数生效； 如果请求的是关闭预启动的单应用独享项目，此参数生效； 如果请求的是开启预启动的单应用独享项目，此参数失效。 注意：在此参数生效的情况下，将会被追加到控制台应用或项目配置的启动参数的后面。 例如，对于某关闭预启动的单应用独享项目，若在控制台中项目配置的启动参数为bar=0，而ApplicationParameters参数为foo=1，则实际应用启动参数为bar=0 foo=1。

setApplicationParameters

public void setApplicationParameters(String ApplicationParameters)

Set 应用启动参数。 如果请求的是多应用共享项目，此参数生效； 如果请求的是关闭预启动的单应用独享项目，此参数生效； 如果请求的是开启预启动的单应用独享项目，此参数失效。 注意：在此参数生效的情况下，将会被追加到控制台应用或项目配置的启动参数的后面。 例如，对于某关闭预启动的单应用独享项目，若在控制台中项目配置的启动参数为bar=0，而ApplicationParameters参数为foo=1，则实际应用启动参数为bar=0 foo=1。

Parameters:

ApplicationParameters - 应用启动参数。 如果请求的是多应用共享项目，此参数生效； 如果请求的是关闭预启动的单应用独享项目，此参数生效； 如果请求的是开启预启动的单应用独享项目，此参数失效。 注意：在此参数生效的情况下，将会被追加到控制台应用或项目配置的启动参数的后面。 例如，对于某关闭预启动的单应用独享项目，若在控制台中项目配置的启动参数为bar=0，而ApplicationParameters参数为foo=1，则实际应用启动参数为bar=0 foo=1。

getHostUserId

public String getHostUserId()

Get 【多人互动】房主用户ID，在多人互动模式下为必填字段。 如果该用户是房主，HostUserId需要和UserId保持一致； 如果该用户非房主，HostUserId需要填写房主的HostUserId。

Returns:

HostUserId 【多人互动】房主用户ID，在多人互动模式下为必填字段。 如果该用户是房主，HostUserId需要和UserId保持一致； 如果该用户非房主，HostUserId需要填写房主的HostUserId。

setHostUserId

public void setHostUserId(String HostUserId)

Set 【多人互动】房主用户ID，在多人互动模式下为必填字段。 如果该用户是房主，HostUserId需要和UserId保持一致； 如果该用户非房主，HostUserId需要填写房主的HostUserId。

Parameters:

HostUserId - 【多人互动】房主用户ID，在多人互动模式下为必填字段。 如果该用户是房主，HostUserId需要和UserId保持一致； 如果该用户非房主，HostUserId需要填写房主的HostUserId。

getRole

public String getRole()

Get 【多人互动】角色。 Player：玩家（可通过键鼠等操作应用） Viewer：观察者（只能观看，无法操作）

Returns:

Role 【多人互动】角色。 Player：玩家（可通过键鼠等操作应用） Viewer：观察者（只能观看，无法操作）

setRole

public void setRole(String Role)

Set 【多人互动】角色。 Player：玩家（可通过键鼠等操作应用） Viewer：观察者（只能观看，无法操作）

Parameters:

Role - 【多人互动】角色。 Player：玩家（可通过键鼠等操作应用） Viewer：观察者（只能观看，无法操作）

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel