com.tencentcloudapi.lcic.v20220817

Class LcicClient

java.lang.Object

com.tencentcloudapi.common.AbstractClient

com.tencentcloudapi.lcic.v20220817.LcicClient

public class LcicClient
extends AbstractClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors

Constructor and Description
LcicClient(Credential credential, String region)
LcicClient(Credential credential, String region, ClientProfile profile)

Method Summary

Modifier and Type	Method and Description
BindDocumentToRoomResponse	BindDocumentToRoom(BindDocumentToRoomRequest req) This API is used to bind a document to a room.
CreateDocumentResponse	CreateDocument(CreateDocumentRequest req) This API is used to create a document to be used in a room.
CreateRoomResponse	CreateRoom(CreateRoomRequest req) This API is used to create a room.
CreateSupervisorResponse	CreateSupervisor(CreateSupervisorRequest req) This API is used to create a spectator.
DeleteRoomResponse	DeleteRoom(DeleteRoomRequest req) This API is used to delete a room.
DescribeRoomResponse	DescribeRoom(DescribeRoomRequest req) This API is used to get room information.
DescribeRoomStatisticsResponse	DescribeRoomStatistics(DescribeRoomStatisticsRequest req) This API is used to obtain the statistics of a room.
DescribeUserResponse	DescribeUser(DescribeUserRequest req) This API is used to obtain user profile.
LoginOriginIdResponse	LoginOriginId(LoginOriginIdRequest req) This API is used to log in with an origin account, which is the `originId` entered during registration.
LoginUserResponse	LoginUser(LoginUserRequest req) This API is used to log in.
ModifyAppResponse	ModifyApp(ModifyAppRequest req) This API is used to modify an application.
RegisterUserResponse	RegisterUser(RegisterUserRequest req) This API is used to register a user.
SetAppCustomContentResponse	SetAppCustomContent(SetAppCustomContentRequest req) This API is used to set or update the custom content of an application, including the application icon and custom code.
UnbindDocumentFromRoomResponse	UnbindDocumentFromRoom(UnbindDocumentFromRoomRequest req) This API is used to unbind a document from a room.

Methods inherited from class com.tencentcloudapi.common.AbstractClient

call, getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

Methods inherited from class java.lang.Object

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

Constructor Detail

LcicClient

public LcicClient(Credential credential,
                  String region)

LcicClient

public LcicClient(Credential credential,
                  String region,
                  ClientProfile profile)

Method Detail

BindDocumentToRoom

public BindDocumentToRoomResponse BindDocumentToRoom(BindDocumentToRoomRequest req)
                                              throws TencentCloudSDKException

This API is used to bind a document to a room.

Parameters:

req - BindDocumentToRoomRequest

Returns:

BindDocumentToRoomResponse

Throws:

TencentCloudSDKException

CreateDocument

public CreateDocumentResponse CreateDocument(CreateDocumentRequest req)
                                      throws TencentCloudSDKException

This API is used to create a document to be used in a room.

Parameters:

req - CreateDocumentRequest

Returns:

CreateDocumentResponse

Throws:

TencentCloudSDKException

CreateRoom

public CreateRoomResponse CreateRoom(CreateRoomRequest req)
                              throws TencentCloudSDKException

This API is used to create a room.

Parameters:

req - CreateRoomRequest

Returns:

CreateRoomResponse

Throws:

TencentCloudSDKException

CreateSupervisor

public CreateSupervisorResponse CreateSupervisor(CreateSupervisorRequest req)
                                          throws TencentCloudSDKException

This API is used to create a spectator.

Parameters:

req - CreateSupervisorRequest

Returns:

CreateSupervisorResponse

Throws:

TencentCloudSDKException

DeleteRoom

public DeleteRoomResponse DeleteRoom(DeleteRoomRequest req)
                              throws TencentCloudSDKException

This API is used to delete a room.

Parameters:

req - DeleteRoomRequest

Returns:

DeleteRoomResponse

Throws:

TencentCloudSDKException

DescribeRoom

public DescribeRoomResponse DescribeRoom(DescribeRoomRequest req)
                                  throws TencentCloudSDKException

This API is used to get room information.

Parameters:

req - DescribeRoomRequest

Returns:

DescribeRoomResponse

Throws:

TencentCloudSDKException

DescribeRoomStatistics

public DescribeRoomStatisticsResponse DescribeRoomStatistics(DescribeRoomStatisticsRequest req)
                                                      throws TencentCloudSDKException

This API is used to obtain the statistics of a room. It can be called only after the room is ended.

Parameters:

req - DescribeRoomStatisticsRequest

Returns:

DescribeRoomStatisticsResponse

Throws:

TencentCloudSDKException

DescribeUser

public DescribeUserResponse DescribeUser(DescribeUserRequest req)
                                  throws TencentCloudSDKException

This API is used to obtain user profile.

Parameters:

req - DescribeUserRequest

Returns:

DescribeUserResponse

Throws:

TencentCloudSDKException

LoginOriginId

public LoginOriginIdResponse LoginOriginId(LoginOriginIdRequest req)
                                    throws TencentCloudSDKException

This API is used to log in with an origin account, which is the `originId` entered during registration.

Parameters:

req - LoginOriginIdRequest

Returns:

LoginOriginIdResponse

Throws:

TencentCloudSDKException

LoginUser

public LoginUserResponse LoginUser(LoginUserRequest req)
                            throws TencentCloudSDKException

This API is used to log in.

Parameters:

req - LoginUserRequest

Returns:

LoginUserResponse

Throws:

TencentCloudSDKException

ModifyApp

public ModifyAppResponse ModifyApp(ModifyAppRequest req)
                            throws TencentCloudSDKException

This API is used to modify an application.

Parameters:

req - ModifyAppRequest

Returns:

ModifyAppResponse

Throws:

TencentCloudSDKException

RegisterUser

public RegisterUserResponse RegisterUser(RegisterUserRequest req)
                                  throws TencentCloudSDKException

This API is used to register a user.

Parameters:

req - RegisterUserRequest

Returns:

RegisterUserResponse

Throws:

TencentCloudSDKException

SetAppCustomContent

public SetAppCustomContentResponse SetAppCustomContent(SetAppCustomContentRequest req)
                                                throws TencentCloudSDKException

This API is used to set or update the custom content of an application, including the application icon and custom code. After you update JS and CSS content, you also need to call this API for the updates to take effect.

Parameters:

req - SetAppCustomContentRequest

Returns:

SetAppCustomContentResponse

Throws:

TencentCloudSDKException

UnbindDocumentFromRoom

public UnbindDocumentFromRoomResponse UnbindDocumentFromRoom(UnbindDocumentFromRoomRequest req)
                                                      throws TencentCloudSDKException

This API is used to unbind a document from a room.

Parameters:

req - UnbindDocumentFromRoomRequest

Returns:

UnbindDocumentFromRoomResponse

Throws:

TencentCloudSDKException