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 Application startup parameter.
String	getClientSession() Get The client-side session data, which is obtained from the SDK.
String	getHostUserId() Get The user ID of the host in **multi-person interaction** scenarios, which is required.
String	getRole() Get The role in **multi-person interaction** scenarios.
String	getRunMode() Get The on-cloud running mode.
String	getUserId() Get The user’s unique ID.
String	getUserIp() Get Public IP of user’s application client, which is used for nearby scheduling.
void	setApplicationParameters(String ApplicationParameters) Set Application startup parameter.
void	setClientSession(String ClientSession) Set The client-side session data, which is obtained from the SDK.
void	setHostUserId(String HostUserId) Set The user ID of the host in **multi-person interaction** scenarios, which is required.
void	setRole(String Role) Set The role in **multi-person interaction** scenarios.
void	setRunMode(String RunMode) Set The on-cloud running mode.
void	setUserId(String UserId) Set The user’s unique ID.
void	setUserIp(String UserIp) Set Public IP of user’s application client, which is used for nearby scheduling.
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, 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 The user’s unique ID. Tencent Cloud does not parse the ID. You need to manage your own user IDs. Based on your needs, you can either define unique IDs for users or use timestamps to generate random IDs. Make sure the same ID is used when a user reconnects to your application.

Returns:

UserId The user’s unique ID. Tencent Cloud does not parse the ID. You need to manage your own user IDs. Based on your needs, you can either define unique IDs for users or use timestamps to generate random IDs. Make sure the same ID is used when a user reconnects to your application.

setUserId

public void setUserId(String UserId)

Set The user’s unique ID. Tencent Cloud does not parse the ID. You need to manage your own user IDs. Based on your needs, you can either define unique IDs for users or use timestamps to generate random IDs. Make sure the same ID is used when a user reconnects to your application.

Parameters:

UserId - The user’s unique ID. Tencent Cloud does not parse the ID. You need to manage your own user IDs. Based on your needs, you can either define unique IDs for users or use timestamps to generate random IDs. Make sure the same ID is used when a user reconnects to your application.

getUserIp

public String getUserIp()

Get Public IP of user’s application client, which is used for nearby scheduling.

Returns:

UserIp Public IP of user’s application client, which is used for nearby scheduling.

setUserIp

public void setUserIp(String UserIp)

Set Public IP of user’s application client, which is used for nearby scheduling.

Parameters:

UserIp - Public IP of user’s application client, which is used for nearby scheduling.

getClientSession

public String getClientSession()

Get The client-side session data, which is obtained from the SDK. If `RunMode` is `RunWithoutClient`, this parameter can be null.

Returns:

ClientSession The client-side session data, which is obtained from the SDK. If `RunMode` is `RunWithoutClient`, this parameter can be null.

setClientSession

public void setClientSession(String ClientSession)

Set The client-side session data, which is obtained from the SDK. If `RunMode` is `RunWithoutClient`, this parameter can be null.

Parameters:

ClientSession - The client-side session data, which is obtained from the SDK. If `RunMode` is `RunWithoutClient`, this parameter can be null.

getRunMode

public String getRunMode()

Get The on-cloud running mode. `RunWithoutClient`: Keep the application running on the cloud even when there are no client connections. Empty string (default): Keep the application running on the cloud only when there are client connections.

Returns:

RunMode The on-cloud running mode. `RunWithoutClient`: Keep the application running on the cloud even when there are no client connections. Empty string (default): Keep the application running on the cloud only when there are client connections.

setRunMode

public void setRunMode(String RunMode)

Set The on-cloud running mode. `RunWithoutClient`: Keep the application running on the cloud even when there are no client connections. Empty string (default): Keep the application running on the cloud only when there are client connections.

Parameters:

RunMode - The on-cloud running mode. `RunWithoutClient`: Keep the application running on the cloud even when there are no client connections. Empty string (default): Keep the application running on the cloud only when there are client connections.

getApplicationParameters

public String getApplicationParameters()

Get Application startup parameter. If the user requests a multi-application project or a prelaunch-disabled single-application project, this parameter takes effect. If the user requests a prelaunch-enabled single-application project, this parameter is invalid. Note: When this parameter takes effect, the `ApplicationParameters` parameter will be appended to the end of the application startup parameter. The application startup parameter is set in the application or project configuration in the console. For example, for a prelaunch-disabled single-application project, if its application startup parameter `bar` is `0` and the `ApplicationParameters` parameter `foo` is `1`, the actual application startup parameters will be `bar=0 foo=1`.

Returns:

ApplicationParameters Application startup parameter. If the user requests a multi-application project or a prelaunch-disabled single-application project, this parameter takes effect. If the user requests a prelaunch-enabled single-application project, this parameter is invalid. Note: When this parameter takes effect, the `ApplicationParameters` parameter will be appended to the end of the application startup parameter. The application startup parameter is set in the application or project configuration in the console. For example, for a prelaunch-disabled single-application project, if its application startup parameter `bar` is `0` and the `ApplicationParameters` parameter `foo` is `1`, the actual application startup parameters will be `bar=0 foo=1`.

setApplicationParameters

public void setApplicationParameters(String ApplicationParameters)

Set Application startup parameter. If the user requests a multi-application project or a prelaunch-disabled single-application project, this parameter takes effect. If the user requests a prelaunch-enabled single-application project, this parameter is invalid. Note: When this parameter takes effect, the `ApplicationParameters` parameter will be appended to the end of the application startup parameter. The application startup parameter is set in the application or project configuration in the console. For example, for a prelaunch-disabled single-application project, if its application startup parameter `bar` is `0` and the `ApplicationParameters` parameter `foo` is `1`, the actual application startup parameters will be `bar=0 foo=1`.

Parameters:

ApplicationParameters - Application startup parameter. If the user requests a multi-application project or a prelaunch-disabled single-application project, this parameter takes effect. If the user requests a prelaunch-enabled single-application project, this parameter is invalid. Note: When this parameter takes effect, the `ApplicationParameters` parameter will be appended to the end of the application startup parameter. The application startup parameter is set in the application or project configuration in the console. For example, for a prelaunch-disabled single-application project, if its application startup parameter `bar` is `0` and the `ApplicationParameters` parameter `foo` is `1`, the actual application startup parameters will be `bar=0 foo=1`.

getHostUserId

public String getHostUserId()

Get The user ID of the host in **multi-person interaction** scenarios, which is required. If the current user is the host, `HostUserId` must be the same as their `UserId`; otherwise, `HostUserId` should be the host's `UserId`.

Returns:

HostUserId The user ID of the host in **multi-person interaction** scenarios, which is required. If the current user is the host, `HostUserId` must be the same as their `UserId`; otherwise, `HostUserId` should be the host's `UserId`.

setHostUserId

public void setHostUserId(String HostUserId)

Set The user ID of the host in **multi-person interaction** scenarios, which is required. If the current user is the host, `HostUserId` must be the same as their `UserId`; otherwise, `HostUserId` should be the host's `UserId`.

Parameters:

HostUserId - The user ID of the host in **multi-person interaction** scenarios, which is required. If the current user is the host, `HostUserId` must be the same as their `UserId`; otherwise, `HostUserId` should be the host's `UserId`.

getRole

public String getRole()

Get The role in **multi-person interaction** scenarios. Valid values: `Player`: A user who can operate an application by using a keyboard and mouse `Viewer`: A user who can only watch the video in the room but cannot operate the application

Returns:

Role The role in **multi-person interaction** scenarios. Valid values: `Player`: A user who can operate an application by using a keyboard and mouse `Viewer`: A user who can only watch the video in the room but cannot operate the application

setRole

public void setRole(String Role)

Set The role in **multi-person interaction** scenarios. Valid values: `Player`: A user who can operate an application by using a keyboard and mouse `Viewer`: A user who can only watch the video in the room but cannot operate the application

Parameters:

Role - The role in **multi-person interaction** scenarios. Valid values: `Player`: A user who can operate an application by using a keyboard and mouse `Viewer`: A user who can only watch the video in the room but cannot operate the application

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel