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
AddGroupMemberResponse	AddGroupMember(AddGroupMemberRequest req) This API is used to add users to a group.
BatchAddGroupMemberResponse	BatchAddGroupMember(BatchAddGroupMemberRequest req) This API is used to add users to multiple groups at a time.
BatchCreateGroupWithMembersResponse	BatchCreateGroupWithMembers(BatchCreateGroupWithMembersRequest req) This API is used to create multiple groups at a time.
BatchCreateRoomResponse	BatchCreateRoom(BatchCreateRoomRequest req) This API is used to create multiple rooms at a time.
BatchDeleteGroupMemberResponse	BatchDeleteGroupMember(BatchDeleteGroupMemberRequest req) This API is used to remove users from multiple groups at a time.
BatchDeleteRecordResponse	BatchDeleteRecord(BatchDeleteRecordRequest req) This API is used to delete the recordings of multiple rooms.
BatchRegisterResponse	BatchRegister(BatchRegisterRequest req) This API is used to register multiple users (up to 1,000) at a time.
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.
CreateGroupWithMembersResponse	CreateGroupWithMembers(CreateGroupWithMembersRequest req) This API is used to create a group and specify its members.
CreateGroupWithSubGroupResponse	CreateGroupWithSubGroup(CreateGroupWithSubGroupRequest req) This API is used to merge groups.
CreateRoomResponse	CreateRoom(CreateRoomRequest req) This API is used to create a room.
CreateSupervisorResponse	CreateSupervisor(CreateSupervisorRequest req) This API is used to create a spectator.
DeleteDocumentResponse	DeleteDocument(DeleteDocumentRequest req) This API is used to delete a document.
DeleteGroupResponse	DeleteGroup(DeleteGroupRequest req) This API is used to delete one or multiple groups.
DeleteGroupMemberResponse	DeleteGroupMember(DeleteGroupMemberRequest req) This API is used to remove users from a group.
DeleteRecordResponse	DeleteRecord(DeleteRecordRequest req) This example shows you how to delete the recording files of a specific room.
DeleteRoomResponse	DeleteRoom(DeleteRoomRequest req) This API is used to delete a room.
DescribeCurrentMemberListResponse	DescribeCurrentMemberList(DescribeCurrentMemberListRequest req) This API is used to get the user list of a room.
DescribeDocumentResponse	DescribeDocument(DescribeDocumentRequest req) This API is used to get the information of a specific document.
DescribeDocumentsByRoomResponse	DescribeDocumentsByRoom(DescribeDocumentsByRoomRequest req) This API is used to get the document list of a specific room.
DescribeGroupResponse	DescribeGroup(DescribeGroupRequest req) This API is used to get the details of a group.
DescribeGroupListResponse	DescribeGroupList(DescribeGroupListRequest req) This API is used to query groups.
DescribeGroupMemberListResponse	DescribeGroupMemberList(DescribeGroupMemberListRequest req) This API is used to get the members of a group.
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.
DescribeSdkAppIdUsersResponse	DescribeSdkAppIdUsers(DescribeSdkAppIdUsersRequest req) This API is used to get the user list of a specific application.
DescribeUserResponse	DescribeUser(DescribeUserRequest req) This API is used to obtain user profile.
GetWatermarkResponse	GetWatermark(GetWatermarkRequest req) This API is used to get watermark settings.
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.
ModifyGroupResponse	ModifyGroup(ModifyGroupRequest req) This API is used to modify a group.
ModifyRoomResponse	ModifyRoom(ModifyRoomRequest req) This API is used to modify a room.
ModifyUserProfileResponse	ModifyUserProfile(ModifyUserProfileRequest req) This API is used to modify a user profile such as the nickname and profile photo.
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.
SetWatermarkResponse	SetWatermark(SetWatermarkRequest req) This API is used to configure watermarks.
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

AddGroupMember

public AddGroupMemberResponse AddGroupMember(AddGroupMemberRequest req)
                                      throws TencentCloudSDKException

This API is used to add users to a group.

Parameters:

req - AddGroupMemberRequest

Returns:

AddGroupMemberResponse

Throws:

TencentCloudSDKException

BatchAddGroupMember

public BatchAddGroupMemberResponse BatchAddGroupMember(BatchAddGroupMemberRequest req)
                                                throws TencentCloudSDKException

This API is used to add users to multiple groups at a time.

Parameters:

req - BatchAddGroupMemberRequest

Returns:

BatchAddGroupMemberResponse

Throws:

TencentCloudSDKException

BatchCreateGroupWithMembers

public BatchCreateGroupWithMembersResponse BatchCreateGroupWithMembers(BatchCreateGroupWithMembersRequest req)
                                                                throws TencentCloudSDKException

This API is used to create multiple groups at a time.

Parameters:

req - BatchCreateGroupWithMembersRequest

Returns:

BatchCreateGroupWithMembersResponse

Throws:

TencentCloudSDKException

BatchCreateRoom

public BatchCreateRoomResponse BatchCreateRoom(BatchCreateRoomRequest req)
                                        throws TencentCloudSDKException

This API is used to create multiple rooms at a time.

Parameters:

req - BatchCreateRoomRequest

Returns:

BatchCreateRoomResponse

Throws:

TencentCloudSDKException

BatchDeleteGroupMember

public BatchDeleteGroupMemberResponse BatchDeleteGroupMember(BatchDeleteGroupMemberRequest req)
                                                      throws TencentCloudSDKException

This API is used to remove users from multiple groups at a time.

Parameters:

req - BatchDeleteGroupMemberRequest

Returns:

BatchDeleteGroupMemberResponse

Throws:

TencentCloudSDKException

BatchDeleteRecord

public BatchDeleteRecordResponse BatchDeleteRecord(BatchDeleteRecordRequest req)
                                            throws TencentCloudSDKException

This API is used to delete the recordings of multiple rooms.

Parameters:

req - BatchDeleteRecordRequest

Returns:

BatchDeleteRecordResponse

Throws:

TencentCloudSDKException

BatchRegister

public BatchRegisterResponse BatchRegister(BatchRegisterRequest req)
                                    throws TencentCloudSDKException

This API is used to register multiple users (up to 1,000) at a time. If a user ID already exists, the existing one will be overwritten.

Parameters:

req - BatchRegisterRequest

Returns:

BatchRegisterResponse

Throws:

TencentCloudSDKException

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

CreateGroupWithMembers

public CreateGroupWithMembersResponse CreateGroupWithMembers(CreateGroupWithMembersRequest req)
                                                      throws TencentCloudSDKException

This API is used to create a group and specify its members.

Parameters:

req - CreateGroupWithMembersRequest

Returns:

CreateGroupWithMembersResponse

Throws:

TencentCloudSDKException

CreateGroupWithSubGroup

public CreateGroupWithSubGroupResponse CreateGroupWithSubGroup(CreateGroupWithSubGroupRequest req)
                                                        throws TencentCloudSDKException

This API is used to merge groups.

Parameters:

req - CreateGroupWithSubGroupRequest

Returns:

CreateGroupWithSubGroupResponse

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

DeleteDocument

public DeleteDocumentResponse DeleteDocument(DeleteDocumentRequest req)
                                      throws TencentCloudSDKException

This API is used to delete a document.

Parameters:

req - DeleteDocumentRequest

Returns:

DeleteDocumentResponse

Throws:

TencentCloudSDKException

DeleteGroup

public DeleteGroupResponse DeleteGroup(DeleteGroupRequest req)
                                throws TencentCloudSDKException

This API is used to delete one or multiple groups.

Parameters:

req - DeleteGroupRequest

Returns:

DeleteGroupResponse

Throws:

TencentCloudSDKException

DeleteGroupMember

public DeleteGroupMemberResponse DeleteGroupMember(DeleteGroupMemberRequest req)
                                            throws TencentCloudSDKException

This API is used to remove users from a group.

Parameters:

req - DeleteGroupMemberRequest

Returns:

DeleteGroupMemberResponse

Throws:

TencentCloudSDKException

DeleteRecord

public DeleteRecordResponse DeleteRecord(DeleteRecordRequest req)
                                  throws TencentCloudSDKException

This example shows you how to delete the recording files of a specific room.

Parameters:

req - DeleteRecordRequest

Returns:

DeleteRecordResponse

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

DescribeCurrentMemberList

public DescribeCurrentMemberListResponse DescribeCurrentMemberList(DescribeCurrentMemberListRequest req)
                                                            throws TencentCloudSDKException

This API is used to get the user list of a room. This API will not work if a room has ended or expired.

Parameters:

req - DescribeCurrentMemberListRequest

Returns:

DescribeCurrentMemberListResponse

Throws:

TencentCloudSDKException

DescribeDocument

public DescribeDocumentResponse DescribeDocument(DescribeDocumentRequest req)
                                          throws TencentCloudSDKException

This API is used to get the information of a specific document.

Parameters:

req - DescribeDocumentRequest

Returns:

DescribeDocumentResponse

Throws:

TencentCloudSDKException

DescribeDocumentsByRoom

public DescribeDocumentsByRoomResponse DescribeDocumentsByRoom(DescribeDocumentsByRoomRequest req)
                                                        throws TencentCloudSDKException

This API is used to get the document list of a specific room.

Parameters:

req - DescribeDocumentsByRoomRequest

Returns:

DescribeDocumentsByRoomResponse

Throws:

TencentCloudSDKException

DescribeGroup

public DescribeGroupResponse DescribeGroup(DescribeGroupRequest req)
                                    throws TencentCloudSDKException

This API is used to get the details of a group.

Parameters:

req - DescribeGroupRequest

Returns:

DescribeGroupResponse

Throws:

TencentCloudSDKException

DescribeGroupList

public DescribeGroupListResponse DescribeGroupList(DescribeGroupListRequest req)
                                            throws TencentCloudSDKException

This API is used to query groups.

Parameters:

req - DescribeGroupListRequest

Returns:

DescribeGroupListResponse

Throws:

TencentCloudSDKException

DescribeGroupMemberList

public DescribeGroupMemberListResponse DescribeGroupMemberList(DescribeGroupMemberListRequest req)
                                                        throws TencentCloudSDKException

This API is used to get the members of a group.

Parameters:

req - DescribeGroupMemberListRequest

Returns:

DescribeGroupMemberListResponse

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

DescribeSdkAppIdUsers

public DescribeSdkAppIdUsersResponse DescribeSdkAppIdUsers(DescribeSdkAppIdUsersRequest req)
                                                    throws TencentCloudSDKException

This API is used to get the user list of a specific application.

Parameters:

req - DescribeSdkAppIdUsersRequest

Returns:

DescribeSdkAppIdUsersResponse

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

GetWatermark

public GetWatermarkResponse GetWatermark(GetWatermarkRequest req)
                                  throws TencentCloudSDKException

This API is used to get watermark settings.

Parameters:

req - GetWatermarkRequest

Returns:

GetWatermarkResponse

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

ModifyGroup

public ModifyGroupResponse ModifyGroup(ModifyGroupRequest req)
                                throws TencentCloudSDKException

This API is used to modify a group.

Parameters:

req - ModifyGroupRequest

Returns:

ModifyGroupResponse

Throws:

TencentCloudSDKException

ModifyRoom

public ModifyRoomResponse ModifyRoom(ModifyRoomRequest req)
                              throws TencentCloudSDKException

This API is used to modify a room.

Parameters:

req - ModifyRoomRequest

Returns:

ModifyRoomResponse

Throws:

TencentCloudSDKException

ModifyUserProfile

public ModifyUserProfileResponse ModifyUserProfile(ModifyUserProfileRequest req)
                                            throws TencentCloudSDKException

This API is used to modify a user profile such as the nickname and profile photo.

Parameters:

req - ModifyUserProfileRequest

Returns:

ModifyUserProfileResponse

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

SetWatermark

public SetWatermarkResponse SetWatermark(SetWatermarkRequest req)
                                  throws TencentCloudSDKException

This API is used to configure watermarks.

Parameters:

req - SetWatermarkRequest

Returns:

SetWatermarkResponse

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