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 parameters.This parameter is effective for multi-application projects.
String	getClientSession() Get Client-side session information, which is obtained from the SDK.
String	getHostUserId() Get [Multi-person Interaction] Homeowner's user ID, which is required in multi-person interaction mode.
String	getRole() Get [Multi-person Interaction] Role.
String	getRunMode() Get On-cloud running mode.RunWithoutClient: Keeps the application running on the cloud even when there are no client connections.Empty string (default): Keeps the application running on the cloud only when there are client connections.
String	getUserId() Get Unique user ID, which is customized by you and is not parsed by CAR.
String	getUserIp() Get Public IP address of the user's client, which is used for nearby scheduling.
void	setApplicationParameters(String ApplicationParameters) Set Application startup parameters.This parameter is effective for multi-application projects.
void	setClientSession(String ClientSession) Set Client-side session information, which is obtained from the SDK.
void	setHostUserId(String HostUserId) Set [Multi-person Interaction] Homeowner's user ID, which is required in multi-person interaction mode.
void	setRole(String Role) Set [Multi-person Interaction] Role.
void	setRunMode(String RunMode) Set On-cloud running mode.RunWithoutClient: Keeps the application running on the cloud even when there are no client connections.Empty string (default): Keeps the application running on the cloud only when there are client connections.
void	setUserId(String UserId) Set Unique user ID, which is customized by you and is not parsed by CAR.
void	setUserIp(String UserIp) Set Public IP address of the user's 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 Unique user ID, which is customized by you and is not parsed by CAR. 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 Unique user ID, which is customized by you and is not parsed by CAR. 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 Unique user ID, which is customized by you and is not parsed by CAR. 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 - Unique user ID, which is customized by you and is not parsed by CAR. 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 address of the user's client, which is used for nearby scheduling.

Returns:

UserIp Public IP address of the user's client, which is used for nearby scheduling.

setUserIp

public void setUserIp(String UserIp)

Set Public IP address of the user's client, which is used for nearby scheduling.

Parameters:

UserIp - Public IP address of the user's client, which is used for nearby scheduling.

getClientSession

public String getClientSession()

Get Client-side session information, which is obtained from the SDK. If `RunMode` is `RunWithoutClient`, this parameter can be empty.

Returns:

ClientSession Client-side session information, which is obtained from the SDK. If `RunMode` is `RunWithoutClient`, this parameter can be empty.

setClientSession

public void setClientSession(String ClientSession)

Set Client-side session information, which is obtained from the SDK. If `RunMode` is `RunWithoutClient`, this parameter can be empty.

Parameters:

ClientSession - Client-side session information, which is obtained from the SDK. If `RunMode` is `RunWithoutClient`, this parameter can be empty.

getRunMode

public String getRunMode()

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

Returns:

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

setRunMode

public void setRunMode(String RunMode)

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

Parameters:

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

getApplicationParameters

public String getApplicationParameters()

Get Application startup parameters.This parameter is effective for multi-application projects. This parameter is effective for single-application projects with prelaunch disabled.This parameter is ineffective for single-application projects with prelaunch enabled. Note: When this parameter is effective, it will be appended to the startup parameters of application or project configuration in the console. For example, for a single-application project with prelaunch disabled, if its startup parameter `bar` is `0` for project configuration in the console and the `ApplicationParameters` parameter `foo` is `1`, the actual application startup parameters will be `bar=0 and foo=1`.

Returns:

ApplicationParameters Application startup parameters.This parameter is effective for multi-application projects. This parameter is effective for single-application projects with prelaunch disabled.This parameter is ineffective for single-application projects with prelaunch enabled. Note: When this parameter is effective, it will be appended to the startup parameters of application or project configuration in the console. For example, for a single-application project with prelaunch disabled, if its startup parameter `bar` is `0` for project configuration in the console and the `ApplicationParameters` parameter `foo` is `1`, the actual application startup parameters will be `bar=0 and foo=1`.

setApplicationParameters

public void setApplicationParameters(String ApplicationParameters)

Set Application startup parameters.This parameter is effective for multi-application projects. This parameter is effective for single-application projects with prelaunch disabled.This parameter is ineffective for single-application projects with prelaunch enabled. Note: When this parameter is effective, it will be appended to the startup parameters of application or project configuration in the console. For example, for a single-application project with prelaunch disabled, if its startup parameter `bar` is `0` for project configuration in the console and the `ApplicationParameters` parameter `foo` is `1`, the actual application startup parameters will be `bar=0 and foo=1`.

Parameters:

ApplicationParameters - Application startup parameters.This parameter is effective for multi-application projects. This parameter is effective for single-application projects with prelaunch disabled.This parameter is ineffective for single-application projects with prelaunch enabled. Note: When this parameter is effective, it will be appended to the startup parameters of application or project configuration in the console. For example, for a single-application project with prelaunch disabled, if its startup parameter `bar` is `0` for project configuration in the console and the `ApplicationParameters` parameter `foo` is `1`, the actual application startup parameters will be `bar=0 and foo=1`.

getHostUserId

public String getHostUserId()

Get [Multi-person Interaction] Homeowner's user ID, which is required in multi-person interaction mode. If the user is the homeowner, HostUserID must be the same as UserID. If the user is not the homeowner, HostUserID must be the homeowner's HostUserID.

Returns:

HostUserId [Multi-person Interaction] Homeowner's user ID, which is required in multi-person interaction mode. If the user is the homeowner, HostUserID must be the same as UserID. If the user is not the homeowner, HostUserID must be the homeowner's HostUserID.

setHostUserId

public void setHostUserId(String HostUserId)

Set [Multi-person Interaction] Homeowner's user ID, which is required in multi-person interaction mode. If the user is the homeowner, HostUserID must be the same as UserID. If the user is not the homeowner, HostUserID must be the homeowner's HostUserID.

Parameters:

HostUserId - [Multi-person Interaction] Homeowner's user ID, which is required in multi-person interaction mode. If the user is the homeowner, HostUserID must be the same as UserID. If the user is not the homeowner, HostUserID must be the homeowner's HostUserID.

getRole

public String getRole()

Get [Multi-person Interaction] Role. Player: a user who can operate the application via keyboard, mouse, etc. Viewer: a user who can only watch the video in the room but cannot operate the application.

Returns:

Role [Multi-person Interaction] Role. Player: a user who can operate the application via keyboard, mouse, etc. Viewer: a user who can only watch the video in the room but cannot operate the application.

setRole

public void setRole(String Role)

Set [Multi-person Interaction] Role. Player: a user who can operate the application via keyboard, mouse, etc. Viewer: a user who can only watch the video in the room but cannot operate the application.

Parameters:

Role - [Multi-person Interaction] Role. Player: a user who can operate the application via keyboard, mouse, etc. 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