v20220817

package
v3.0.959+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 16, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// CAM signature/authentication error.
	AUTHFAILURE = "AuthFailure"

	// The request would have succeeded, but the DryRun parameter was used.
	DRYRUNOPERATION = "DryRunOperation"

	// Operation failed.
	FAILEDOPERATION = "FailedOperation"

	// Room status error. The room has ended.
	FAILEDOPERATION_CLASSENDED = "FailedOperation.ClassEnded"

	// Room status error. The room has expired.
	FAILEDOPERATION_CLASSEXPIRED = "FailedOperation.ClassExpired"

	// Class status error. The class has already started.
	FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"

	// A class session cannot be longer than five hours.
	FAILEDOPERATION_CLASSTOOLONG = "FailedOperation.ClassTooLong"

	// Image parameter error.
	FAILEDOPERATION_IMAGEARGINVALID = "FailedOperation.ImageArgInvalid"

	// The user origin ID already exists.
	FAILEDOPERATION_ORIGINIDEXISTS = "FailedOperation.OriginIdExists"

	// Request timed out.
	FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"

	// The class has not ended.
	FAILEDOPERATION_ROOMNOTEND = "FailedOperation.RoomNotEnd"

	// Internal error.
	INTERNALERROR = "InternalError"

	// Invalid parameter.
	INVALIDPARAMETER = "InvalidParameter"

	// Prohibited content (pornographic, terrorist, politically sensitive) detected.
	INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"

	// Unable to access the CSS/JavaScript address.
	INVALIDPARAMETER_CSSORJS = "InvalidParameter.CssOrJs"

	// The end time cannot be earlier than the current time.
	INVALIDPARAMETER_ENDTIME = "InvalidParameter.EndTime"

	// The number of users in the group reached the limit.
	INVALIDPARAMETER_GROUPMEMBEROVERLIMIT = "InvalidParameter.GroupMemberOverLimit"

	// Parameter error. The teacher and group members are not specified.
	INVALIDPARAMETER_GROUPPARAMINVALID = "InvalidParameter.GroupParamInvalid"

	// The teacher cannot be a group member.
	INVALIDPARAMETER_GROUPTEACHERNOTMEMBER = "InvalidParameter.GroupTeacherNotMember"

	// The teacher does not exist.
	INVALIDPARAMETER_GROUPTEACHERSNOTEXIST = "InvalidParameter.GroupTeachersNotExist"

	// Group type error.
	INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"

	//
	INVALIDPARAMETER_ROOMTYPEINVALID = "InvalidParameter.RoomTypeInvalid"

	// `SdkAppId` is incorrect.
	INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

	// The start time cannot be earlier than the current time.
	INVALIDPARAMETER_STARTTIME = "InvalidParameter.StartTime"

	// Invalid parameter value.
	INVALIDPARAMETERVALUE = "InvalidParameterValue"

	// The quota limit is reached.
	LIMITEXCEEDED = "LimitExceeded"

	// Missing parameter.
	MISSINGPARAMETER = "MissingParameter"

	// Operation denied.
	OPERATIONDENIED = "OperationDenied"

	// Too many requests.
	REQUESTLIMITEXCEEDED = "RequestLimitExceeded"

	// The resource is occupied.
	RESOURCEINUSE = "ResourceInUse"

	// Insufficient resource.
	RESOURCEINSUFFICIENT = "ResourceInsufficient"

	// Insufficient storage space.
	RESOURCEINSUFFICIENT_RECORD = "ResourceInsufficient.Record"

	// Failed to enter the class. Please check your resource usage in the console.
	RESOURCEINSUFFICIENT_ROOM = "ResourceInsufficient.Room"

	// The resource doesn’t exist.
	RESOURCENOTFOUND = "ResourceNotFound"

	// The file does not exist.
	RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"

	// The group does not exist.
	RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"

	// The user ID does not exist.
	RESOURCENOTFOUND_GROUPPARTUSERSNOTEXIST = "ResourceNotFound.GroupPartUsersNotExist"

	// The room does not exist.
	RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"

	// The user does not exist.
	RESOURCENOTFOUND_USER = "ResourceNotFound.User"

	// The resource is unavailable.
	RESOURCEUNAVAILABLE = "ResourceUnavailable"

	// Getting room data. Please wait.
	RESOURCEUNAVAILABLE_ROOMSTATISTICS = "ResourceUnavailable.RoomStatistics"

	// The resources have been sold out.
	RESOURCESSOLDOUT = "ResourcesSoldOut"

	// Unauthorized operation.
	UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

	// Unknown parameter error.
	UNKNOWNPARAMETER = "UnknownParameter"

	// Unsupported operation.
	UNSUPPORTEDOPERATION = "UnsupportedOperation"
)
View Source 
const APIVersion = "2022-08-17"

Variables

This section is empty.

Functions

This section is empty.

Types

type AddGroupMemberRequest 

type AddGroupMemberRequest struct {
	*tchttp.BaseRequest

	// The group ID.
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The users. Array length limit: 200.
	MemberIds []*string `json:"MemberIds,omitnil,omitempty" name:"MemberIds"`
}

func NewAddGroupMemberRequest 

func NewAddGroupMemberRequest() (request *AddGroupMemberRequest)

func (*AddGroupMemberRequest) FromJsonString 

func (r *AddGroupMemberRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*AddGroupMemberRequest) ToJsonString 

func (r *AddGroupMemberRequest) ToJsonString() string

type AddGroupMemberRequestParams 

type AddGroupMemberRequestParams struct {
	// The group ID.
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The users. Array length limit: 200.
	MemberIds []*string `json:"MemberIds,omitnil,omitempty" name:"MemberIds"`
}

Predefined struct for user

type AddGroupMemberResponse 

type AddGroupMemberResponse struct {
	*tchttp.BaseResponse
	Response *AddGroupMemberResponseParams `json:"Response"`
}

func NewAddGroupMemberResponse 

func NewAddGroupMemberResponse() (response *AddGroupMemberResponse)

func (*AddGroupMemberResponse) FromJsonString 

func (r *AddGroupMemberResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*AddGroupMemberResponse) ToJsonString 

func (r *AddGroupMemberResponse) ToJsonString() string

type AddGroupMemberResponseParams 

type AddGroupMemberResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type AnswerInfo 

type AnswerInfo struct {
	// The username.
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// The answer. Bits are used to indicate the options chosen. For example, `0x1` indicates that option A is chosen; `0x11` indicates that A and B are chosen, and so on.
	Answer *uint64 `json:"Answer,omitnil,omitempty" name:"Answer"`

	// The time used.
	CostTime *uint64 `json:"CostTime,omitnil,omitempty" name:"CostTime"`

	// The user ID.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// Whether the answer is correct. `1`: Correct; `0`: Incorrect.
	IsCorrect *uint64 `json:"IsCorrect,omitnil,omitempty" name:"IsCorrect"`
}

type AnswerStat 

type AnswerStat struct {
	// The answer. Bits are used to indicate the options chosen. For example, `0x1` indicates that option A is chosen; `0x11` indicates that A and B are chosen, and so on.
	Answer *int64 `json:"Answer,omitnil,omitempty" name:"Answer"`

	// The number of users that submitted the answer.
	Count *int64 `json:"Count,omitnil,omitempty" name:"Count"`
}

type AppCustomContent 

type AppCustomContent struct {
	// Multiple scenarios can be set for an application.
	Scene *string `json:"Scene,omitnil,omitempty" name:"Scene"`

	// Logo URL
	LogoUrl *string `json:"LogoUrl,omitnil,omitempty" name:"LogoUrl"`

	// Homepage URL, which can be used for redirection
	HomeUrl *string `json:"HomeUrl,omitnil,omitempty" name:"HomeUrl"`

	// Custom JS URL
	JsUrl *string `json:"JsUrl,omitnil,omitempty" name:"JsUrl"`

	// Custom CSS URL
	CssUrl *string `json:"CssUrl,omitnil,omitempty" name:"CssUrl"`
}

type BackgroundPictureConfig 

type BackgroundPictureConfig struct {
	// The URL of the background image.
	// Note: This field may return null, indicating that no valid values can be obtained.
	Url *string `json:"Url,omitnil,omitempty" name:"Url"`
}

type BatchAddGroupMemberRequest 

type BatchAddGroupMemberRequest struct {
	*tchttp.BaseRequest

	// The target group IDs. Array length limit: 100.
	GroupIds []*string `json:"GroupIds,omitnil,omitempty" name:"GroupIds"`

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The users to add. Array length limit: 200.
	MemberIds []*string `json:"MemberIds,omitnil,omitempty" name:"MemberIds"`
}

func NewBatchAddGroupMemberRequest 

func NewBatchAddGroupMemberRequest() (request *BatchAddGroupMemberRequest)

func (*BatchAddGroupMemberRequest) FromJsonString 

func (r *BatchAddGroupMemberRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BatchAddGroupMemberRequest) ToJsonString 

func (r *BatchAddGroupMemberRequest) ToJsonString() string

type BatchAddGroupMemberRequestParams 

type BatchAddGroupMemberRequestParams struct {
	// The target group IDs. Array length limit: 100.
	GroupIds []*string `json:"GroupIds,omitnil,omitempty" name:"GroupIds"`

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The users to add. Array length limit: 200.
	MemberIds []*string `json:"MemberIds,omitnil,omitempty" name:"MemberIds"`
}

Predefined struct for user

type BatchAddGroupMemberResponse 

type BatchAddGroupMemberResponse struct {
	*tchttp.BaseResponse
	Response *BatchAddGroupMemberResponseParams `json:"Response"`
}

func NewBatchAddGroupMemberResponse 

func NewBatchAddGroupMemberResponse() (response *BatchAddGroupMemberResponse)

func (*BatchAddGroupMemberResponse) FromJsonString 

func (r *BatchAddGroupMemberResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BatchAddGroupMemberResponse) ToJsonString 

func (r *BatchAddGroupMemberResponse) ToJsonString() string

type BatchAddGroupMemberResponseParams 

type BatchAddGroupMemberResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type BatchCreateGroupWithMembersRequest 

type BatchCreateGroupWithMembersRequest struct {
	*tchttp.BaseRequest

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The information of the groups to create. Array length limit: 256.
	GroupBaseInfos []*GroupBaseInfo `json:"GroupBaseInfos,omitnil,omitempty" name:"GroupBaseInfos"`

	// The group members. Array length limit: 200.
	MemberIds []*string `json:"MemberIds,omitnil,omitempty" name:"MemberIds"`
}

func NewBatchCreateGroupWithMembersRequest 

func NewBatchCreateGroupWithMembersRequest() (request *BatchCreateGroupWithMembersRequest)

func (*BatchCreateGroupWithMembersRequest) FromJsonString 

func (r *BatchCreateGroupWithMembersRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BatchCreateGroupWithMembersRequest) ToJsonString 

func (r *BatchCreateGroupWithMembersRequest) ToJsonString() string

type BatchCreateGroupWithMembersRequestParams 

type BatchCreateGroupWithMembersRequestParams struct {
	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The information of the groups to create. Array length limit: 256.
	GroupBaseInfos []*GroupBaseInfo `json:"GroupBaseInfos,omitnil,omitempty" name:"GroupBaseInfos"`

	// The group members. Array length limit: 200.
	MemberIds []*string `json:"MemberIds,omitnil,omitempty" name:"MemberIds"`
}

Predefined struct for user

type BatchCreateGroupWithMembersResponse 

type BatchCreateGroupWithMembersResponse struct {
	*tchttp.BaseResponse
	Response *BatchCreateGroupWithMembersResponseParams `json:"Response"`
}

func NewBatchCreateGroupWithMembersResponse 

func NewBatchCreateGroupWithMembersResponse() (response *BatchCreateGroupWithMembersResponse)

func (*BatchCreateGroupWithMembersResponse) FromJsonString 

func (r *BatchCreateGroupWithMembersResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BatchCreateGroupWithMembersResponse) ToJsonString 

func (r *BatchCreateGroupWithMembersResponse) ToJsonString() string

type BatchCreateGroupWithMembersResponseParams 

type BatchCreateGroupWithMembersResponseParams struct {
	// The IDs of the groups created, which are in the same order as the elements in the request parameter `GroupBaseInfos.N`.
	GroupIds []*string `json:"GroupIds,omitnil,omitempty" name:"GroupIds"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type BatchCreateRoomRequest 

type BatchCreateRoomRequest struct {
	*tchttp.BaseRequest

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The information of the rooms to create.
	RoomInfos []*RoomInfo `json:"RoomInfos,omitnil,omitempty" name:"RoomInfos"`
}

func NewBatchCreateRoomRequest 

func NewBatchCreateRoomRequest() (request *BatchCreateRoomRequest)

func (*BatchCreateRoomRequest) FromJsonString 

func (r *BatchCreateRoomRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BatchCreateRoomRequest) ToJsonString 

func (r *BatchCreateRoomRequest) ToJsonString() string

type BatchCreateRoomRequestParams 

type BatchCreateRoomRequestParams struct {
	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The information of the rooms to create.
	RoomInfos []*RoomInfo `json:"RoomInfos,omitnil,omitempty" name:"RoomInfos"`
}

Predefined struct for user

type BatchCreateRoomResponse 

type BatchCreateRoomResponse struct {
	*tchttp.BaseResponse
	Response *BatchCreateRoomResponseParams `json:"Response"`
}

func NewBatchCreateRoomResponse 

func NewBatchCreateRoomResponse() (response *BatchCreateRoomResponse)

func (*BatchCreateRoomResponse) FromJsonString 

func (r *BatchCreateRoomResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BatchCreateRoomResponse) ToJsonString 

func (r *BatchCreateRoomResponse) ToJsonString() string

type BatchCreateRoomResponseParams 

type BatchCreateRoomResponseParams struct {
	// The IDs of the rooms created, which are in the same order as they are passed in.
	RoomIds []*uint64 `json:"RoomIds,omitnil,omitempty" name:"RoomIds"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type BatchDeleteGroupMemberRequest 

type BatchDeleteGroupMemberRequest struct {
	*tchttp.BaseRequest

	// The target group IDs. Array length limit: 100.
	GroupIds []*string `json:"GroupIds,omitnil,omitempty" name:"GroupIds"`

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The users to remove. Array length limit: 256.
	MemberIds []*string `json:"MemberIds,omitnil,omitempty" name:"MemberIds"`
}

func NewBatchDeleteGroupMemberRequest 

func NewBatchDeleteGroupMemberRequest() (request *BatchDeleteGroupMemberRequest)

func (*BatchDeleteGroupMemberRequest) FromJsonString 

func (r *BatchDeleteGroupMemberRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BatchDeleteGroupMemberRequest) ToJsonString 

func (r *BatchDeleteGroupMemberRequest) ToJsonString() string

type BatchDeleteGroupMemberRequestParams 

type BatchDeleteGroupMemberRequestParams struct {
	// The target group IDs. Array length limit: 100.
	GroupIds []*string `json:"GroupIds,omitnil,omitempty" name:"GroupIds"`

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The users to remove. Array length limit: 256.
	MemberIds []*string `json:"MemberIds,omitnil,omitempty" name:"MemberIds"`
}

Predefined struct for user

type BatchDeleteGroupMemberResponse 

type BatchDeleteGroupMemberResponse struct {
	*tchttp.BaseResponse
	Response *BatchDeleteGroupMemberResponseParams `json:"Response"`
}

func NewBatchDeleteGroupMemberResponse 

func NewBatchDeleteGroupMemberResponse() (response *BatchDeleteGroupMemberResponse)

func (*BatchDeleteGroupMemberResponse) FromJsonString 

func (r *BatchDeleteGroupMemberResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BatchDeleteGroupMemberResponse) ToJsonString 

func (r *BatchDeleteGroupMemberResponse) ToJsonString() string

type BatchDeleteGroupMemberResponseParams 

type BatchDeleteGroupMemberResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type BatchDeleteRecordRequest 

type BatchDeleteRecordRequest struct {
	*tchttp.BaseRequest

	// The room IDs.
	RoomIds []*int64 `json:"RoomIds,omitnil,omitempty" name:"RoomIds"`

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

func NewBatchDeleteRecordRequest 

func NewBatchDeleteRecordRequest() (request *BatchDeleteRecordRequest)

func (*BatchDeleteRecordRequest) FromJsonString 

func (r *BatchDeleteRecordRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BatchDeleteRecordRequest) ToJsonString 

func (r *BatchDeleteRecordRequest) ToJsonString() string

type BatchDeleteRecordRequestParams 

type BatchDeleteRecordRequestParams struct {
	// The room IDs.
	RoomIds []*int64 `json:"RoomIds,omitnil,omitempty" name:"RoomIds"`

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

Predefined struct for user

type BatchDeleteRecordResponse 

type BatchDeleteRecordResponse struct {
	*tchttp.BaseResponse
	Response *BatchDeleteRecordResponseParams `json:"Response"`
}

func NewBatchDeleteRecordResponse 

func NewBatchDeleteRecordResponse() (response *BatchDeleteRecordResponse)

func (*BatchDeleteRecordResponse) FromJsonString 

func (r *BatchDeleteRecordResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BatchDeleteRecordResponse) ToJsonString 

func (r *BatchDeleteRecordResponse) ToJsonString() string

type BatchDeleteRecordResponseParams 

type BatchDeleteRecordResponseParams struct {
	// The IDs of the rooms whose recordings are deleted. Note: This field may return null, indicating that no valid values can be obtained.
	RoomIds []*int64 `json:"RoomIds,omitnil,omitempty" name:"RoomIds"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type BatchDescribeDocumentRequest 

type BatchDescribeDocumentRequest struct {
	*tchttp.BaseRequest

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The page to return records from. Pagination starts from 1.
	Page *int64 `json:"Page,omitnil,omitempty" name:"Page"`

	// The maximum number of records per page. The value of this parameter cannot exceed `1000`.
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// The courseware access. [0]: The private courseware of the specified user (`Owner`) will be returned; [1]: The public courseware of the specified user will be returned; [0,1]: Both the private and public courseware of the specified user will be returned; [2]: The private courseware of the specified user and the public courseware of all users (including `Owner`) will be returned.
	Permission []*uint64 `json:"Permission,omitnil,omitempty" name:"Permission"`

	// The user ID of the courseware owner. If you do not specify this, the information of all courseware under the application will be returned.
	Owner *string `json:"Owner,omitnil,omitempty" name:"Owner"`

	// The filename keyword.
	Keyword *string `json:"Keyword,omitnil,omitempty" name:"Keyword"`

	// The courseware IDs. Non-existent IDs will be ignored.
	DocumentId []*string `json:"DocumentId,omitnil,omitempty" name:"DocumentId"`
}

func NewBatchDescribeDocumentRequest 

func NewBatchDescribeDocumentRequest() (request *BatchDescribeDocumentRequest)

func (*BatchDescribeDocumentRequest) FromJsonString 

func (r *BatchDescribeDocumentRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BatchDescribeDocumentRequest) ToJsonString 

func (r *BatchDescribeDocumentRequest) ToJsonString() string

type BatchDescribeDocumentRequestParams 

type BatchDescribeDocumentRequestParams struct {
	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The page to return records from. Pagination starts from 1.
	Page *int64 `json:"Page,omitnil,omitempty" name:"Page"`

	// The maximum number of records per page. The value of this parameter cannot exceed `1000`.
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// The courseware access. [0]: The private courseware of the specified user (`Owner`) will be returned; [1]: The public courseware of the specified user will be returned; [0,1]: Both the private and public courseware of the specified user will be returned; [2]: The private courseware of the specified user and the public courseware of all users (including `Owner`) will be returned.
	Permission []*uint64 `json:"Permission,omitnil,omitempty" name:"Permission"`

	// The user ID of the courseware owner. If you do not specify this, the information of all courseware under the application will be returned.
	Owner *string `json:"Owner,omitnil,omitempty" name:"Owner"`

	// The filename keyword.
	Keyword *string `json:"Keyword,omitnil,omitempty" name:"Keyword"`

	// The courseware IDs. Non-existent IDs will be ignored.
	DocumentId []*string `json:"DocumentId,omitnil,omitempty" name:"DocumentId"`
}

Predefined struct for user

type BatchDescribeDocumentResponse 

type BatchDescribeDocumentResponse struct {
	*tchttp.BaseResponse
	Response *BatchDescribeDocumentResponseParams `json:"Response"`
}

func NewBatchDescribeDocumentResponse 

func NewBatchDescribeDocumentResponse() (response *BatchDescribeDocumentResponse)

func (*BatchDescribeDocumentResponse) FromJsonString 

func (r *BatchDescribeDocumentResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BatchDescribeDocumentResponse) ToJsonString 

func (r *BatchDescribeDocumentResponse) ToJsonString() string

type BatchDescribeDocumentResponseParams 

type BatchDescribeDocumentResponseParams struct {
	// The total number of records that meet the conditions.
	Total *int64 `json:"Total,omitnil,omitempty" name:"Total"`

	// The information of the courseware.
	// Note: This field may return null, indicating that no valid values can be obtained.
	Documents []*DocumentInfo `json:"Documents,omitnil,omitempty" name:"Documents"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type BatchRegisterRequest 

type BatchRegisterRequest struct {
	*tchttp.BaseRequest

	// The information of the users to register.
	Users []*BatchUserRequest `json:"Users,omitnil,omitempty" name:"Users"`
}

func NewBatchRegisterRequest 

func NewBatchRegisterRequest() (request *BatchRegisterRequest)

func (*BatchRegisterRequest) FromJsonString 

func (r *BatchRegisterRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BatchRegisterRequest) ToJsonString 

func (r *BatchRegisterRequest) ToJsonString() string

type BatchRegisterRequestParams 

type BatchRegisterRequestParams struct {
	// The information of the users to register.
	Users []*BatchUserRequest `json:"Users,omitnil,omitempty" name:"Users"`
}

Predefined struct for user

type BatchRegisterResponse 

type BatchRegisterResponse struct {
	*tchttp.BaseResponse
	Response *BatchRegisterResponseParams `json:"Response"`
}

func NewBatchRegisterResponse 

func NewBatchRegisterResponse() (response *BatchRegisterResponse)

func (*BatchRegisterResponse) FromJsonString 

func (r *BatchRegisterResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BatchRegisterResponse) ToJsonString 

func (r *BatchRegisterResponse) ToJsonString() string

type BatchRegisterResponseParams 

type BatchRegisterResponseParams struct {
	// The information of the successfully registered users. Note: This field may return null, indicating that no valid values can be obtained.
	Users []*BatchUserInfo `json:"Users,omitnil,omitempty" name:"Users"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type BatchUserInfo 

type BatchUserInfo struct {
	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	//
	// Note: This field may return null, indicating that no valid values can be obtained.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	//
	// Note: This field may return null, indicating that no valid values can be obtained.
	OriginId *string `json:"OriginId,omitnil,omitempty" name:"OriginId"`
}

type BatchUserRequest 

type BatchUserRequest struct {
	// The SDKAppID assigned by LCIC.  Note: This field may return null, indicating that no valid values can be obtained.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The username.  Note: This field may return null, indicating that no valid values can be obtained.
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// The user’s ID in your system, which must be unique across the same application.  Note: This field may return null, indicating that no valid values can be obtained.
	OriginId *string `json:"OriginId,omitnil,omitempty" name:"OriginId"`

	// The user’s profile photo.  Note: This field may return null, indicating that no valid values can be obtained.
	Avatar *string `json:"Avatar,omitnil,omitempty" name:"Avatar"`
}

type BindDocumentToRoomRequest 

type BindDocumentToRoomRequest struct {
	*tchttp.BaseRequest

	// Room ID
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// Document ID
	DocumentId *string `json:"DocumentId,omitnil,omitempty" name:"DocumentId"`

	// Binding type. The default value is `0`. The backend passes through this parameter to clients so that the clients can implement business logic based on this parameter.
	BindType *uint64 `json:"BindType,omitnil,omitempty" name:"BindType"`
}

func NewBindDocumentToRoomRequest 

func NewBindDocumentToRoomRequest() (request *BindDocumentToRoomRequest)

func (*BindDocumentToRoomRequest) FromJsonString 

func (r *BindDocumentToRoomRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BindDocumentToRoomRequest) ToJsonString 

func (r *BindDocumentToRoomRequest) ToJsonString() string

type BindDocumentToRoomRequestParams 

type BindDocumentToRoomRequestParams struct {
	// Room ID
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// Document ID
	DocumentId *string `json:"DocumentId,omitnil,omitempty" name:"DocumentId"`

	// Binding type. The default value is `0`. The backend passes through this parameter to clients so that the clients can implement business logic based on this parameter.
	BindType *uint64 `json:"BindType,omitnil,omitempty" name:"BindType"`
}

Predefined struct for user

type BindDocumentToRoomResponse 

type BindDocumentToRoomResponse struct {
	*tchttp.BaseResponse
	Response *BindDocumentToRoomResponseParams `json:"Response"`
}

func NewBindDocumentToRoomResponse 

func NewBindDocumentToRoomResponse() (response *BindDocumentToRoomResponse)

func (*BindDocumentToRoomResponse) FromJsonString 

func (r *BindDocumentToRoomResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BindDocumentToRoomResponse) ToJsonString 

func (r *BindDocumentToRoomResponse) ToJsonString() string

type BindDocumentToRoomResponseParams 

type BindDocumentToRoomResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type Client 

type Client struct {
	common.Client
}

func NewClient 

func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)

func NewClientWithSecretId 

func NewClientWithSecretId(secretId, secretKey, region string) (client *Client, err error)

Deprecated

func (*Client) AddGroupMember 

func (c *Client) AddGroupMember(request *AddGroupMemberRequest) (response *AddGroupMemberResponse, err error)

AddGroupMember This API is used to add users to a group.

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_GROUPMEMBEROVERLIMIT = "InvalidParameter.GroupMemberOverLimit"
INVALIDPARAMETER_GROUPTEACHERNOTMEMBER = "InvalidParameter.GroupTeacherNotMember"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCENOTFOUND_GROUPPARTUSERSNOTEXIST = "ResourceNotFound.GroupPartUsersNotExist"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) AddGroupMemberWithContext 

func (c *Client) AddGroupMemberWithContext(ctx context.Context, request *AddGroupMemberRequest) (response *AddGroupMemberResponse, err error)

AddGroupMember This API is used to add users to a group.

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_GROUPMEMBEROVERLIMIT = "InvalidParameter.GroupMemberOverLimit"
INVALIDPARAMETER_GROUPTEACHERNOTMEMBER = "InvalidParameter.GroupTeacherNotMember"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCENOTFOUND_GROUPPARTUSERSNOTEXIST = "ResourceNotFound.GroupPartUsersNotExist"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) BatchAddGroupMember 

func (c *Client) BatchAddGroupMember(request *BatchAddGroupMemberRequest) (response *BatchAddGroupMemberResponse, err error)

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

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_GROUPMEMBEROVERLIMIT = "InvalidParameter.GroupMemberOverLimit"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCENOTFOUND_GROUPPARTUSERSNOTEXIST = "ResourceNotFound.GroupPartUsersNotExist"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) BatchAddGroupMemberWithContext 

func (c *Client) BatchAddGroupMemberWithContext(ctx context.Context, request *BatchAddGroupMemberRequest) (response *BatchAddGroupMemberResponse, err error)

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

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_GROUPMEMBEROVERLIMIT = "InvalidParameter.GroupMemberOverLimit"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCENOTFOUND_GROUPPARTUSERSNOTEXIST = "ResourceNotFound.GroupPartUsersNotExist"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) BatchCreateGroupWithMembers 

func (c *Client) BatchCreateGroupWithMembers(request *BatchCreateGroupWithMembersRequest) (response *BatchCreateGroupWithMembersResponse, err error)

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

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_GROUPMEMBEROVERLIMIT = "InvalidParameter.GroupMemberOverLimit"
INVALIDPARAMETER_GROUPPARAMINVALID = "InvalidParameter.GroupParamInvalid"
INVALIDPARAMETER_GROUPTEACHERNOTMEMBER = "InvalidParameter.GroupTeacherNotMember"
INVALIDPARAMETER_GROUPTEACHERSNOTEXIST = "InvalidParameter.GroupTeachersNotExist"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCENOTFOUND_GROUPPARTUSERSNOTEXIST = "ResourceNotFound.GroupPartUsersNotExist"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) BatchCreateGroupWithMembersWithContext 

func (c *Client) BatchCreateGroupWithMembersWithContext(ctx context.Context, request *BatchCreateGroupWithMembersRequest) (response *BatchCreateGroupWithMembersResponse, err error)

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

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_GROUPMEMBEROVERLIMIT = "InvalidParameter.GroupMemberOverLimit"
INVALIDPARAMETER_GROUPPARAMINVALID = "InvalidParameter.GroupParamInvalid"
INVALIDPARAMETER_GROUPTEACHERNOTMEMBER = "InvalidParameter.GroupTeacherNotMember"
INVALIDPARAMETER_GROUPTEACHERSNOTEXIST = "InvalidParameter.GroupTeachersNotExist"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCENOTFOUND_GROUPPARTUSERSNOTEXIST = "ResourceNotFound.GroupPartUsersNotExist"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) BatchCreateRoom 

func (c *Client) BatchCreateRoom(request *BatchCreateRoomRequest) (response *BatchCreateRoomResponse, err error)

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

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
FAILEDOPERATION_CLASSTOOLONG = "FailedOperation.ClassTooLong"
FAILEDOPERATION_IMAGEARGINVALID = "FailedOperation.ImageArgInvalid"
FAILEDOPERATION_ORIGINIDEXISTS = "FailedOperation.OriginIdExists"
FAILEDOPERATION_ROOMNOTEND = "FailedOperation.RoomNotEnd"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_ENDTIME = "InvalidParameter.EndTime"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTIME = "InvalidParameter.StartTime"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEINSUFFICIENT_RECORD = "ResourceInsufficient.Record"
RESOURCEINSUFFICIENT_ROOM = "ResourceInsufficient.Room"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_ROOMSTATISTICS = "ResourceUnavailable.RoomStatistics"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) BatchCreateRoomWithContext 

func (c *Client) BatchCreateRoomWithContext(ctx context.Context, request *BatchCreateRoomRequest) (response *BatchCreateRoomResponse, err error)

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

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
FAILEDOPERATION_CLASSTOOLONG = "FailedOperation.ClassTooLong"
FAILEDOPERATION_IMAGEARGINVALID = "FailedOperation.ImageArgInvalid"
FAILEDOPERATION_ORIGINIDEXISTS = "FailedOperation.OriginIdExists"
FAILEDOPERATION_ROOMNOTEND = "FailedOperation.RoomNotEnd"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_ENDTIME = "InvalidParameter.EndTime"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTIME = "InvalidParameter.StartTime"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEINSUFFICIENT_RECORD = "ResourceInsufficient.Record"
RESOURCEINSUFFICIENT_ROOM = "ResourceInsufficient.Room"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_ROOMSTATISTICS = "ResourceUnavailable.RoomStatistics"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) BatchDeleteGroupMember 

func (c *Client) BatchDeleteGroupMember(request *BatchDeleteGroupMemberRequest) (response *BatchDeleteGroupMemberResponse, err error)

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

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_GROUPMEMBEROVERLIMIT = "InvalidParameter.GroupMemberOverLimit"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCENOTFOUND_GROUPPARTUSERSNOTEXIST = "ResourceNotFound.GroupPartUsersNotExist"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"

func (*Client) BatchDeleteGroupMemberWithContext 

func (c *Client) BatchDeleteGroupMemberWithContext(ctx context.Context, request *BatchDeleteGroupMemberRequest) (response *BatchDeleteGroupMemberResponse, err error)

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

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_GROUPMEMBEROVERLIMIT = "InvalidParameter.GroupMemberOverLimit"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCENOTFOUND_GROUPPARTUSERSNOTEXIST = "ResourceNotFound.GroupPartUsersNotExist"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"

func (*Client) BatchDeleteRecord 

func (c *Client) BatchDeleteRecord(request *BatchDeleteRecordRequest) (response *BatchDeleteRecordResponse, err error)

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

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"

func (*Client) BatchDeleteRecordWithContext 

func (c *Client) BatchDeleteRecordWithContext(ctx context.Context, request *BatchDeleteRecordRequest) (response *BatchDeleteRecordResponse, err error)

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

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"

func (*Client) BatchDescribeDocument 

func (c *Client) BatchDescribeDocument(request *BatchDescribeDocumentRequest) (response *BatchDescribeDocumentResponse, err error)

BatchDescribeDocument This API is used to get courseware information.

error code that may be returned: 

INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) BatchDescribeDocumentWithContext 

func (c *Client) BatchDescribeDocumentWithContext(ctx context.Context, request *BatchDescribeDocumentRequest) (response *BatchDescribeDocumentResponse, err error)

BatchDescribeDocument This API is used to get courseware information.

error code that may be returned: 

INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) BatchRegister 

func (c *Client) BatchRegister(request *BatchRegisterRequest) (response *BatchRegisterResponse, err error)

BatchRegister 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.

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) BatchRegisterWithContext 

func (c *Client) BatchRegisterWithContext(ctx context.Context, request *BatchRegisterRequest) (response *BatchRegisterResponse, err error)

BatchRegister 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.

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) BindDocumentToRoom 

func (c *Client) BindDocumentToRoom(request *BindDocumentToRoomRequest) (response *BindDocumentToRoomResponse, err error)

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

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"

func (*Client) BindDocumentToRoomWithContext 

func (c *Client) BindDocumentToRoomWithContext(ctx context.Context, request *BindDocumentToRoomRequest) (response *BindDocumentToRoomResponse, err error)

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

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"

func (*Client) CreateDocument 

func (c *Client) CreateDocument(request *CreateDocumentRequest) (response *CreateDocumentResponse, err error)

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

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"

func (*Client) CreateDocumentWithContext 

func (c *Client) CreateDocumentWithContext(ctx context.Context, request *CreateDocumentRequest) (response *CreateDocumentResponse, err error)

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

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"

func (*Client) CreateGroupWithMembers 

func (c *Client) CreateGroupWithMembers(request *CreateGroupWithMembersRequest) (response *CreateGroupWithMembersResponse, err error)

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

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_GROUPMEMBEROVERLIMIT = "InvalidParameter.GroupMemberOverLimit"
INVALIDPARAMETER_GROUPPARAMINVALID = "InvalidParameter.GroupParamInvalid"
INVALIDPARAMETER_GROUPTEACHERNOTMEMBER = "InvalidParameter.GroupTeacherNotMember"
INVALIDPARAMETER_GROUPTEACHERSNOTEXIST = "InvalidParameter.GroupTeachersNotExist"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCENOTFOUND_GROUPPARTUSERSNOTEXIST = "ResourceNotFound.GroupPartUsersNotExist"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) CreateGroupWithMembersWithContext 

func (c *Client) CreateGroupWithMembersWithContext(ctx context.Context, request *CreateGroupWithMembersRequest) (response *CreateGroupWithMembersResponse, err error)

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

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_GROUPMEMBEROVERLIMIT = "InvalidParameter.GroupMemberOverLimit"
INVALIDPARAMETER_GROUPPARAMINVALID = "InvalidParameter.GroupParamInvalid"
INVALIDPARAMETER_GROUPTEACHERNOTMEMBER = "InvalidParameter.GroupTeacherNotMember"
INVALIDPARAMETER_GROUPTEACHERSNOTEXIST = "InvalidParameter.GroupTeachersNotExist"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCENOTFOUND_GROUPPARTUSERSNOTEXIST = "ResourceNotFound.GroupPartUsersNotExist"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) CreateGroupWithSubGroup 

func (c *Client) CreateGroupWithSubGroup(request *CreateGroupWithSubGroupRequest) (response *CreateGroupWithSubGroupResponse, err error)

CreateGroupWithSubGroup This API is used to merge groups.

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_GROUPPARAMINVALID = "InvalidParameter.GroupParamInvalid"
INVALIDPARAMETER_GROUPTEACHERNOTMEMBER = "InvalidParameter.GroupTeacherNotMember"
INVALIDPARAMETER_GROUPTEACHERSNOTEXIST = "InvalidParameter.GroupTeachersNotExist"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCENOTFOUND_GROUPPARTUSERSNOTEXIST = "ResourceNotFound.GroupPartUsersNotExist"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) CreateGroupWithSubGroupWithContext 

func (c *Client) CreateGroupWithSubGroupWithContext(ctx context.Context, request *CreateGroupWithSubGroupRequest) (response *CreateGroupWithSubGroupResponse, err error)

CreateGroupWithSubGroup This API is used to merge groups.

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_GROUPPARAMINVALID = "InvalidParameter.GroupParamInvalid"
INVALIDPARAMETER_GROUPTEACHERNOTMEMBER = "InvalidParameter.GroupTeacherNotMember"
INVALIDPARAMETER_GROUPTEACHERSNOTEXIST = "InvalidParameter.GroupTeachersNotExist"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCENOTFOUND_GROUPPARTUSERSNOTEXIST = "ResourceNotFound.GroupPartUsersNotExist"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) CreateRoom 

func (c *Client) CreateRoom(request *CreateRoomRequest) (response *CreateRoomResponse, err error)

CreateRoom This API is used to create a room.

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSTOOLONG = "FailedOperation.ClassTooLong"
FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_ENDTIME = "InvalidParameter.EndTime"
INVALIDPARAMETER_ROOMTYPEINVALID = "InvalidParameter.RoomTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTIME = "InvalidParameter.StartTime"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEINSUFFICIENT_RECORD = "ResourceInsufficient.Record"
RESOURCEINSUFFICIENT_ROOM = "ResourceInsufficient.Room"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"

func (*Client) CreateRoomWithContext 

func (c *Client) CreateRoomWithContext(ctx context.Context, request *CreateRoomRequest) (response *CreateRoomResponse, err error)

CreateRoom This API is used to create a room.

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSTOOLONG = "FailedOperation.ClassTooLong"
FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_ENDTIME = "InvalidParameter.EndTime"
INVALIDPARAMETER_ROOMTYPEINVALID = "InvalidParameter.RoomTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTIME = "InvalidParameter.StartTime"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEINSUFFICIENT_RECORD = "ResourceInsufficient.Record"
RESOURCEINSUFFICIENT_ROOM = "ResourceInsufficient.Room"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"

func (*Client) CreateSupervisor 

func (c *Client) CreateSupervisor(request *CreateSupervisorRequest) (response *CreateSupervisorResponse, err error)

CreateSupervisor This API is used to create a spectator.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"

func (*Client) CreateSupervisorWithContext 

func (c *Client) CreateSupervisorWithContext(ctx context.Context, request *CreateSupervisorRequest) (response *CreateSupervisorResponse, err error)

CreateSupervisor This API is used to create a spectator.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"

func (*Client) DeleteAppCustomContent 

func (c *Client) DeleteAppCustomContent(request *DeleteAppCustomContentRequest) (response *DeleteAppCustomContentResponse, err error)

DeleteAppCustomContent This API is used to delete the custom elements. The `Scenes` parameter specifies the custom elements to delete. If `Scenes` is empty, all custom elements will be deleted.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) DeleteAppCustomContentWithContext 

func (c *Client) DeleteAppCustomContentWithContext(ctx context.Context, request *DeleteAppCustomContentRequest) (response *DeleteAppCustomContentResponse, err error)

DeleteAppCustomContent This API is used to delete the custom elements. The `Scenes` parameter specifies the custom elements to delete. If `Scenes` is empty, all custom elements will be deleted.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) DeleteDocument 

func (c *Client) DeleteDocument(request *DeleteDocumentRequest) (response *DeleteDocumentResponse, err error)

DeleteDocument This API is used to delete a document.

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

INTERNALERROR = "InternalError"
RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"

func (*Client) DeleteDocumentWithContext 

func (c *Client) DeleteDocumentWithContext(ctx context.Context, request *DeleteDocumentRequest) (response *DeleteDocumentResponse, err error)

DeleteDocument This API is used to delete a document.

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

INTERNALERROR = "InternalError"
RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"

func (*Client) DeleteGroup 

func (c *Client) DeleteGroup(request *DeleteGroupRequest) (response *DeleteGroupResponse, err error)

DeleteGroup This API is used to delete one or multiple groups.

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DeleteGroupMember 

func (c *Client) DeleteGroupMember(request *DeleteGroupMemberRequest) (response *DeleteGroupMemberResponse, err error)

DeleteGroupMember This API is used to remove users from a group.

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_GROUPMEMBEROVERLIMIT = "InvalidParameter.GroupMemberOverLimit"
INVALIDPARAMETER_GROUPPARAMINVALID = "InvalidParameter.GroupParamInvalid"
INVALIDPARAMETER_GROUPTEACHERNOTMEMBER = "InvalidParameter.GroupTeacherNotMember"
INVALIDPARAMETER_GROUPTEACHERSNOTEXIST = "InvalidParameter.GroupTeachersNotExist"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCENOTFOUND_GROUPPARTUSERSNOTEXIST = "ResourceNotFound.GroupPartUsersNotExist"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
UNKNOWNPARAMETER = "UnknownParameter"

func (*Client) DeleteGroupMemberWithContext 

func (c *Client) DeleteGroupMemberWithContext(ctx context.Context, request *DeleteGroupMemberRequest) (response *DeleteGroupMemberResponse, err error)

DeleteGroupMember This API is used to remove users from a group.

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_GROUPMEMBEROVERLIMIT = "InvalidParameter.GroupMemberOverLimit"
INVALIDPARAMETER_GROUPPARAMINVALID = "InvalidParameter.GroupParamInvalid"
INVALIDPARAMETER_GROUPTEACHERNOTMEMBER = "InvalidParameter.GroupTeacherNotMember"
INVALIDPARAMETER_GROUPTEACHERSNOTEXIST = "InvalidParameter.GroupTeachersNotExist"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCENOTFOUND_GROUPPARTUSERSNOTEXIST = "ResourceNotFound.GroupPartUsersNotExist"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
UNKNOWNPARAMETER = "UnknownParameter"

func (*Client) DeleteGroupWithContext 

func (c *Client) DeleteGroupWithContext(ctx context.Context, request *DeleteGroupRequest) (response *DeleteGroupResponse, err error)

DeleteGroup This API is used to delete one or multiple groups.

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DeleteRecord 

func (c *Client) DeleteRecord(request *DeleteRecordRequest) (response *DeleteRecordResponse, err error)

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

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DeleteRecordWithContext 

func (c *Client) DeleteRecordWithContext(ctx context.Context, request *DeleteRecordRequest) (response *DeleteRecordResponse, err error)

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

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DeleteRoom 

func (c *Client) DeleteRoom(request *DeleteRoomRequest) (response *DeleteRoomResponse, err error)

DeleteRoom This API is used to delete a room.

error code that may be returned: 

FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
INTERNALERROR = "InternalError"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"

func (*Client) DeleteRoomWithContext 

func (c *Client) DeleteRoomWithContext(ctx context.Context, request *DeleteRoomRequest) (response *DeleteRoomResponse, err error)

DeleteRoom This API is used to delete a room.

error code that may be returned: 

FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
INTERNALERROR = "InternalError"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"

func (*Client) DeleteSupervisor 

func (c *Client) DeleteSupervisor(request *DeleteSupervisorRequest) (response *DeleteSupervisorResponse, err error)

DeleteSupervisor This API is used to delete spectators.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"

func (*Client) DeleteSupervisorWithContext 

func (c *Client) DeleteSupervisorWithContext(ctx context.Context, request *DeleteSupervisorRequest) (response *DeleteSupervisorResponse, err error)

DeleteSupervisor This API is used to delete spectators.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"

func (*Client) DescribeAnswerList 

func (c *Client) DescribeAnswerList(request *DescribeAnswerListRequest) (response *DescribeAnswerListResponse, err error)

DescribeAnswerList This API is used to get the answers to a quiz question in a room.

error code that may be returned: 

FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND = "ResourceNotFound"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeAnswerListWithContext 

func (c *Client) DescribeAnswerListWithContext(ctx context.Context, request *DescribeAnswerListRequest) (response *DescribeAnswerListResponse, err error)

DescribeAnswerList This API is used to get the answers to a quiz question in a room.

error code that may be returned: 

FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND = "ResourceNotFound"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeCurrentMemberList 

func (c *Client) DescribeCurrentMemberList(request *DescribeCurrentMemberListRequest) (response *DescribeCurrentMemberListResponse, err error)

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

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSENDED = "FailedOperation.ClassEnded"
FAILEDOPERATION_CLASSEXPIRED = "FailedOperation.ClassExpired"
INTERNALERROR = "InternalError"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"

func (*Client) DescribeCurrentMemberListWithContext 

func (c *Client) DescribeCurrentMemberListWithContext(ctx context.Context, request *DescribeCurrentMemberListRequest) (response *DescribeCurrentMemberListResponse, err error)

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

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSENDED = "FailedOperation.ClassEnded"
FAILEDOPERATION_CLASSEXPIRED = "FailedOperation.ClassExpired"
INTERNALERROR = "InternalError"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"

func (*Client) DescribeDeveloper 

func (c *Client) DescribeDeveloper(request *DescribeDeveloperRequest) (response *DescribeDeveloperResponse, err error)

DescribeDeveloper This API is used to get developer information.

error code that may be returned: 

FAILEDOPERATION_CLASSEXPIRED = "FailedOperation.ClassExpired"
FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeDeveloperWithContext 

func (c *Client) DescribeDeveloperWithContext(ctx context.Context, request *DescribeDeveloperRequest) (response *DescribeDeveloperResponse, err error)

DescribeDeveloper This API is used to get developer information.

error code that may be returned: 

FAILEDOPERATION_CLASSEXPIRED = "FailedOperation.ClassExpired"
FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeDocument 

func (c *Client) DescribeDocument(request *DescribeDocumentRequest) (response *DescribeDocumentResponse, err error)

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

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

INTERNALERROR = "InternalError"
RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"

func (*Client) DescribeDocumentWithContext 

func (c *Client) DescribeDocumentWithContext(ctx context.Context, request *DescribeDocumentRequest) (response *DescribeDocumentResponse, err error)

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

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

INTERNALERROR = "InternalError"
RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"

func (*Client) DescribeDocuments 

func (c *Client) DescribeDocuments(request *DescribeDocumentsRequest) (response *DescribeDocumentsResponse, err error)

DescribeDocuments 有新接口替换

A new API is offered for this action now.

This API is used to query courseware. It has been deprecated. Please use `BatchDescribeDocument` instead.

error code that may be returned: 

INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) DescribeDocumentsByRoom 

func (c *Client) DescribeDocumentsByRoom(request *DescribeDocumentsByRoomRequest) (response *DescribeDocumentsByRoomResponse, err error)

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

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
FAILEDOPERATION_CLASSTOOLONG = "FailedOperation.ClassTooLong"
FAILEDOPERATION_IMAGEARGINVALID = "FailedOperation.ImageArgInvalid"
FAILEDOPERATION_ORIGINIDEXISTS = "FailedOperation.OriginIdExists"
FAILEDOPERATION_ROOMNOTEND = "FailedOperation.RoomNotEnd"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_ENDTIME = "InvalidParameter.EndTime"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTIME = "InvalidParameter.StartTime"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEINSUFFICIENT_RECORD = "ResourceInsufficient.Record"
RESOURCEINSUFFICIENT_ROOM = "ResourceInsufficient.Room"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_ROOMSTATISTICS = "ResourceUnavailable.RoomStatistics"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeDocumentsByRoomWithContext 

func (c *Client) DescribeDocumentsByRoomWithContext(ctx context.Context, request *DescribeDocumentsByRoomRequest) (response *DescribeDocumentsByRoomResponse, err error)

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

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
FAILEDOPERATION_CLASSTOOLONG = "FailedOperation.ClassTooLong"
FAILEDOPERATION_IMAGEARGINVALID = "FailedOperation.ImageArgInvalid"
FAILEDOPERATION_ORIGINIDEXISTS = "FailedOperation.OriginIdExists"
FAILEDOPERATION_ROOMNOTEND = "FailedOperation.RoomNotEnd"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_ENDTIME = "InvalidParameter.EndTime"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTIME = "InvalidParameter.StartTime"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEINSUFFICIENT_RECORD = "ResourceInsufficient.Record"
RESOURCEINSUFFICIENT_ROOM = "ResourceInsufficient.Room"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_ROOMSTATISTICS = "ResourceUnavailable.RoomStatistics"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeDocumentsWithContext 

func (c *Client) DescribeDocumentsWithContext(ctx context.Context, request *DescribeDocumentsRequest) (response *DescribeDocumentsResponse, err error)

DescribeDocuments 有新接口替换

A new API is offered for this action now.

This API is used to query courseware. It has been deprecated. Please use `BatchDescribeDocument` instead.

error code that may be returned: 

INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) DescribeGroup 

func (c *Client) DescribeGroup(request *DescribeGroupRequest) (response *DescribeGroupResponse, err error)

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

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_GROUPPARAMINVALID = "InvalidParameter.GroupParamInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeGroupList 

func (c *Client) DescribeGroupList(request *DescribeGroupListRequest) (response *DescribeGroupListResponse, err error)

DescribeGroupList This API is used to query groups.

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_GROUPMEMBEROVERLIMIT = "InvalidParameter.GroupMemberOverLimit"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeGroupListWithContext 

func (c *Client) DescribeGroupListWithContext(ctx context.Context, request *DescribeGroupListRequest) (response *DescribeGroupListResponse, err error)

DescribeGroupList This API is used to query groups.

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_GROUPMEMBEROVERLIMIT = "InvalidParameter.GroupMemberOverLimit"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeGroupMemberList 

func (c *Client) DescribeGroupMemberList(request *DescribeGroupMemberListRequest) (response *DescribeGroupMemberListResponse, err error)

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

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeGroupMemberListWithContext 

func (c *Client) DescribeGroupMemberListWithContext(ctx context.Context, request *DescribeGroupMemberListRequest) (response *DescribeGroupMemberListResponse, err error)

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

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeGroupWithContext 

func (c *Client) DescribeGroupWithContext(ctx context.Context, request *DescribeGroupRequest) (response *DescribeGroupResponse, err error)

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

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_GROUPPARAMINVALID = "InvalidParameter.GroupParamInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeQuestionList 

func (c *Client) DescribeQuestionList(request *DescribeQuestionListRequest) (response *DescribeQuestionListResponse, err error)

DescribeQuestionList This API is used to get the quiz details of a room.

error code that may be returned: 

FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND = "ResourceNotFound"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeQuestionListWithContext 

func (c *Client) DescribeQuestionListWithContext(ctx context.Context, request *DescribeQuestionListRequest) (response *DescribeQuestionListResponse, err error)

DescribeQuestionList This API is used to get the quiz details of a room.

error code that may be returned: 

FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND = "ResourceNotFound"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeRoom 

func (c *Client) DescribeRoom(request *DescribeRoomRequest) (response *DescribeRoomResponse, err error)

DescribeRoom This API is used to get room information.

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"

func (*Client) DescribeRoomStatistics 

func (c *Client) DescribeRoomStatistics(request *DescribeRoomStatisticsRequest) (response *DescribeRoomStatisticsResponse, err error)

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

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ROOMNOTEND = "FailedOperation.RoomNotEnd"
INTERNALERROR = "InternalError"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
RESOURCEUNAVAILABLE_ROOMSTATISTICS = "ResourceUnavailable.RoomStatistics"

func (*Client) DescribeRoomStatisticsWithContext 

func (c *Client) DescribeRoomStatisticsWithContext(ctx context.Context, request *DescribeRoomStatisticsRequest) (response *DescribeRoomStatisticsResponse, err error)

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

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ROOMNOTEND = "FailedOperation.RoomNotEnd"
INTERNALERROR = "InternalError"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
RESOURCEUNAVAILABLE_ROOMSTATISTICS = "ResourceUnavailable.RoomStatistics"

func (*Client) DescribeRoomWithContext 

func (c *Client) DescribeRoomWithContext(ctx context.Context, request *DescribeRoomRequest) (response *DescribeRoomResponse, err error)

DescribeRoom This API is used to get room information.

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"

func (*Client) DescribeSdkAppIdUsers 

func (c *Client) DescribeSdkAppIdUsers(request *DescribeSdkAppIdUsersRequest) (response *DescribeSdkAppIdUsersResponse, err error)

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

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
FAILEDOPERATION_CLASSTOOLONG = "FailedOperation.ClassTooLong"
FAILEDOPERATION_IMAGEARGINVALID = "FailedOperation.ImageArgInvalid"
FAILEDOPERATION_ORIGINIDEXISTS = "FailedOperation.OriginIdExists"
FAILEDOPERATION_ROOMNOTEND = "FailedOperation.RoomNotEnd"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_ENDTIME = "InvalidParameter.EndTime"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTIME = "InvalidParameter.StartTime"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEINSUFFICIENT_RECORD = "ResourceInsufficient.Record"
RESOURCEINSUFFICIENT_ROOM = "ResourceInsufficient.Room"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_ROOMSTATISTICS = "ResourceUnavailable.RoomStatistics"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeSdkAppIdUsersWithContext 

func (c *Client) DescribeSdkAppIdUsersWithContext(ctx context.Context, request *DescribeSdkAppIdUsersRequest) (response *DescribeSdkAppIdUsersResponse, err error)

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

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
FAILEDOPERATION_CLASSTOOLONG = "FailedOperation.ClassTooLong"
FAILEDOPERATION_IMAGEARGINVALID = "FailedOperation.ImageArgInvalid"
FAILEDOPERATION_ORIGINIDEXISTS = "FailedOperation.OriginIdExists"
FAILEDOPERATION_ROOMNOTEND = "FailedOperation.RoomNotEnd"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_ENDTIME = "InvalidParameter.EndTime"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTIME = "InvalidParameter.StartTime"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEINSUFFICIENT_RECORD = "ResourceInsufficient.Record"
RESOURCEINSUFFICIENT_ROOM = "ResourceInsufficient.Room"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_ROOMSTATISTICS = "ResourceUnavailable.RoomStatistics"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeSupervisors 

func (c *Client) DescribeSupervisors(request *DescribeSupervisorsRequest) (response *DescribeSupervisorsResponse, err error)

DescribeSupervisors This API is used to get the spectators of a room.

error code that may be returned: 

FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND = "ResourceNotFound"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeSupervisorsWithContext 

func (c *Client) DescribeSupervisorsWithContext(ctx context.Context, request *DescribeSupervisorsRequest) (response *DescribeSupervisorsResponse, err error)

DescribeSupervisors This API is used to get the spectators of a room.

error code that may be returned: 

FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND = "ResourceNotFound"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeUser 

func (c *Client) DescribeUser(request *DescribeUserRequest) (response *DescribeUserResponse, err error)

DescribeUser This API is used to obtain user profile.

error code that may be returned: 

INTERNALERROR = "InternalError"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"

func (*Client) DescribeUserWithContext 

func (c *Client) DescribeUserWithContext(ctx context.Context, request *DescribeUserRequest) (response *DescribeUserResponse, err error)

DescribeUser This API is used to obtain user profile.

error code that may be returned: 

INTERNALERROR = "InternalError"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"

func (*Client) EndRoom 

func (c *Client) EndRoom(request *EndRoomRequest) (response *EndRoomResponse, err error)

EndRoom This API is used to end a room.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSENDED = "FailedOperation.ClassEnded"
FAILEDOPERATION_CLASSEXPIRED = "FailedOperation.ClassExpired"
FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
FAILEDOPERATION_ROOMNOTEND = "FailedOperation.RoomNotEnd"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) EndRoomWithContext 

func (c *Client) EndRoomWithContext(ctx context.Context, request *EndRoomRequest) (response *EndRoomResponse, err error)

EndRoom This API is used to end a room.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSENDED = "FailedOperation.ClassEnded"
FAILEDOPERATION_CLASSEXPIRED = "FailedOperation.ClassExpired"
FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
FAILEDOPERATION_ROOMNOTEND = "FailedOperation.RoomNotEnd"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) GetRoomEvent 

func (c *Client) GetRoomEvent(request *GetRoomEventRequest) (response *GetRoomEventResponse, err error)

GetRoomEvent This API is used to get the events of a room. It only works within one hour after a class ends.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"

func (*Client) GetRoomEventWithContext 

func (c *Client) GetRoomEventWithContext(ctx context.Context, request *GetRoomEventRequest) (response *GetRoomEventResponse, err error)

GetRoomEvent This API is used to get the events of a room. It only works within one hour after a class ends.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"

func (*Client) GetRoomMessage 

func (c *Client) GetRoomMessage(request *GetRoomMessageRequest) (response *GetRoomMessageResponse, err error)

GetRoomMessage This API is used to get the message history of a room (room messages are retained for seven days).

error code that may be returned: 

FAILEDOPERATION_CLASSENDED = "FailedOperation.ClassEnded"
FAILEDOPERATION_CLASSEXPIRED = "FailedOperation.ClassExpired"
FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
FAILEDOPERATION_ROOMNOTEND = "FailedOperation.RoomNotEnd"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
RESOURCEUNAVAILABLE_ROOMSTATISTICS = "ResourceUnavailable.RoomStatistics"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) GetRoomMessageWithContext 

func (c *Client) GetRoomMessageWithContext(ctx context.Context, request *GetRoomMessageRequest) (response *GetRoomMessageResponse, err error)

GetRoomMessage This API is used to get the message history of a room (room messages are retained for seven days).

error code that may be returned: 

FAILEDOPERATION_CLASSENDED = "FailedOperation.ClassEnded"
FAILEDOPERATION_CLASSEXPIRED = "FailedOperation.ClassExpired"
FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
FAILEDOPERATION_ROOMNOTEND = "FailedOperation.RoomNotEnd"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
RESOURCEUNAVAILABLE_ROOMSTATISTICS = "ResourceUnavailable.RoomStatistics"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) GetRooms 

func (c *Client) GetRooms(request *GetRoomsRequest) (response *GetRoomsResponse, err error)

GetRooms This API is used to get the room list.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSENDED = "FailedOperation.ClassEnded"
FAILEDOPERATION_CLASSEXPIRED = "FailedOperation.ClassExpired"
FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) GetRoomsWithContext 

func (c *Client) GetRoomsWithContext(ctx context.Context, request *GetRoomsRequest) (response *GetRoomsResponse, err error)

GetRooms This API is used to get the room list.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSENDED = "FailedOperation.ClassEnded"
FAILEDOPERATION_CLASSEXPIRED = "FailedOperation.ClassExpired"
FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) GetWatermark 

func (c *Client) GetWatermark(request *GetWatermarkRequest) (response *GetWatermarkResponse, err error)

GetWatermark This API is used to get watermark settings.

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
UNKNOWNPARAMETER = "UnknownParameter"

func (*Client) GetWatermarkWithContext 

func (c *Client) GetWatermarkWithContext(ctx context.Context, request *GetWatermarkRequest) (response *GetWatermarkResponse, err error)

GetWatermark This API is used to get watermark settings.

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
UNKNOWNPARAMETER = "UnknownParameter"

func (*Client) KickUserFromRoom 

func (c *Client) KickUserFromRoom(request *KickUserFromRoomRequest) (response *KickUserFromRoomResponse, err error)

KickUserFromRoom This API is used to remove a user from the room.

error code that may be returned: 

INTERNALERROR = "InternalError"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"

func (*Client) KickUserFromRoomWithContext 

func (c *Client) KickUserFromRoomWithContext(ctx context.Context, request *KickUserFromRoomRequest) (response *KickUserFromRoomResponse, err error)

KickUserFromRoom This API is used to remove a user from the room.

error code that may be returned: 

INTERNALERROR = "InternalError"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"

func (*Client) LoginOriginId 

func (c *Client) LoginOriginId(request *LoginOriginIdRequest) (response *LoginOriginIdResponse, err error)

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

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"

func (*Client) LoginOriginIdWithContext 

func (c *Client) LoginOriginIdWithContext(ctx context.Context, request *LoginOriginIdRequest) (response *LoginOriginIdResponse, err error)

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

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"

func (*Client) LoginUser 

func (c *Client) LoginUser(request *LoginUserRequest) (response *LoginUserResponse, err error)

LoginUser This API is used to log in.

error code that may be returned: 

INTERNALERROR = "InternalError"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"

func (*Client) LoginUserWithContext 

func (c *Client) LoginUserWithContext(ctx context.Context, request *LoginUserRequest) (response *LoginUserResponse, err error)

LoginUser This API is used to log in.

error code that may be returned: 

INTERNALERROR = "InternalError"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"

func (*Client) ModifyApp 

func (c *Client) ModifyApp(request *ModifyAppRequest) (response *ModifyAppResponse, err error)

ModifyApp This API is used to modify an application.

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) ModifyAppWithContext 

func (c *Client) ModifyAppWithContext(ctx context.Context, request *ModifyAppRequest) (response *ModifyAppResponse, err error)

ModifyApp This API is used to modify an application.

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) ModifyGroup 

func (c *Client) ModifyGroup(request *ModifyGroupRequest) (response *ModifyGroupResponse, err error)

ModifyGroup This API is used to modify a group.

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_GROUPPARAMINVALID = "InvalidParameter.GroupParamInvalid"
INVALIDPARAMETER_GROUPTEACHERNOTMEMBER = "InvalidParameter.GroupTeacherNotMember"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCENOTFOUND_GROUPPARTUSERSNOTEXIST = "ResourceNotFound.GroupPartUsersNotExist"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) ModifyGroupWithContext 

func (c *Client) ModifyGroupWithContext(ctx context.Context, request *ModifyGroupRequest) (response *ModifyGroupResponse, err error)

ModifyGroup This API is used to modify a group.

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_GROUPPARAMINVALID = "InvalidParameter.GroupParamInvalid"
INVALIDPARAMETER_GROUPTEACHERNOTMEMBER = "InvalidParameter.GroupTeacherNotMember"
INVALIDPARAMETER_GROUPTYPEINVALID = "InvalidParameter.GroupTypeInvalid"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_GROUPNOTEXIST = "ResourceNotFound.GroupNotExist"
RESOURCENOTFOUND_GROUPPARTUSERSNOTEXIST = "ResourceNotFound.GroupPartUsersNotExist"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) ModifyRoom 

func (c *Client) ModifyRoom(request *ModifyRoomRequest) (response *ModifyRoomResponse, err error)

ModifyRoom This API is used to modify a room.

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSENDED = "FailedOperation.ClassEnded"
FAILEDOPERATION_CLASSEXPIRED = "FailedOperation.ClassExpired"
FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
FAILEDOPERATION_CLASSTOOLONG = "FailedOperation.ClassTooLong"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_ENDTIME = "InvalidParameter.EndTime"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTIME = "InvalidParameter.StartTime"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
UNKNOWNPARAMETER = "UnknownParameter"

func (*Client) ModifyRoomWithContext 

func (c *Client) ModifyRoomWithContext(ctx context.Context, request *ModifyRoomRequest) (response *ModifyRoomResponse, err error)

ModifyRoom This API is used to modify a room.

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSENDED = "FailedOperation.ClassEnded"
FAILEDOPERATION_CLASSEXPIRED = "FailedOperation.ClassExpired"
FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
FAILEDOPERATION_CLASSTOOLONG = "FailedOperation.ClassTooLong"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_ENDTIME = "InvalidParameter.EndTime"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTIME = "InvalidParameter.StartTime"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
UNKNOWNPARAMETER = "UnknownParameter"

func (*Client) ModifyUserProfile 

func (c *Client) ModifyUserProfile(request *ModifyUserProfileRequest) (response *ModifyUserProfileResponse, err error)

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

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
FAILEDOPERATION_CLASSTOOLONG = "FailedOperation.ClassTooLong"
FAILEDOPERATION_IMAGEARGINVALID = "FailedOperation.ImageArgInvalid"
FAILEDOPERATION_ORIGINIDEXISTS = "FailedOperation.OriginIdExists"
FAILEDOPERATION_ROOMNOTEND = "FailedOperation.RoomNotEnd"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_ENDTIME = "InvalidParameter.EndTime"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTIME = "InvalidParameter.StartTime"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEINSUFFICIENT_RECORD = "ResourceInsufficient.Record"
RESOURCEINSUFFICIENT_ROOM = "ResourceInsufficient.Room"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_ROOMSTATISTICS = "ResourceUnavailable.RoomStatistics"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) ModifyUserProfileWithContext 

func (c *Client) ModifyUserProfileWithContext(ctx context.Context, request *ModifyUserProfileRequest) (response *ModifyUserProfileResponse, err error)

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

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
FAILEDOPERATION_CLASSTOOLONG = "FailedOperation.ClassTooLong"
FAILEDOPERATION_IMAGEARGINVALID = "FailedOperation.ImageArgInvalid"
FAILEDOPERATION_ORIGINIDEXISTS = "FailedOperation.OriginIdExists"
FAILEDOPERATION_ROOMNOTEND = "FailedOperation.RoomNotEnd"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_ENDTIME = "InvalidParameter.EndTime"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTIME = "InvalidParameter.StartTime"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEINSUFFICIENT_RECORD = "ResourceInsufficient.Record"
RESOURCEINSUFFICIENT_ROOM = "ResourceInsufficient.Room"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
RESOURCENOTFOUND_USER = "ResourceNotFound.User"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_ROOMSTATISTICS = "ResourceUnavailable.RoomStatistics"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) RegisterUser 

func (c *Client) RegisterUser(request *RegisterUserRequest) (response *RegisterUserResponse, err error)

RegisterUser This API is used to register a user.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ORIGINIDEXISTS = "FailedOperation.OriginIdExists"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) RegisterUserWithContext 

func (c *Client) RegisterUserWithContext(ctx context.Context, request *RegisterUserRequest) (response *RegisterUserResponse, err error)

RegisterUser This API is used to register a user.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ORIGINIDEXISTS = "FailedOperation.OriginIdExists"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) SetAppCustomContent 

func (c *Client) SetAppCustomContent(request *SetAppCustomContentRequest) (response *SetAppCustomContentResponse, err error)

SetAppCustomContent 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.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CSSORJS = "InvalidParameter.CssOrJs"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) SetAppCustomContentWithContext 

func (c *Client) SetAppCustomContentWithContext(ctx context.Context, request *SetAppCustomContentRequest) (response *SetAppCustomContentResponse, err error)

SetAppCustomContent 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.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CSSORJS = "InvalidParameter.CssOrJs"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"

func (*Client) SetWatermark 

func (c *Client) SetWatermark(request *SetWatermarkRequest) (response *SetWatermarkResponse, err error)

SetWatermark This API is used to configure watermarks.

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) SetWatermarkWithContext 

func (c *Client) SetWatermarkWithContext(ctx context.Context, request *SetWatermarkRequest) (response *SetWatermarkResponse, err error)

SetWatermark This API is used to configure watermarks.

A maximum of 20 requests can be initiated per second for this API.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONTENT = "InvalidParameter.Content"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) StartRoom 

func (c *Client) StartRoom(request *StartRoomRequest) (response *StartRoomResponse, err error)

StartRoom This API is used to start a room. Before you call this API, make sure a user has entered the room so that the class is initialized.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSENDED = "FailedOperation.ClassEnded"
FAILEDOPERATION_CLASSEXPIRED = "FailedOperation.ClassExpired"
FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
FAILEDOPERATION_ROOMNOTEND = "FailedOperation.RoomNotEnd"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) StartRoomWithContext 

func (c *Client) StartRoomWithContext(ctx context.Context, request *StartRoomRequest) (response *StartRoomResponse, err error)

StartRoom This API is used to start a room. Before you call this API, make sure a user has entered the room so that the class is initialized.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLASSENDED = "FailedOperation.ClassEnded"
FAILEDOPERATION_CLASSEXPIRED = "FailedOperation.ClassExpired"
FAILEDOPERATION_CLASSSTARTED = "FailedOperation.ClassStarted"
FAILEDOPERATION_REQUESTTIMEDOUT = "FailedOperation.RequestTimedOut"
FAILEDOPERATION_ROOMNOTEND = "FailedOperation.RoomNotEnd"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) UnbindDocumentFromRoom 

func (c *Client) UnbindDocumentFromRoom(request *UnbindDocumentFromRoomRequest) (response *UnbindDocumentFromRoomResponse, err error)

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

error code that may be returned: 

RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"

func (*Client) UnbindDocumentFromRoomWithContext 

func (c *Client) UnbindDocumentFromRoomWithContext(ctx context.Context, request *UnbindDocumentFromRoomRequest) (response *UnbindDocumentFromRoomResponse, err error)

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

error code that may be returned: 

RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"
RESOURCENOTFOUND_ROOM = "ResourceNotFound.Room"

type CreateDocumentRequest 

type CreateDocumentRequest struct {
	*tchttp.BaseRequest

	// LCIC SdkAppId
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Document URL
	DocumentUrl *string `json:"DocumentUrl,omitnil,omitempty" name:"DocumentUrl"`

	// Document name
	DocumentName *string `json:"DocumentName,omitnil,omitempty" name:"DocumentName"`

	// Document owner ID
	Owner *string `json:"Owner,omitnil,omitempty" name:"Owner"`

	// Transcoding type. Valid values: `0`: No transcoding required (default); `1`: Documents that need to be transcoded: ppt, pptx, pdf, doc, docx; `2`: Videos that need to be transcoded: mp4, 3pg, mpeg, avi, flv, wmv, rm, h264, etc.; `2`: Audio that needs to be transcoded: mp3, wav, wma, aac, flac, opus
	TranscodeType *uint64 `json:"TranscodeType,omitnil,omitempty" name:"TranscodeType"`

	// Permission. Valid values: `0`: Private document (default); `1`: Public document
	Permission *uint64 `json:"Permission,omitnil,omitempty" name:"Permission"`

	// Document extension
	DocumentType *string `json:"DocumentType,omitnil,omitempty" name:"DocumentType"`

	// Document size, in bytes
	DocumentSize *uint64 `json:"DocumentSize,omitnil,omitempty" name:"DocumentSize"`

	// Whether or not to enable automatic processing for unsupported elements. Default: off. The automatically processed elements are as follows: 1. Ink: Remove unsupported ink (e.g. WPS Ink) 2. Auto Page Turn: Remove all auto page turn settings on the PPT and set it to mouse click to turn the page 3. Corrupted Audio/Video: Remove references to corrupted audio/video on the PPT
	AutoHandleUnsupportedElement *bool `json:"AutoHandleUnsupportedElement,omitnil,omitempty" name:"AutoHandleUnsupportedElement"`
}

func NewCreateDocumentRequest 

func NewCreateDocumentRequest() (request *CreateDocumentRequest)

func (*CreateDocumentRequest) FromJsonString 

func (r *CreateDocumentRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateDocumentRequest) ToJsonString 

func (r *CreateDocumentRequest) ToJsonString() string

type CreateDocumentRequestParams 

type CreateDocumentRequestParams struct {
	// LCIC SdkAppId
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Document URL
	DocumentUrl *string `json:"DocumentUrl,omitnil,omitempty" name:"DocumentUrl"`

	// Document name
	DocumentName *string `json:"DocumentName,omitnil,omitempty" name:"DocumentName"`

	// Document owner ID
	Owner *string `json:"Owner,omitnil,omitempty" name:"Owner"`

	// Transcoding type. Valid values: `0`: No transcoding required (default); `1`: Documents that need to be transcoded: ppt, pptx, pdf, doc, docx; `2`: Videos that need to be transcoded: mp4, 3pg, mpeg, avi, flv, wmv, rm, h264, etc.; `2`: Audio that needs to be transcoded: mp3, wav, wma, aac, flac, opus
	TranscodeType *uint64 `json:"TranscodeType,omitnil,omitempty" name:"TranscodeType"`

	// Permission. Valid values: `0`: Private document (default); `1`: Public document
	Permission *uint64 `json:"Permission,omitnil,omitempty" name:"Permission"`

	// Document extension
	DocumentType *string `json:"DocumentType,omitnil,omitempty" name:"DocumentType"`

	// Document size, in bytes
	DocumentSize *uint64 `json:"DocumentSize,omitnil,omitempty" name:"DocumentSize"`

	// Whether or not to enable automatic processing for unsupported elements. Default: off. The automatically processed elements are as follows: 1. Ink: Remove unsupported ink (e.g. WPS Ink) 2. Auto Page Turn: Remove all auto page turn settings on the PPT and set it to mouse click to turn the page 3. Corrupted Audio/Video: Remove references to corrupted audio/video on the PPT
	AutoHandleUnsupportedElement *bool `json:"AutoHandleUnsupportedElement,omitnil,omitempty" name:"AutoHandleUnsupportedElement"`
}

Predefined struct for user

type CreateDocumentResponse 

type CreateDocumentResponse struct {
	*tchttp.BaseResponse
	Response *CreateDocumentResponseParams `json:"Response"`
}

func NewCreateDocumentResponse 

func NewCreateDocumentResponse() (response *CreateDocumentResponse)

func (*CreateDocumentResponse) FromJsonString 

func (r *CreateDocumentResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateDocumentResponse) ToJsonString 

func (r *CreateDocumentResponse) ToJsonString() string

type CreateDocumentResponseParams 

type CreateDocumentResponseParams struct {
	// Document ID
	DocumentId *string `json:"DocumentId,omitnil,omitempty" name:"DocumentId"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type CreateGroupWithMembersRequest 

type CreateGroupWithMembersRequest struct {
	*tchttp.BaseRequest

	// The group name.
	GroupName *string `json:"GroupName,omitnil,omitempty" name:"GroupName"`

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The user ID of the teacher.
	TeacherId *string `json:"TeacherId,omitnil,omitempty" name:"TeacherId"`

	// The group members. Array length limit: 200.
	MemberIds []*string `json:"MemberIds,omitnil,omitempty" name:"MemberIds"`
}

func NewCreateGroupWithMembersRequest 

func NewCreateGroupWithMembersRequest() (request *CreateGroupWithMembersRequest)

func (*CreateGroupWithMembersRequest) FromJsonString 

func (r *CreateGroupWithMembersRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateGroupWithMembersRequest) ToJsonString 

func (r *CreateGroupWithMembersRequest) ToJsonString() string

type CreateGroupWithMembersRequestParams 

type CreateGroupWithMembersRequestParams struct {
	// The group name.
	GroupName *string `json:"GroupName,omitnil,omitempty" name:"GroupName"`

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The user ID of the teacher.
	TeacherId *string `json:"TeacherId,omitnil,omitempty" name:"TeacherId"`

	// The group members. Array length limit: 200.
	MemberIds []*string `json:"MemberIds,omitnil,omitempty" name:"MemberIds"`
}

Predefined struct for user

type CreateGroupWithMembersResponse 

type CreateGroupWithMembersResponse struct {
	*tchttp.BaseResponse
	Response *CreateGroupWithMembersResponseParams `json:"Response"`
}

func NewCreateGroupWithMembersResponse 

func NewCreateGroupWithMembersResponse() (response *CreateGroupWithMembersResponse)

func (*CreateGroupWithMembersResponse) FromJsonString 

func (r *CreateGroupWithMembersResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateGroupWithMembersResponse) ToJsonString 

func (r *CreateGroupWithMembersResponse) ToJsonString() string

type CreateGroupWithMembersResponseParams 

type CreateGroupWithMembersResponseParams struct {
	// The ID of the successfully created group.
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type CreateGroupWithSubGroupRequest 

type CreateGroupWithSubGroupRequest struct {
	*tchttp.BaseRequest

	// The group name after merging.
	GroupName *string `json:"GroupName,omitnil,omitempty" name:"GroupName"`

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The IDs of the groups to merge. Duplicate group IDs are not allowed. Array length limit: 40.
	SubGroupIds []*string `json:"SubGroupIds,omitnil,omitempty" name:"SubGroupIds"`

	// The user ID of the teacher.
	TeacherId *string `json:"TeacherId,omitnil,omitempty" name:"TeacherId"`
}

func NewCreateGroupWithSubGroupRequest 

func NewCreateGroupWithSubGroupRequest() (request *CreateGroupWithSubGroupRequest)

func (*CreateGroupWithSubGroupRequest) FromJsonString 

func (r *CreateGroupWithSubGroupRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateGroupWithSubGroupRequest) ToJsonString 

func (r *CreateGroupWithSubGroupRequest) ToJsonString() string

type CreateGroupWithSubGroupRequestParams 

type CreateGroupWithSubGroupRequestParams struct {
	// The group name after merging.
	GroupName *string `json:"GroupName,omitnil,omitempty" name:"GroupName"`

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The IDs of the groups to merge. Duplicate group IDs are not allowed. Array length limit: 40.
	SubGroupIds []*string `json:"SubGroupIds,omitnil,omitempty" name:"SubGroupIds"`

	// The user ID of the teacher.
	TeacherId *string `json:"TeacherId,omitnil,omitempty" name:"TeacherId"`
}

Predefined struct for user

type CreateGroupWithSubGroupResponse 

type CreateGroupWithSubGroupResponse struct {
	*tchttp.BaseResponse
	Response *CreateGroupWithSubGroupResponseParams `json:"Response"`
}

func NewCreateGroupWithSubGroupResponse 

func NewCreateGroupWithSubGroupResponse() (response *CreateGroupWithSubGroupResponse)

func (*CreateGroupWithSubGroupResponse) FromJsonString 

func (r *CreateGroupWithSubGroupResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateGroupWithSubGroupResponse) ToJsonString 

func (r *CreateGroupWithSubGroupResponse) ToJsonString() string

type CreateGroupWithSubGroupResponseParams 

type CreateGroupWithSubGroupResponseParams struct {
	// The ID of the merged group.
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type CreateRoomRequest 

type CreateRoomRequest struct {
	*tchttp.BaseRequest

	// Room name
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// Reserved room start time, in UNIX timestamp format
	StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// Reserved room end time, in UNIX timestamp format
	EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// LCIC SdkAppId
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 	Resolution. Valid values: 1: SD; 2: HD; 3: FHD
	Resolution *uint64 `json:"Resolution,omitnil,omitempty" name:"Resolution"`

	// Maximum number of mic-on users (excluding teachers). Value range: [0, 16]
	MaxMicNumber *uint64 `json:"MaxMicNumber,omitnil,omitempty" name:"MaxMicNumber"`

	// The room subtype. Valid values: videodoc: Document + Video; video: Video only.
	SubType *string `json:"SubType,omitnil,omitempty" name:"SubType"`

	// The user ID of the teacher. User IDs are returned by the user registration APIs. The user specified will have teacher permissions in the room created.
	TeacherId *string `json:"TeacherId,omitnil,omitempty" name:"TeacherId"`

	// Whether to automatically turn the mic on when the user enters a room. Valid values: 0: No (default value); 1: Yes.
	AutoMic *uint64 `json:"AutoMic,omitnil,omitempty" name:"AutoMic"`

	// Whether to disconnect communication after audio/video permissions are revoked. Valid values: `0` (default): Yes; `1`: No.
	TurnOffMic *uint64 `json:"TurnOffMic,omitnil,omitempty" name:"TurnOffMic"`

	// Whether to enable the high audio quality mode. Valid values: 0: No (default value); 1: Yes.
	AudioQuality *uint64 `json:"AudioQuality,omitnil,omitempty" name:"AudioQuality"`

	// Whether to disable auto recording. Valid values: 0: No (default); 1: Yes. If this parameter is 0, recording will start when the class starts and stops when the class ends.
	DisableRecord *uint64 `json:"DisableRecord,omitnil,omitempty" name:"DisableRecord"`

	// The user IDs of the teaching assistants. User IDs are returned by the user registration APIs. The users specified will have teaching assistant permissions in the room created.
	Assistants []*string `json:"Assistants,omitnil,omitempty" name:"Assistants"`

	// The number of RTC users.
	RTCAudienceNumber *uint64 `json:"RTCAudienceNumber,omitnil,omitempty" name:"RTCAudienceNumber"`

	// The audience type.
	AudienceType *uint64 `json:"AudienceType,omitnil,omitempty" name:"AudienceType"`

	// Recording layout
	RecordLayout *uint64 `json:"RecordLayout,omitnil,omitempty" name:"RecordLayout"`

	// The ID of the group to bind. If you specify this parameter, only members of the group can enter this room.
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// Whether the teacher/teaching assistant can control students' cameras/microphones without the students' consent. Valid values:
	// `0` (default): No (consent required)
	// `1`: Yes (no consent required)
	EnableDirectControl *uint64 `json:"EnableDirectControl,omitnil,omitempty" name:"EnableDirectControl"`

	// Turn on focus mode. 0 Watch all character audio and video (default) 1 Watch only teachers and assistants
	InteractionMode *int64 `json:"InteractionMode,omitnil,omitempty" name:"InteractionMode"`

	// Horizontal and vertical screen. 0: Horizontal screen  (default); 1: Vertical screen , currently only support mobile video type
	VideoOrientation *uint64 `json:"VideoOrientation,omitnil,omitempty" name:"VideoOrientation"`

	// Enable after-class grading. 0: not on (default) 1: on
	IsGradingRequiredPostClass *int64 `json:"IsGradingRequiredPostClass,omitnil,omitempty" name:"IsGradingRequiredPostClass"`

	// Room Type: 0 Small Classroom(default); 1 Lecture Hall(public class)
	RoomType *int64 `json:"RoomType,omitnil,omitempty" name:"RoomType"`

	// Drag class time: unit: minutes. 0: no limit (default), -1: can't drag class, greater than 0: the time of dragging class. maximum value: 120 minutes.
	EndDelayTime *int64 `json:"EndDelayTime,omitnil,omitempty" name:"EndDelayTime"`

	// Live type: 0 regular (default) 1 Simulated Live
	LiveType *uint64 `json:"LiveType,omitnil,omitempty" name:"LiveType"`

	// Simulated Live link
	RecordLiveUrl *string `json:"RecordLiveUrl,omitnil,omitempty" name:"RecordLiveUrl"`

	// Whether to start the lesson automatically: 0 not automatic lesson (default) 1 automatic lesson live_type=1 is valid when
	EnableAutoStart *uint64 `json:"EnableAutoStart,omitnil,omitempty" name:"EnableAutoStart"`

	// Recorded file background image, support png, jpg, jpeg, bmp format, does not support transparent channel for the time being
	RecordBackground *string `json:"RecordBackground,omitnil,omitempty" name:"RecordBackground"`

	// Record customized scene, only recordlayout=9 this parameter is valid, the data content for the user-defined scene parameters, data format for the json key-value pairs, where the key-value pairs of the value for the string type.
	RecordScene *string `json:"RecordScene,omitnil,omitempty" name:"RecordScene"`

	// Record customized language, only when recordlayout=9, this parameter is valid.
	RecordLang *string `json:"RecordLang,omitnil,omitempty" name:"RecordLang"`
}

func NewCreateRoomRequest 

func NewCreateRoomRequest() (request *CreateRoomRequest)

func (*CreateRoomRequest) FromJsonString 

func (r *CreateRoomRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateRoomRequest) ToJsonString 

func (r *CreateRoomRequest) ToJsonString() string

type CreateRoomRequestParams 

type CreateRoomRequestParams struct {
	// Room name
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// Reserved room start time, in UNIX timestamp format
	StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// Reserved room end time, in UNIX timestamp format
	EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// LCIC SdkAppId
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 	Resolution. Valid values: 1: SD; 2: HD; 3: FHD
	Resolution *uint64 `json:"Resolution,omitnil,omitempty" name:"Resolution"`

	// Maximum number of mic-on users (excluding teachers). Value range: [0, 16]
	MaxMicNumber *uint64 `json:"MaxMicNumber,omitnil,omitempty" name:"MaxMicNumber"`

	// The room subtype. Valid values: videodoc: Document + Video; video: Video only.
	SubType *string `json:"SubType,omitnil,omitempty" name:"SubType"`

	// The user ID of the teacher. User IDs are returned by the user registration APIs. The user specified will have teacher permissions in the room created.
	TeacherId *string `json:"TeacherId,omitnil,omitempty" name:"TeacherId"`

	// Whether to automatically turn the mic on when the user enters a room. Valid values: 0: No (default value); 1: Yes.
	AutoMic *uint64 `json:"AutoMic,omitnil,omitempty" name:"AutoMic"`

	// Whether to disconnect communication after audio/video permissions are revoked. Valid values: `0` (default): Yes; `1`: No.
	TurnOffMic *uint64 `json:"TurnOffMic,omitnil,omitempty" name:"TurnOffMic"`

	// Whether to enable the high audio quality mode. Valid values: 0: No (default value); 1: Yes.
	AudioQuality *uint64 `json:"AudioQuality,omitnil,omitempty" name:"AudioQuality"`

	// Whether to disable auto recording. Valid values: 0: No (default); 1: Yes. If this parameter is 0, recording will start when the class starts and stops when the class ends.
	DisableRecord *uint64 `json:"DisableRecord,omitnil,omitempty" name:"DisableRecord"`

	// The user IDs of the teaching assistants. User IDs are returned by the user registration APIs. The users specified will have teaching assistant permissions in the room created.
	Assistants []*string `json:"Assistants,omitnil,omitempty" name:"Assistants"`

	// The number of RTC users.
	RTCAudienceNumber *uint64 `json:"RTCAudienceNumber,omitnil,omitempty" name:"RTCAudienceNumber"`

	// The audience type.
	AudienceType *uint64 `json:"AudienceType,omitnil,omitempty" name:"AudienceType"`

	// Recording layout
	RecordLayout *uint64 `json:"RecordLayout,omitnil,omitempty" name:"RecordLayout"`

	// The ID of the group to bind. If you specify this parameter, only members of the group can enter this room.
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// Whether the teacher/teaching assistant can control students' cameras/microphones without the students' consent. Valid values:
	// `0` (default): No (consent required)
	// `1`: Yes (no consent required)
	EnableDirectControl *uint64 `json:"EnableDirectControl,omitnil,omitempty" name:"EnableDirectControl"`

	// Turn on focus mode. 0 Watch all character audio and video (default) 1 Watch only teachers and assistants
	InteractionMode *int64 `json:"InteractionMode,omitnil,omitempty" name:"InteractionMode"`

	// Horizontal and vertical screen. 0: Horizontal screen  (default); 1: Vertical screen , currently only support mobile video type
	VideoOrientation *uint64 `json:"VideoOrientation,omitnil,omitempty" name:"VideoOrientation"`

	// Enable after-class grading. 0: not on (default) 1: on
	IsGradingRequiredPostClass *int64 `json:"IsGradingRequiredPostClass,omitnil,omitempty" name:"IsGradingRequiredPostClass"`

	// Room Type: 0 Small Classroom(default); 1 Lecture Hall(public class)
	RoomType *int64 `json:"RoomType,omitnil,omitempty" name:"RoomType"`

	// Drag class time: unit: minutes. 0: no limit (default), -1: can't drag class, greater than 0: the time of dragging class. maximum value: 120 minutes.
	EndDelayTime *int64 `json:"EndDelayTime,omitnil,omitempty" name:"EndDelayTime"`

	// Live type: 0 regular (default) 1 Simulated Live
	LiveType *uint64 `json:"LiveType,omitnil,omitempty" name:"LiveType"`

	// Simulated Live link
	RecordLiveUrl *string `json:"RecordLiveUrl,omitnil,omitempty" name:"RecordLiveUrl"`

	// Whether to start the lesson automatically: 0 not automatic lesson (default) 1 automatic lesson live_type=1 is valid when
	EnableAutoStart *uint64 `json:"EnableAutoStart,omitnil,omitempty" name:"EnableAutoStart"`

	// Recorded file background image, support png, jpg, jpeg, bmp format, does not support transparent channel for the time being
	RecordBackground *string `json:"RecordBackground,omitnil,omitempty" name:"RecordBackground"`

	// Record customized scene, only recordlayout=9 this parameter is valid, the data content for the user-defined scene parameters, data format for the json key-value pairs, where the key-value pairs of the value for the string type.
	RecordScene *string `json:"RecordScene,omitnil,omitempty" name:"RecordScene"`

	// Record customized language, only when recordlayout=9, this parameter is valid.
	//
	// Deprecated: RecordLang is deprecated.
	RecordLang *string `json:"RecordLang,omitnil,omitempty" name:"RecordLang"`
}

Predefined struct for user

type CreateRoomResponse 

type CreateRoomResponse struct {
	*tchttp.BaseResponse
	Response *CreateRoomResponseParams `json:"Response"`
}

func NewCreateRoomResponse 

func NewCreateRoomResponse() (response *CreateRoomResponse)

func (*CreateRoomResponse) FromJsonString 

func (r *CreateRoomResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateRoomResponse) ToJsonString 

func (r *CreateRoomResponse) ToJsonString() string

type CreateRoomResponseParams 

type CreateRoomResponseParams struct {
	// Room ID
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type CreateSupervisorRequest 

type CreateSupervisorRequest struct {
	*tchttp.BaseRequest

	// The application ID.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The user IDs.
	Users []*string `json:"Users,omitnil,omitempty" name:"Users"`
}

func NewCreateSupervisorRequest 

func NewCreateSupervisorRequest() (request *CreateSupervisorRequest)

func (*CreateSupervisorRequest) FromJsonString 

func (r *CreateSupervisorRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateSupervisorRequest) ToJsonString 

func (r *CreateSupervisorRequest) ToJsonString() string

type CreateSupervisorRequestParams 

type CreateSupervisorRequestParams struct {
	// The application ID.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The user IDs.
	Users []*string `json:"Users,omitnil,omitempty" name:"Users"`
}

Predefined struct for user

type CreateSupervisorResponse 

type CreateSupervisorResponse struct {
	*tchttp.BaseResponse
	Response *CreateSupervisorResponseParams `json:"Response"`
}

func NewCreateSupervisorResponse 

func NewCreateSupervisorResponse() (response *CreateSupervisorResponse)

func (*CreateSupervisorResponse) FromJsonString 

func (r *CreateSupervisorResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateSupervisorResponse) ToJsonString 

func (r *CreateSupervisorResponse) ToJsonString() string

type CreateSupervisorResponseParams 

type CreateSupervisorResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type CustomMsgContent 

type CustomMsgContent struct {
	// Custom message data.
	Data *string `json:"Data,omitnil,omitempty" name:"Data"`

	// Customize the message description information.
	Desc *string `json:"Desc,omitnil,omitempty" name:"Desc"`

	// Extended Fields
	Ext *string `json:"Ext,omitnil,omitempty" name:"Ext"`
}

type DeleteAppCustomContentRequest 

type DeleteAppCustomContentRequest struct {
	*tchttp.BaseRequest

	// The application ID.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The custom elements (for which a scene has been configured) to delete. If this is empty, all custom elements will be deleted.
	Scenes []*string `json:"Scenes,omitnil,omitempty" name:"Scenes"`
}

func NewDeleteAppCustomContentRequest 

func NewDeleteAppCustomContentRequest() (request *DeleteAppCustomContentRequest)

func (*DeleteAppCustomContentRequest) FromJsonString 

func (r *DeleteAppCustomContentRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteAppCustomContentRequest) ToJsonString 

func (r *DeleteAppCustomContentRequest) ToJsonString() string

type DeleteAppCustomContentRequestParams 

type DeleteAppCustomContentRequestParams struct {
	// The application ID.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The custom elements (for which a scene has been configured) to delete. If this is empty, all custom elements will be deleted.
	Scenes []*string `json:"Scenes,omitnil,omitempty" name:"Scenes"`
}

Predefined struct for user

type DeleteAppCustomContentResponse 

type DeleteAppCustomContentResponse struct {
	*tchttp.BaseResponse
	Response *DeleteAppCustomContentResponseParams `json:"Response"`
}

func NewDeleteAppCustomContentResponse 

func NewDeleteAppCustomContentResponse() (response *DeleteAppCustomContentResponse)

func (*DeleteAppCustomContentResponse) FromJsonString 

func (r *DeleteAppCustomContentResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteAppCustomContentResponse) ToJsonString 

func (r *DeleteAppCustomContentResponse) ToJsonString() string

type DeleteAppCustomContentResponseParams 

type DeleteAppCustomContentResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeleteDocumentRequest 

type DeleteDocumentRequest struct {
	*tchttp.BaseRequest

	// The document ID.
	DocumentId *string `json:"DocumentId,omitnil,omitempty" name:"DocumentId"`
}

func NewDeleteDocumentRequest 

func NewDeleteDocumentRequest() (request *DeleteDocumentRequest)

func (*DeleteDocumentRequest) FromJsonString 

func (r *DeleteDocumentRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteDocumentRequest) ToJsonString 

func (r *DeleteDocumentRequest) ToJsonString() string

type DeleteDocumentRequestParams 

type DeleteDocumentRequestParams struct {
	// The document ID.
	DocumentId *string `json:"DocumentId,omitnil,omitempty" name:"DocumentId"`
}

Predefined struct for user

type DeleteDocumentResponse 

type DeleteDocumentResponse struct {
	*tchttp.BaseResponse
	Response *DeleteDocumentResponseParams `json:"Response"`
}

func NewDeleteDocumentResponse 

func NewDeleteDocumentResponse() (response *DeleteDocumentResponse)

func (*DeleteDocumentResponse) FromJsonString 

func (r *DeleteDocumentResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteDocumentResponse) ToJsonString 

func (r *DeleteDocumentResponse) ToJsonString() string

type DeleteDocumentResponseParams 

type DeleteDocumentResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeleteGroupMemberRequest 

type DeleteGroupMemberRequest struct {
	*tchttp.BaseRequest

	// The group ID. You cannot remove members from a merged group.
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The users. Array length limit: 200.
	MemberIds []*string `json:"MemberIds,omitnil,omitempty" name:"MemberIds"`
}

func NewDeleteGroupMemberRequest 

func NewDeleteGroupMemberRequest() (request *DeleteGroupMemberRequest)

func (*DeleteGroupMemberRequest) FromJsonString 

func (r *DeleteGroupMemberRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteGroupMemberRequest) ToJsonString 

func (r *DeleteGroupMemberRequest) ToJsonString() string

type DeleteGroupMemberRequestParams 

type DeleteGroupMemberRequestParams struct {
	// The group ID. You cannot remove members from a merged group.
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The users. Array length limit: 200.
	MemberIds []*string `json:"MemberIds,omitnil,omitempty" name:"MemberIds"`
}

Predefined struct for user

type DeleteGroupMemberResponse 

type DeleteGroupMemberResponse struct {
	*tchttp.BaseResponse
	Response *DeleteGroupMemberResponseParams `json:"Response"`
}

func NewDeleteGroupMemberResponse 

func NewDeleteGroupMemberResponse() (response *DeleteGroupMemberResponse)

func (*DeleteGroupMemberResponse) FromJsonString 

func (r *DeleteGroupMemberResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteGroupMemberResponse) ToJsonString 

func (r *DeleteGroupMemberResponse) ToJsonString() string

type DeleteGroupMemberResponseParams 

type DeleteGroupMemberResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeleteGroupRequest 

type DeleteGroupRequest struct {
	*tchttp.BaseRequest

	// The IDs of the groups to delete.
	GroupIds []*string `json:"GroupIds,omitnil,omitempty" name:"GroupIds"`

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

func NewDeleteGroupRequest 

func NewDeleteGroupRequest() (request *DeleteGroupRequest)

func (*DeleteGroupRequest) FromJsonString 

func (r *DeleteGroupRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteGroupRequest) ToJsonString 

func (r *DeleteGroupRequest) ToJsonString() string

type DeleteGroupRequestParams 

type DeleteGroupRequestParams struct {
	// The IDs of the groups to delete.
	GroupIds []*string `json:"GroupIds,omitnil,omitempty" name:"GroupIds"`

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

Predefined struct for user

type DeleteGroupResponse 

type DeleteGroupResponse struct {
	*tchttp.BaseResponse
	Response *DeleteGroupResponseParams `json:"Response"`
}

func NewDeleteGroupResponse 

func NewDeleteGroupResponse() (response *DeleteGroupResponse)

func (*DeleteGroupResponse) FromJsonString 

func (r *DeleteGroupResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteGroupResponse) ToJsonString 

func (r *DeleteGroupResponse) ToJsonString() string

type DeleteGroupResponseParams 

type DeleteGroupResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeleteRecordRequest 

type DeleteRecordRequest struct {
	*tchttp.BaseRequest

	// The room ID.
	RoomId *int64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// The SDKAppID assigned by LCIC.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

func NewDeleteRecordRequest 

func NewDeleteRecordRequest() (request *DeleteRecordRequest)

func (*DeleteRecordRequest) FromJsonString 

func (r *DeleteRecordRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteRecordRequest) ToJsonString 

func (r *DeleteRecordRequest) ToJsonString() string

type DeleteRecordRequestParams 

type DeleteRecordRequestParams struct {
	// The room ID.
	RoomId *int64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// The SDKAppID assigned by LCIC.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

Predefined struct for user

type DeleteRecordResponse 

type DeleteRecordResponse struct {
	*tchttp.BaseResponse
	Response *DeleteRecordResponseParams `json:"Response"`
}

func NewDeleteRecordResponse 

func NewDeleteRecordResponse() (response *DeleteRecordResponse)

func (*DeleteRecordResponse) FromJsonString 

func (r *DeleteRecordResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteRecordResponse) ToJsonString 

func (r *DeleteRecordResponse) ToJsonString() string

type DeleteRecordResponseParams 

type DeleteRecordResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeleteRoomRequest 

type DeleteRoomRequest struct {
	*tchttp.BaseRequest

	// Room ID
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`
}

func NewDeleteRoomRequest 

func NewDeleteRoomRequest() (request *DeleteRoomRequest)

func (*DeleteRoomRequest) FromJsonString 

func (r *DeleteRoomRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteRoomRequest) ToJsonString 

func (r *DeleteRoomRequest) ToJsonString() string

type DeleteRoomRequestParams 

type DeleteRoomRequestParams struct {
	// Room ID
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`
}

Predefined struct for user

type DeleteRoomResponse 

type DeleteRoomResponse struct {
	*tchttp.BaseResponse
	Response *DeleteRoomResponseParams `json:"Response"`
}

func NewDeleteRoomResponse 

func NewDeleteRoomResponse() (response *DeleteRoomResponse)

func (*DeleteRoomResponse) FromJsonString 

func (r *DeleteRoomResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteRoomResponse) ToJsonString 

func (r *DeleteRoomResponse) ToJsonString() string

type DeleteRoomResponseParams 

type DeleteRoomResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeleteSupervisorRequest 

type DeleteSupervisorRequest struct {
	*tchttp.BaseRequest

	// The application ID.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The user IDs.
	Users []*string `json:"Users,omitnil,omitempty" name:"Users"`
}

func NewDeleteSupervisorRequest 

func NewDeleteSupervisorRequest() (request *DeleteSupervisorRequest)

func (*DeleteSupervisorRequest) FromJsonString 

func (r *DeleteSupervisorRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteSupervisorRequest) ToJsonString 

func (r *DeleteSupervisorRequest) ToJsonString() string

type DeleteSupervisorRequestParams 

type DeleteSupervisorRequestParams struct {
	// The application ID.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The user IDs.
	Users []*string `json:"Users,omitnil,omitempty" name:"Users"`
}

Predefined struct for user

type DeleteSupervisorResponse 

type DeleteSupervisorResponse struct {
	*tchttp.BaseResponse
	Response *DeleteSupervisorResponseParams `json:"Response"`
}

func NewDeleteSupervisorResponse 

func NewDeleteSupervisorResponse() (response *DeleteSupervisorResponse)

func (*DeleteSupervisorResponse) FromJsonString 

func (r *DeleteSupervisorResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteSupervisorResponse) ToJsonString 

func (r *DeleteSupervisorResponse) ToJsonString() string

type DeleteSupervisorResponseParams 

type DeleteSupervisorResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeAnswerListRequest 

type DescribeAnswerListRequest struct {
	*tchttp.BaseRequest

	// The question ID.
	QuestionId *string `json:"QuestionId,omitnil,omitempty" name:"QuestionId"`

	// 1
	Page *int64 `json:"Page,omitnil,omitempty" name:"Page"`

	// 100
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

func NewDescribeAnswerListRequest 

func NewDescribeAnswerListRequest() (request *DescribeAnswerListRequest)

func (*DescribeAnswerListRequest) FromJsonString 

func (r *DescribeAnswerListRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeAnswerListRequest) ToJsonString 

func (r *DescribeAnswerListRequest) ToJsonString() string

type DescribeAnswerListRequestParams 

type DescribeAnswerListRequestParams struct {
	// The question ID.
	QuestionId *string `json:"QuestionId,omitnil,omitempty" name:"QuestionId"`

	// 1
	Page *int64 `json:"Page,omitnil,omitempty" name:"Page"`

	// 100
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

Predefined struct for user

type DescribeAnswerListResponse 

type DescribeAnswerListResponse struct {
	*tchttp.BaseResponse
	Response *DescribeAnswerListResponseParams `json:"Response"`
}

func NewDescribeAnswerListResponse 

func NewDescribeAnswerListResponse() (response *DescribeAnswerListResponse)

func (*DescribeAnswerListResponse) FromJsonString 

func (r *DescribeAnswerListResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeAnswerListResponse) ToJsonString 

func (r *DescribeAnswerListResponse) ToJsonString() string

type DescribeAnswerListResponseParams 

type DescribeAnswerListResponseParams struct {
	// The total number of answers.
	Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"`

	// A list of the answers.
	// Note: This field may return null, indicating that no valid values can be obtained.
	AnswerInfo []*AnswerInfo `json:"AnswerInfo,omitnil,omitempty" name:"AnswerInfo"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeCurrentMemberListRequest 

type DescribeCurrentMemberListRequest struct {
	*tchttp.BaseRequest

	// The room ID.
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// The page to return records from. Pagination starts from 1.
	Page *uint64 `json:"Page,omitnil,omitempty" name:"Page"`

	// The maximum number of records per page. The value of this parameter cannot exceed 1000.
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

func NewDescribeCurrentMemberListRequest 

func NewDescribeCurrentMemberListRequest() (request *DescribeCurrentMemberListRequest)

func (*DescribeCurrentMemberListRequest) FromJsonString 

func (r *DescribeCurrentMemberListRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeCurrentMemberListRequest) ToJsonString 

func (r *DescribeCurrentMemberListRequest) ToJsonString() string

type DescribeCurrentMemberListRequestParams 

type DescribeCurrentMemberListRequestParams struct {
	// The room ID.
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// The page to return records from. Pagination starts from 1.
	Page *uint64 `json:"Page,omitnil,omitempty" name:"Page"`

	// The maximum number of records per page. The value of this parameter cannot exceed 1000.
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

Predefined struct for user

type DescribeCurrentMemberListResponse 

type DescribeCurrentMemberListResponse struct {
	*tchttp.BaseResponse
	Response *DescribeCurrentMemberListResponseParams `json:"Response"`
}

func NewDescribeCurrentMemberListResponse 

func NewDescribeCurrentMemberListResponse() (response *DescribeCurrentMemberListResponse)

func (*DescribeCurrentMemberListResponse) FromJsonString 

func (r *DescribeCurrentMemberListResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeCurrentMemberListResponse) ToJsonString 

func (r *DescribeCurrentMemberListResponse) ToJsonString() string

type DescribeCurrentMemberListResponseParams 

type DescribeCurrentMemberListResponseParams struct {
	// The total number of records.
	Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"`

	// The user list.
	MemberRecords []*MemberRecord `json:"MemberRecords,omitnil,omitempty" name:"MemberRecords"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeDeveloperRequest 

type DescribeDeveloperRequest struct {
	*tchttp.BaseRequest
}

func NewDescribeDeveloperRequest 

func NewDescribeDeveloperRequest() (request *DescribeDeveloperRequest)

func (*DescribeDeveloperRequest) FromJsonString 

func (r *DescribeDeveloperRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeDeveloperRequest) ToJsonString 

func (r *DescribeDeveloperRequest) ToJsonString() string

type DescribeDeveloperRequestParams 

type DescribeDeveloperRequestParams struct {
}

Predefined struct for user

type DescribeDeveloperResponse 

type DescribeDeveloperResponse struct {
	*tchttp.BaseResponse
	Response *DescribeDeveloperResponseParams `json:"Response"`
}

func NewDescribeDeveloperResponse 

func NewDescribeDeveloperResponse() (response *DescribeDeveloperResponse)

func (*DescribeDeveloperResponse) FromJsonString 

func (r *DescribeDeveloperResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeDeveloperResponse) ToJsonString 

func (r *DescribeDeveloperResponse) ToJsonString() string

type DescribeDeveloperResponseParams 

type DescribeDeveloperResponseParams struct {
	// The developer ID.
	DeveloperId *string `json:"DeveloperId,omitnil,omitempty" name:"DeveloperId"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeDocumentRequest 

type DescribeDocumentRequest struct {
	*tchttp.BaseRequest

	// The (unique) document ID.
	DocumentId *string `json:"DocumentId,omitnil,omitempty" name:"DocumentId"`
}

func NewDescribeDocumentRequest 

func NewDescribeDocumentRequest() (request *DescribeDocumentRequest)

func (*DescribeDocumentRequest) FromJsonString 

func (r *DescribeDocumentRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeDocumentRequest) ToJsonString 

func (r *DescribeDocumentRequest) ToJsonString() string

type DescribeDocumentRequestParams 

type DescribeDocumentRequestParams struct {
	// The (unique) document ID.
	DocumentId *string `json:"DocumentId,omitnil,omitempty" name:"DocumentId"`
}

Predefined struct for user

type DescribeDocumentResponse 

type DescribeDocumentResponse struct {
	*tchttp.BaseResponse
	Response *DescribeDocumentResponseParams `json:"Response"`
}

func NewDescribeDocumentResponse 

func NewDescribeDocumentResponse() (response *DescribeDocumentResponse)

func (*DescribeDocumentResponse) FromJsonString 

func (r *DescribeDocumentResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeDocumentResponse) ToJsonString 

func (r *DescribeDocumentResponse) ToJsonString() string

type DescribeDocumentResponseParams 

type DescribeDocumentResponseParams struct {
	// The document ID.
	DocumentId *string `json:"DocumentId,omitnil,omitempty" name:"DocumentId"`

	// The document’s original URL.
	DocumentUrl *string `json:"DocumentUrl,omitnil,omitempty" name:"DocumentUrl"`

	// The document title.
	DocumentName *string `json:"DocumentName,omitnil,omitempty" name:"DocumentName"`

	// The user ID of the document’s owner.
	Owner *string `json:"Owner,omitnil,omitempty" name:"Owner"`

	// The application ID.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The document access type.
	Permission *uint64 `json:"Permission,omitnil,omitempty" name:"Permission"`

	// The transcoding result. If the file is not transcoded, this parameter will be empty. If it is successfully transcoded, this parameter will be the URL of the transcoded file. If transcoding fails, this parameter will indicate the error code.
	TranscodeResult *string `json:"TranscodeResult,omitnil,omitempty" name:"TranscodeResult"`

	// The transcoding type.
	TranscodeType *uint64 `json:"TranscodeType,omitnil,omitempty" name:"TranscodeType"`

	// The transcoding progress. Value range: 0-100.
	TranscodeProgress *uint64 `json:"TranscodeProgress,omitnil,omitempty" name:"TranscodeProgress"`

	// The transcoding status. 0: The file is not transcoded. 1: The file is being transcoded. 2: Transcoding failed. 3: Transcoding is successful.
	TranscodeState *uint64 `json:"TranscodeState,omitnil,omitempty" name:"TranscodeState"`

	// The error message for failed transcoding.
	TranscodeInfo *string `json:"TranscodeInfo,omitnil,omitempty" name:"TranscodeInfo"`

	// The document type.
	DocumentType *string `json:"DocumentType,omitnil,omitempty" name:"DocumentType"`

	// The document size (bytes).
	DocumentSize *uint64 `json:"DocumentSize,omitnil,omitempty" name:"DocumentSize"`

	// The time (Unix timestamp) when the document was last updated.
	UpdateTime *uint64 `json:"UpdateTime,omitnil,omitempty" name:"UpdateTime"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeDocumentsByRoomRequest 

type DescribeDocumentsByRoomRequest struct {
	*tchttp.BaseRequest

	// The room ID.
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The page to return records from. Pagination starts from 1, which is also the default value of this parameter.
	Page *int64 `json:"Page,omitnil,omitempty" name:"Page"`

	// The maximum number of records to return per page. The maximum value can be 1000. The default value is 100.
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// The document access type. [0]: The private documents of the owner. [1]: The public documents of the owner. [0,1]: The private and public documents of the owner. [2]: The private and public documents of all users (including the owner). Default value: [2].
	Permission []*uint64 `json:"Permission,omitnil,omitempty" name:"Permission"`

	// The user ID of the document owner. If you do not specify this, the information of all documents under the application will be returned.
	Owner *string `json:"Owner,omitnil,omitempty" name:"Owner"`
}

func NewDescribeDocumentsByRoomRequest 

func NewDescribeDocumentsByRoomRequest() (request *DescribeDocumentsByRoomRequest)

func (*DescribeDocumentsByRoomRequest) FromJsonString 

func (r *DescribeDocumentsByRoomRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeDocumentsByRoomRequest) ToJsonString 

func (r *DescribeDocumentsByRoomRequest) ToJsonString() string

type DescribeDocumentsByRoomRequestParams 

type DescribeDocumentsByRoomRequestParams struct {
	// The room ID.
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The page to return records from. Pagination starts from 1, which is also the default value of this parameter.
	Page *int64 `json:"Page,omitnil,omitempty" name:"Page"`

	// The maximum number of records to return per page. The maximum value can be 1000. The default value is 100.
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// The document access type. [0]: The private documents of the owner. [1]: The public documents of the owner. [0,1]: The private and public documents of the owner. [2]: The private and public documents of all users (including the owner). Default value: [2].
	Permission []*uint64 `json:"Permission,omitnil,omitempty" name:"Permission"`

	// The user ID of the document owner. If you do not specify this, the information of all documents under the application will be returned.
	Owner *string `json:"Owner,omitnil,omitempty" name:"Owner"`
}

Predefined struct for user

type DescribeDocumentsByRoomResponse 

type DescribeDocumentsByRoomResponse struct {
	*tchttp.BaseResponse
	Response *DescribeDocumentsByRoomResponseParams `json:"Response"`
}

func NewDescribeDocumentsByRoomResponse 

func NewDescribeDocumentsByRoomResponse() (response *DescribeDocumentsByRoomResponse)

func (*DescribeDocumentsByRoomResponse) FromJsonString 

func (r *DescribeDocumentsByRoomResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeDocumentsByRoomResponse) ToJsonString 

func (r *DescribeDocumentsByRoomResponse) ToJsonString() string

type DescribeDocumentsByRoomResponseParams 

type DescribeDocumentsByRoomResponseParams struct {
	//
	// Note: This field may return null, indicating that no valid values can be obtained.
	Documents []*DocumentInfo `json:"Documents,omitnil,omitempty" name:"Documents"`

	// The total number of records that meet the conditions.
	Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeDocumentsRequest 

type DescribeDocumentsRequest struct {
	*tchttp.BaseRequest

	// The school ID.
	SchoolId *uint64 `json:"SchoolId,omitnil,omitempty" name:"SchoolId"`

	// The page to return records from. Pagination starts from 1.
	Page *int64 `json:"Page,omitnil,omitempty" name:"Page"`

	// The maximum number of records per page. The value of this parameter cannot exceed `1000`.
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// The courseware access. [0]: The private courseware of the specified user (`Owner`) will be returned; [1]: The public courseware of the specified user will be returned; [0,1]: Both the private and public courseware of the specified user will be returned; [2]: The private courseware of the specified user and the public courseware of all users (including `Owner`) will be returned.
	Permission []*uint64 `json:"Permission,omitnil,omitempty" name:"Permission"`

	// The user ID of the courseware owner. If you do not specify this parameter, all courseware under the school ID will be returned.
	Owner *string `json:"Owner,omitnil,omitempty" name:"Owner"`

	// The filename keyword.
	Keyword *string `json:"Keyword,omitnil,omitempty" name:"Keyword"`

	// The courseware IDs. Non-existent IDs will be ignored.
	DocumentId []*string `json:"DocumentId,omitnil,omitempty" name:"DocumentId"`
}

func NewDescribeDocumentsRequest 

func NewDescribeDocumentsRequest() (request *DescribeDocumentsRequest)

func (*DescribeDocumentsRequest) FromJsonString 

func (r *DescribeDocumentsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeDocumentsRequest) ToJsonString 

func (r *DescribeDocumentsRequest) ToJsonString() string

type DescribeDocumentsRequestParams 

type DescribeDocumentsRequestParams struct {
	// The school ID.
	SchoolId *uint64 `json:"SchoolId,omitnil,omitempty" name:"SchoolId"`

	// The page to return records from. Pagination starts from 1.
	Page *int64 `json:"Page,omitnil,omitempty" name:"Page"`

	// The maximum number of records per page. The value of this parameter cannot exceed `1000`.
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// The courseware access. [0]: The private courseware of the specified user (`Owner`) will be returned; [1]: The public courseware of the specified user will be returned; [0,1]: Both the private and public courseware of the specified user will be returned; [2]: The private courseware of the specified user and the public courseware of all users (including `Owner`) will be returned.
	Permission []*uint64 `json:"Permission,omitnil,omitempty" name:"Permission"`

	// The user ID of the courseware owner. If you do not specify this parameter, all courseware under the school ID will be returned.
	Owner *string `json:"Owner,omitnil,omitempty" name:"Owner"`

	// The filename keyword.
	Keyword *string `json:"Keyword,omitnil,omitempty" name:"Keyword"`

	// The courseware IDs. Non-existent IDs will be ignored.
	DocumentId []*string `json:"DocumentId,omitnil,omitempty" name:"DocumentId"`
}

Predefined struct for user

type DescribeDocumentsResponse 

type DescribeDocumentsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeDocumentsResponseParams `json:"Response"`
}

func NewDescribeDocumentsResponse 

func NewDescribeDocumentsResponse() (response *DescribeDocumentsResponse)

func (*DescribeDocumentsResponse) FromJsonString 

func (r *DescribeDocumentsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeDocumentsResponse) ToJsonString 

func (r *DescribeDocumentsResponse) ToJsonString() string

type DescribeDocumentsResponseParams 

type DescribeDocumentsResponseParams struct {
	// The total number of records that meet the conditions.
	Total *int64 `json:"Total,omitnil,omitempty" name:"Total"`

	// The information of the courseware.
	// Note: This field may return null, indicating that no valid values can be obtained.
	Documents []*DocumentInfo `json:"Documents,omitnil,omitempty" name:"Documents"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeGroupListRequest 

type DescribeGroupListRequest struct {
	*tchttp.BaseRequest

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The page to return records from. Pagination starts from 1.
	Page *uint64 `json:"Page,omitnil,omitempty" name:"Page"`

	// The maximum number of records per page. The value of this parameter cannot exceed 1000 and is 20 by default.
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// The user ID of the teacher, which is used as the filter. This parameter and MemberId are mutually exclusive. If both are specified, only this parameter will take effect.
	TeacherId *string `json:"TeacherId,omitnil,omitempty" name:"TeacherId"`

	// The user ID of a member, which is used as the filter. This parameter and TeacherId are mutually exclusive.
	MemberId *string `json:"MemberId,omitnil,omitempty" name:"MemberId"`
}

func NewDescribeGroupListRequest 

func NewDescribeGroupListRequest() (request *DescribeGroupListRequest)

func (*DescribeGroupListRequest) FromJsonString 

func (r *DescribeGroupListRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeGroupListRequest) ToJsonString 

func (r *DescribeGroupListRequest) ToJsonString() string

type DescribeGroupListRequestParams 

type DescribeGroupListRequestParams struct {
	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The page to return records from. Pagination starts from 1.
	Page *uint64 `json:"Page,omitnil,omitempty" name:"Page"`

	// The maximum number of records per page. The value of this parameter cannot exceed 1000 and is 20 by default.
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// The user ID of the teacher, which is used as the filter. This parameter and MemberId are mutually exclusive. If both are specified, only this parameter will take effect.
	TeacherId *string `json:"TeacherId,omitnil,omitempty" name:"TeacherId"`

	// The user ID of a member, which is used as the filter. This parameter and TeacherId are mutually exclusive.
	MemberId *string `json:"MemberId,omitnil,omitempty" name:"MemberId"`
}

Predefined struct for user

type DescribeGroupListResponse 

type DescribeGroupListResponse struct {
	*tchttp.BaseResponse
	Response *DescribeGroupListResponseParams `json:"Response"`
}

func NewDescribeGroupListResponse 

func NewDescribeGroupListResponse() (response *DescribeGroupListResponse)

func (*DescribeGroupListResponse) FromJsonString 

func (r *DescribeGroupListResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeGroupListResponse) ToJsonString 

func (r *DescribeGroupListResponse) ToJsonString() string

type DescribeGroupListResponseParams 

type DescribeGroupListResponseParams struct {
	// The total number of groups that meet the conditions.
	Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"`

	//
	// Note: This field may return null, indicating that no valid values can be obtained.
	GroupInfos []*GroupInfo `json:"GroupInfos,omitnil,omitempty" name:"GroupInfos"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeGroupMemberListRequest 

type DescribeGroupMemberListRequest struct {
	*tchttp.BaseRequest

	// The group ID.
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The page to return records from. The default value is 1.
	Page *uint64 `json:"Page,omitnil,omitempty" name:"Page"`

	// The maximum number of records per page. The value of this parameter cannot exceed 1000 and is 20 by default.
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

func NewDescribeGroupMemberListRequest 

func NewDescribeGroupMemberListRequest() (request *DescribeGroupMemberListRequest)

func (*DescribeGroupMemberListRequest) FromJsonString 

func (r *DescribeGroupMemberListRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeGroupMemberListRequest) ToJsonString 

func (r *DescribeGroupMemberListRequest) ToJsonString() string

type DescribeGroupMemberListRequestParams 

type DescribeGroupMemberListRequestParams struct {
	// The group ID.
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The page to return records from. The default value is 1.
	Page *uint64 `json:"Page,omitnil,omitempty" name:"Page"`

	// The maximum number of records per page. The value of this parameter cannot exceed 1000 and is 20 by default.
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

Predefined struct for user

type DescribeGroupMemberListResponse 

type DescribeGroupMemberListResponse struct {
	*tchttp.BaseResponse
	Response *DescribeGroupMemberListResponseParams `json:"Response"`
}

func NewDescribeGroupMemberListResponse 

func NewDescribeGroupMemberListResponse() (response *DescribeGroupMemberListResponse)

func (*DescribeGroupMemberListResponse) FromJsonString 

func (r *DescribeGroupMemberListResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeGroupMemberListResponse) ToJsonString 

func (r *DescribeGroupMemberListResponse) ToJsonString() string

type DescribeGroupMemberListResponseParams 

type DescribeGroupMemberListResponseParams struct {
	// The total number of records that meet the conditions.
	Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"`

	//
	// Note: This field may return null, indicating that no valid values can be obtained.
	MemberIds []*string `json:"MemberIds,omitnil,omitempty" name:"MemberIds"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeGroupRequest 

type DescribeGroupRequest struct {
	*tchttp.BaseRequest

	// The group ID.
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

func NewDescribeGroupRequest 

func NewDescribeGroupRequest() (request *DescribeGroupRequest)

func (*DescribeGroupRequest) FromJsonString 

func (r *DescribeGroupRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeGroupRequest) ToJsonString 

func (r *DescribeGroupRequest) ToJsonString() string

type DescribeGroupRequestParams 

type DescribeGroupRequestParams struct {
	// The group ID.
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

Predefined struct for user

type DescribeGroupResponse 

type DescribeGroupResponse struct {
	*tchttp.BaseResponse
	Response *DescribeGroupResponseParams `json:"Response"`
}

func NewDescribeGroupResponse 

func NewDescribeGroupResponse() (response *DescribeGroupResponse)

func (*DescribeGroupResponse) FromJsonString 

func (r *DescribeGroupResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeGroupResponse) ToJsonString 

func (r *DescribeGroupResponse) ToJsonString() string

type DescribeGroupResponseParams 

type DescribeGroupResponseParams struct {
	// The group ID.
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// The group name.
	GroupName *string `json:"GroupName,omitnil,omitempty" name:"GroupName"`

	//
	// Note: This field may return null, indicating that no valid values can be obtained.
	TeacherId *string `json:"TeacherId,omitnil,omitempty" name:"TeacherId"`

	// The group type. 0: Ordinary group. 1: Merged group. If the group queried is a merged group, the IDs of the sub-groups will be returned.
	GroupType *uint64 `json:"GroupType,omitnil,omitempty" name:"GroupType"`

	//
	// Note: This field may return null, indicating that no valid values can be obtained.
	SubGroupIds []*string `json:"SubGroupIds,omitnil,omitempty" name:"SubGroupIds"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeQuestionListRequest 

type DescribeQuestionListRequest struct {
	*tchttp.BaseRequest

	// The room ID.
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// The page to return records from. Pagination starts from 1, which is also the default value of this parameter.
	Page *int64 `json:"Page,omitnil,omitempty" name:"Page"`

	// The page to return records from. Pagination starts from 1, which is also the default value of this parameter.
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

func NewDescribeQuestionListRequest 

func NewDescribeQuestionListRequest() (request *DescribeQuestionListRequest)

func (*DescribeQuestionListRequest) FromJsonString 

func (r *DescribeQuestionListRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeQuestionListRequest) ToJsonString 

func (r *DescribeQuestionListRequest) ToJsonString() string

type DescribeQuestionListRequestParams 

type DescribeQuestionListRequestParams struct {
	// The room ID.
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// The page to return records from. Pagination starts from 1, which is also the default value of this parameter.
	Page *int64 `json:"Page,omitnil,omitempty" name:"Page"`

	// The page to return records from. Pagination starts from 1, which is also the default value of this parameter.
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

Predefined struct for user

type DescribeQuestionListResponse 

type DescribeQuestionListResponse struct {
	*tchttp.BaseResponse
	Response *DescribeQuestionListResponseParams `json:"Response"`
}

func NewDescribeQuestionListResponse 

func NewDescribeQuestionListResponse() (response *DescribeQuestionListResponse)

func (*DescribeQuestionListResponse) FromJsonString 

func (r *DescribeQuestionListResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeQuestionListResponse) ToJsonString 

func (r *DescribeQuestionListResponse) ToJsonString() string

type DescribeQuestionListResponseParams 

type DescribeQuestionListResponseParams struct {
	// The total number of quiz questions.
	Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"`

	// A list of the questions.
	// Note: This field may return null, indicating that no valid values can be obtained.
	QuestionInfo []*QuestionInfo `json:"QuestionInfo,omitnil,omitempty" name:"QuestionInfo"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeRoomRequest 

type DescribeRoomRequest struct {
	*tchttp.BaseRequest

	// Room ID
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// Request RTMP  stream link, 0: no, 1: yes, default is 0.
	RTMPStreamingURL *uint64 `json:"RTMPStreamingURL,omitnil,omitempty" name:"RTMPStreamingURL"`
}

func NewDescribeRoomRequest 

func NewDescribeRoomRequest() (request *DescribeRoomRequest)

func (*DescribeRoomRequest) FromJsonString 

func (r *DescribeRoomRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeRoomRequest) ToJsonString 

func (r *DescribeRoomRequest) ToJsonString() string

type DescribeRoomRequestParams 

type DescribeRoomRequestParams struct {
	// Room ID
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// Request RTMP  stream link, 0: no, 1: yes, default is 0.
	RTMPStreamingURL *uint64 `json:"RTMPStreamingURL,omitnil,omitempty" name:"RTMPStreamingURL"`
}

Predefined struct for user

type DescribeRoomResponse 

type DescribeRoomResponse struct {
	*tchttp.BaseResponse
	Response *DescribeRoomResponseParams `json:"Response"`
}

func NewDescribeRoomResponse 

func NewDescribeRoomResponse() (response *DescribeRoomResponse)

func (*DescribeRoomResponse) FromJsonString 

func (r *DescribeRoomResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeRoomResponse) ToJsonString 

func (r *DescribeRoomResponse) ToJsonString() string

type DescribeRoomResponseParams 

type DescribeRoomResponseParams struct {
	// Room name
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// Reserved room start time, in UNIX timestamp format
	StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// Reserved room end time, in UNIX timestamp format
	EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// Teacher ID
	TeacherId *string `json:"TeacherId,omitnil,omitempty" name:"TeacherId"`

	// LCIC SdkAppId
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	//  Watch type. Can have the following values: 1 interactive viewing 2 standard viewing
	AudienceType *uint64 `json:"AudienceType,omitnil,omitempty" name:"AudienceType"`

	// Resolution. Valid values: 1: SD; 2: HD; 3: FHD
	Resolution *uint64 `json:"Resolution,omitnil,omitempty" name:"Resolution"`

	// Maximum number of mic-on users (excluding teachers). Value range: [0, 16]
	MaxMicNumber *uint64 `json:"MaxMicNumber,omitnil,omitempty" name:"MaxMicNumber"`

	// Whether to automatically turn the mic on when the user enters a room. Valid values: 0: No (default value); 1: Yes.
	AutoMic *uint64 `json:"AutoMic,omitnil,omitempty" name:"AutoMic"`

	// Whether to enable the high audio quality mode. Valid values: 0: No (default value); 1: Yes.
	AudioQuality *uint64 `json:"AudioQuality,omitnil,omitempty" name:"AudioQuality"`

	// The room subtype. Valid values: videodoc: Document + Video; video: Video only.
	SubType *string `json:"SubType,omitnil,omitempty" name:"SubType"`

	// Whether to disable auto recording. Valid values: 0: No (default); 1: Yes. If this parameter is 0, recording will start when the class starts and stops when the class ends.
	DisableRecord *uint64 `json:"DisableRecord,omitnil,omitempty" name:"DisableRecord"`

	// Assistant ID list Note: This field may return null, indicating that no valid values can be obtained.
	Assistants []*string `json:"Assistants,omitnil,omitempty" name:"Assistants"`

	// Recording URL. This parameter exists only after a room is ended. Note: This field may return null, indicating that no valid values can be obtained.
	RecordUrl *string `json:"RecordUrl,omitnil,omitempty" name:"RecordUrl"`

	// The class status. 0: The class has not started. 1: The class has started. 2: The class ended. 3: The class expired. Note: This field may return null, indicating that no valid values can be obtained.
	Status *uint64 `json:"Status,omitnil,omitempty" name:"Status"`

	// Note: This field may return null, indicating that no valid values can be obtained.
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// Whether the students' consent is required to control their cameras/microphones.
	EnableDirectControl *uint64 `json:"EnableDirectControl,omitnil,omitempty" name:"EnableDirectControl"`

	// Turn on focus mode. 0 Watch all character audio and video (default) 1 Watch only teachers and teaching assistants
	InteractionMode *int64 `json:"InteractionMode,omitnil,omitempty" name:"InteractionMode"`

	// Horizontal and vertical screen. 0: Horizontal screen to open broadcast (default); 1: Vertical screen to open broadcast, currently only support mobile pure video type
	VideoOrientation *uint64 `json:"VideoOrientation,omitnil,omitempty" name:"VideoOrientation"`

	// Whether the room is enabled for grading after the lesson. 0: not enabled 1: enabled
	IsGradingRequiredPostClass *int64 `json:"IsGradingRequiredPostClass,omitnil,omitempty" name:"IsGradingRequiredPostClass"`

	// Room Type: 0 Small Classroom(default); 1 Lecture Hall(public class)
	RoomType *int64 `json:"RoomType,omitnil,omitempty" name:"RoomType"`

	// Recording Duration
	VideoDuration *uint64 `json:"VideoDuration,omitnil,omitempty" name:"VideoDuration"`

	// Drag class time: unit minutes, 0 is unlimited (default), -1 is can't drag the class, greater than 0 is the time of dragging the class, the maximum value of 120 minutes
	EndDelayTime *int64 `json:"EndDelayTime,omitnil,omitempty" name:"EndDelayTime"`

	// Live type: 0 regular (default) 1 Simulated Live
	LiveType *uint64 `json:"LiveType,omitnil,omitempty" name:"LiveType"`

	// Simulated Live link
	RecordLiveUrl *string `json:"RecordLiveUrl,omitnil,omitempty" name:"RecordLiveUrl"`

	// Whether to start the lesson automatically: 0 not automatic lesson (default) 1 automatic lesson live_type=1 is valid
	EnableAutoStart *uint64 `json:"EnableAutoStart,omitnil,omitempty" name:"EnableAutoStart"`

	// Recorded file background image, support png, jpg, jpeg, bmp format, does not support transparent channel for the time being
	RecordBackground *string `json:"RecordBackground,omitnil,omitempty" name:"RecordBackground"`

	// RTMP  stream link
	RTMPStreamingURL *string `json:"RTMPStreamingURL,omitnil,omitempty" name:"RTMPStreamingURL"`

	// Record customized scene, only recordlayout=9 this parameter is valid
	RecordScene *string `json:"RecordScene,omitnil,omitempty" name:"RecordScene"`

	// Record customized language, only when recordlayout=9, this parameter is valid
	RecordLang *string `json:"RecordLang,omitnil,omitempty" name:"RecordLang"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeRoomStatisticsRequest 

type DescribeRoomStatisticsRequest struct {
	*tchttp.BaseRequest

	// Room ID
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// Current page in pagination, which starts from 1.
	Page *uint64 `json:"Page,omitnil,omitempty" name:"Page"`

	// Number of data entries to return per page. Maximum value: 1000
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

func NewDescribeRoomStatisticsRequest 

func NewDescribeRoomStatisticsRequest() (request *DescribeRoomStatisticsRequest)

func (*DescribeRoomStatisticsRequest) FromJsonString 

func (r *DescribeRoomStatisticsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeRoomStatisticsRequest) ToJsonString 

func (r *DescribeRoomStatisticsRequest) ToJsonString() string

type DescribeRoomStatisticsRequestParams 

type DescribeRoomStatisticsRequestParams struct {
	// Room ID
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// Current page in pagination, which starts from 1.
	Page *uint64 `json:"Page,omitnil,omitempty" name:"Page"`

	// Number of data entries to return per page. Maximum value: 1000
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

Predefined struct for user

type DescribeRoomStatisticsResponse 

type DescribeRoomStatisticsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeRoomStatisticsResponseParams `json:"Response"`
}

func NewDescribeRoomStatisticsResponse 

func NewDescribeRoomStatisticsResponse() (response *DescribeRoomStatisticsResponse)

func (*DescribeRoomStatisticsResponse) FromJsonString 

func (r *DescribeRoomStatisticsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeRoomStatisticsResponse) ToJsonString 

func (r *DescribeRoomStatisticsResponse) ToJsonString() string

type DescribeRoomStatisticsResponseParams 

type DescribeRoomStatisticsResponseParams struct {
	// Peak number of online members
	PeakMemberNumber *uint64 `json:"PeakMemberNumber,omitnil,omitempty" name:"PeakMemberNumber"`

	// Accumulated number of online members
	MemberNumber *uint64 `json:"MemberNumber,omitnil,omitempty" name:"MemberNumber"`

	// Total number of records, including members who entered the room and members who should attend the class but did not
	Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"`

	// Member record list
	MemberRecords []*MemberRecord `json:"MemberRecords,omitnil,omitempty" name:"MemberRecords"`

	// The actual start time of the room, in Unix timestamp, accurate to seconds. Note: This field may return null, indicating that no valid values can be obtained.
	RealStartTime *uint64 `json:"RealStartTime,omitnil,omitempty" name:"RealStartTime"`

	// The actual end time of the room, in Unix timestamp, accurate to seconds. Note: This field may return null, indicating that no valid values can be obtained.
	RealEndTime *uint64 `json:"RealEndTime,omitnil,omitempty" name:"RealEndTime"`

	// The total message count of the room.
	MessageCount *uint64 `json:"MessageCount,omitnil,omitempty" name:"MessageCount"`

	// The total number of mic-on students in the room.
	MicCount *uint64 `json:"MicCount,omitnil,omitempty" name:"MicCount"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeSdkAppIdUsersRequest 

type DescribeSdkAppIdUsersRequest struct {
	*tchttp.BaseRequest

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The page to return records from. The default value is 1.
	Page *int64 `json:"Page,omitnil,omitempty" name:"Page"`

	// The maximum number of records to return per page. The default value is 20.
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

func NewDescribeSdkAppIdUsersRequest 

func NewDescribeSdkAppIdUsersRequest() (request *DescribeSdkAppIdUsersRequest)

func (*DescribeSdkAppIdUsersRequest) FromJsonString 

func (r *DescribeSdkAppIdUsersRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeSdkAppIdUsersRequest) ToJsonString 

func (r *DescribeSdkAppIdUsersRequest) ToJsonString() string

type DescribeSdkAppIdUsersRequestParams 

type DescribeSdkAppIdUsersRequestParams struct {
	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The page to return records from. The default value is 1.
	Page *int64 `json:"Page,omitnil,omitempty" name:"Page"`

	// The maximum number of records to return per page. The default value is 20.
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

Predefined struct for user

type DescribeSdkAppIdUsersResponse 

type DescribeSdkAppIdUsersResponse struct {
	*tchttp.BaseResponse
	Response *DescribeSdkAppIdUsersResponseParams `json:"Response"`
}

func NewDescribeSdkAppIdUsersResponse 

func NewDescribeSdkAppIdUsersResponse() (response *DescribeSdkAppIdUsersResponse)

func (*DescribeSdkAppIdUsersResponse) FromJsonString 

func (r *DescribeSdkAppIdUsersResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeSdkAppIdUsersResponse) ToJsonString 

func (r *DescribeSdkAppIdUsersResponse) ToJsonString() string

type DescribeSdkAppIdUsersResponseParams 

type DescribeSdkAppIdUsersResponseParams struct {
	// The total number of users.
	Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"`

	// The information of the users. Note: This field may return null, indicating that no valid values can be obtained.
	Users []*UserInfo `json:"Users,omitnil,omitempty" name:"Users"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeSupervisorsRequest 

type DescribeSupervisorsRequest struct {
	*tchttp.BaseRequest

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The maximum number of records per page. The maximum value allowed is 100, and the default value is 20.
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// The page to return records from. Pagination starts from 1, which is also the default value of this parameter.
	Page *uint64 `json:"Page,omitnil,omitempty" name:"Page"`
}

func NewDescribeSupervisorsRequest 

func NewDescribeSupervisorsRequest() (request *DescribeSupervisorsRequest)

func (*DescribeSupervisorsRequest) FromJsonString 

func (r *DescribeSupervisorsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeSupervisorsRequest) ToJsonString 

func (r *DescribeSupervisorsRequest) ToJsonString() string

type DescribeSupervisorsRequestParams 

type DescribeSupervisorsRequestParams struct {
	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The maximum number of records per page. The maximum value allowed is 100, and the default value is 20.
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// The page to return records from. Pagination starts from 1, which is also the default value of this parameter.
	Page *uint64 `json:"Page,omitnil,omitempty" name:"Page"`
}

Predefined struct for user

type DescribeSupervisorsResponse 

type DescribeSupervisorsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeSupervisorsResponseParams `json:"Response"`
}

func NewDescribeSupervisorsResponse 

func NewDescribeSupervisorsResponse() (response *DescribeSupervisorsResponse)

func (*DescribeSupervisorsResponse) FromJsonString 

func (r *DescribeSupervisorsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeSupervisorsResponse) ToJsonString 

func (r *DescribeSupervisorsResponse) ToJsonString() string

type DescribeSupervisorsResponseParams 

type DescribeSupervisorsResponseParams struct {
	// The total number of spectators.
	Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"`

	// The current page number.
	Page *uint64 `json:"Page,omitnil,omitempty" name:"Page"`

	// The number of records on the current page.
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// A list of the spectators.
	UserIds []*string `json:"UserIds,omitnil,omitempty" name:"UserIds"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeUserRequest 

type DescribeUserRequest struct {
	*tchttp.BaseRequest

	// User ID
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`
}

func NewDescribeUserRequest 

func NewDescribeUserRequest() (request *DescribeUserRequest)

func (*DescribeUserRequest) FromJsonString 

func (r *DescribeUserRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeUserRequest) ToJsonString 

func (r *DescribeUserRequest) ToJsonString() string

type DescribeUserRequestParams 

type DescribeUserRequestParams struct {
	// User ID
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`
}

Predefined struct for user

type DescribeUserResponse 

type DescribeUserResponse struct {
	*tchttp.BaseResponse
	Response *DescribeUserResponseParams `json:"Response"`
}

func NewDescribeUserResponse 

func NewDescribeUserResponse() (response *DescribeUserResponse)

func (*DescribeUserResponse) FromJsonString 

func (r *DescribeUserResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeUserResponse) ToJsonString 

func (r *DescribeUserResponse) ToJsonString() string

type DescribeUserResponseParams 

type DescribeUserResponseParams struct {
	// The application ID.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// User ID
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// Username
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// URL of user profile photo.
	Avatar *string `json:"Avatar,omitnil,omitempty" name:"Avatar"`

	// User's Id in the client system
	OriginId *string `json:"OriginId,omitnil,omitempty" name:"OriginId"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DocumentInfo 

type DocumentInfo struct {
	// The document ID. Note: This field may return null, indicating that no valid values can be obtained.
	DocumentId *string `json:"DocumentId,omitnil,omitempty" name:"DocumentId"`

	// The document's original URL. Note: This field may return null, indicating that no valid values can be obtained.
	DocumentUrl *string `json:"DocumentUrl,omitnil,omitempty" name:"DocumentUrl"`

	// The document title. Note: This field may return null, indicating that no valid values can be obtained.
	DocumentName *string `json:"DocumentName,omitnil,omitempty" name:"DocumentName"`

	// The user ID of the document's owner. Note: This field may return null, indicating that no valid values can be obtained.
	Owner *string `json:"Owner,omitnil,omitempty" name:"Owner"`

	// The application ID. Note: This field may return null, indicating that no valid values can be obtained.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The document access type. 0: Private; 1: Public. Note: This field may return null, indicating that no valid values can be obtained.
	Permission *uint64 `json:"Permission,omitnil,omitempty" name:"Permission"`

	// The transcoding result. If the file is not transcoded, this parameter will be empty. If it is successfully transcoded, this parameter will be the URL of the transcoded file. If transcoding fails, this parameter will indicate the error code. Note: This field may return null, indicating that no valid values can be obtained.
	TranscodeResult *string `json:"TranscodeResult,omitnil,omitempty" name:"TranscodeResult"`

	// The transcoding type. Note: This field may return null, indicating that no valid values can be obtained.
	TranscodeType *uint64 `json:"TranscodeType,omitnil,omitempty" name:"TranscodeType"`

	// The transcoding progress. Value range: 0-100. Note: This field may return null, indicating that no valid values can be obtained.
	TranscodeProgress *uint64 `json:"TranscodeProgress,omitnil,omitempty" name:"TranscodeProgress"`

	// The transcoding status. 0: The file is not transcoded. 1: The file is being transcoded. 2: Transcoding failed. 3: Transcoding is successful. Note: This field may return null, indicating that no valid values can be obtained.
	TranscodeState *uint64 `json:"TranscodeState,omitnil,omitempty" name:"TranscodeState"`

	// The error message for failed transcoding. Note: This field may return null, indicating that no valid values can be obtained.
	TranscodeInfo *string `json:"TranscodeInfo,omitnil,omitempty" name:"TranscodeInfo"`

	// The document type. Note: This field may return null, indicating that no valid values can be obtained.
	DocumentType *string `json:"DocumentType,omitnil,omitempty" name:"DocumentType"`

	// The document size (bytes). Note: This field may return null, indicating that no valid values can be obtained.
	DocumentSize *uint64 `json:"DocumentSize,omitnil,omitempty" name:"DocumentSize"`

	// The time (Unix timestamp) when the document was last updated. Note: This field may return null, indicating that no valid values can be obtained.
	UpdateTime *uint64 `json:"UpdateTime,omitnil,omitempty" name:"UpdateTime"`

	// The number of pages.
	// Note: This field may return null, indicating that no valid values can be obtained.
	Pages *uint64 `json:"Pages,omitnil,omitempty" name:"Pages"`

	// The width. This parameter is valid only if static document transcoding is used.
	// Note: This field may return null, indicating that no valid values can be obtained.
	Width *uint64 `json:"Width,omitnil,omitempty" name:"Width"`

	// The height. This parameter is valid only if static document transcoding is used.
	// Note: This field may return null, indicating that no valid values can be obtained.
	Height *uint64 `json:"Height,omitnil,omitempty" name:"Height"`

	// The thumbnail. Only transcoded courseware has thumbnails.
	// Note: This field may return null, indicating that no valid values can be obtained.
	Cover *string `json:"Cover,omitnil,omitempty" name:"Cover"`

	// Document preview address
	Preview *string `json:"Preview,omitnil,omitempty" name:"Preview"`
}

type EndRoomRequest 

type EndRoomRequest struct {
	*tchttp.BaseRequest

	// The room ID.
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`
}

func NewEndRoomRequest 

func NewEndRoomRequest() (request *EndRoomRequest)

func (*EndRoomRequest) FromJsonString 

func (r *EndRoomRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*EndRoomRequest) ToJsonString 

func (r *EndRoomRequest) ToJsonString() string

type EndRoomRequestParams 

type EndRoomRequestParams struct {
	// The room ID.
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`
}

Predefined struct for user

type EndRoomResponse 

type EndRoomResponse struct {
	*tchttp.BaseResponse
	Response *EndRoomResponseParams `json:"Response"`
}

func NewEndRoomResponse 

func NewEndRoomResponse() (response *EndRoomResponse)

func (*EndRoomResponse) FromJsonString 

func (r *EndRoomResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*EndRoomResponse) ToJsonString 

func (r *EndRoomResponse) ToJsonString() string

type EndRoomResponseParams 

type EndRoomResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type EventDataInfo 

type EventDataInfo struct {
	// The room ID.
	// Note: This field may return null, indicating that no valid values can be obtained.
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// The ID of the user to whom the event occurred.
	// Note: This field may return null, indicating that no valid values can be obtained.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// User device type. 0: Unknown; 1: Windows; 2: macOS; 3: Android; 4: iOS; 5: Web; 6: Mobile webpage; 7: Wechat Mini Program.
	Device *uint64 `json:"Device,omitnil,omitempty" name:"Device"`

	// Recording time. Unit: seconds
	Duration *uint64 `json:"Duration,omitnil,omitempty" name:"Duration"`

	// Recorded file size
	RecordSize *uint64 `json:"RecordSize,omitnil,omitempty" name:"RecordSize"`

	// Recording url
	RecordUrl *string `json:"RecordUrl,omitnil,omitempty" name:"RecordUrl"`
}

type EventInfo 

type EventInfo struct {
	// The Unix timestamp (seconds) when the event occurred.
	Timestamp *uint64 `json:"Timestamp,omitnil,omitempty" name:"Timestamp"`

	// The event type. Valid values:
	// `RoomStart`: The class started. `RoomEnd`: The class ended. `MemberJoin`: A user joined. `MemberQuit`: A user left. `RecordFinish`: Recording is finished.
	// ·Camera0n·: The camera is turned on.
	// `Camera0ff`: The camera is turned off.
	// `MicOn`: The mic is turned on.
	// `MicOff`: The mic is turned off.
	// `ScreenOn`: Screen sharing is enabled.
	// `ScreenOff`: Screen sharing is disabled.
	// `VisibleOn`: The page is visible.
	// `VisibleOff`: The page is invisible.
	EventType *string `json:"EventType,omitnil,omitempty" name:"EventType"`

	// The details of the event, including the room ID and the user to whom the event occurred.
	// Note: This field may return null, indicating that no valid values can be obtained.
	EventData *EventDataInfo `json:"EventData,omitnil,omitempty" name:"EventData"`
}

type GetRoomEventRequest 

type GetRoomEventRequest struct {
	*tchttp.BaseRequest

	// The room ID.
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// The application ID.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The starting page. Pagination starts from 1. This parameter is valid only if `keyword` is empty.
	Page *uint64 `json:"Page,omitnil,omitempty" name:"Page"`

	// The maximum number of records (up to 200) per page. This parameter is valid only if `keyword` is empty.
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// The type of events to query. Valid values:
	// `RoomStart`: The class started.
	// `RoomEnd`: The class ended.
	// `MemberJoin`: A user joined.
	// `MemberQuit`: A user left.
	// `RecordFinish`: Recording is finished.
	Keyword *string `json:"Keyword,omitnil,omitempty" name:"Keyword"`
}

func NewGetRoomEventRequest 

func NewGetRoomEventRequest() (request *GetRoomEventRequest)

func (*GetRoomEventRequest) FromJsonString 

func (r *GetRoomEventRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetRoomEventRequest) ToJsonString 

func (r *GetRoomEventRequest) ToJsonString() string

type GetRoomEventRequestParams 

type GetRoomEventRequestParams struct {
	// The room ID.
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// The application ID.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The starting page. Pagination starts from 1. This parameter is valid only if `keyword` is empty.
	Page *uint64 `json:"Page,omitnil,omitempty" name:"Page"`

	// The maximum number of records (up to 200) per page. This parameter is valid only if `keyword` is empty.
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// The type of events to query. Valid values:
	// `RoomStart`: The class started.
	// `RoomEnd`: The class ended.
	// `MemberJoin`: A user joined.
	// `MemberQuit`: A user left.
	// `RecordFinish`: Recording is finished.
	Keyword *string `json:"Keyword,omitnil,omitempty" name:"Keyword"`
}

Predefined struct for user

type GetRoomEventResponse 

type GetRoomEventResponse struct {
	*tchttp.BaseResponse
	Response *GetRoomEventResponseParams `json:"Response"`
}

func NewGetRoomEventResponse 

func NewGetRoomEventResponse() (response *GetRoomEventResponse)

func (*GetRoomEventResponse) FromJsonString 

func (r *GetRoomEventResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetRoomEventResponse) ToJsonString 

func (r *GetRoomEventResponse) ToJsonString() string

type GetRoomEventResponseParams 

type GetRoomEventResponseParams struct {
	// The total number of events for the room. The value of this parameter is not affected by `keyword`.
	Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"`

	// The event details, including the type and time.
	// Note: This field may return null, indicating that no valid values can be obtained.
	Events []*EventInfo `json:"Events,omitnil,omitempty" name:"Events"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type GetRoomMessageRequest 

type GetRoomMessageRequest struct {
	*tchttp.BaseRequest

	// The SDKAppID assigned by LCIC.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The room ID.
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// The starting message sequence. Messages before this sequence will be returned (not including the message whose sequence is `seq`).
	Seq *int64 `json:"Seq,omitnil,omitempty" name:"Seq"`

	// The maximum number of messages to return. The value of this parameter cannot exceed the maximum message count allowed by your package.
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

func NewGetRoomMessageRequest 

func NewGetRoomMessageRequest() (request *GetRoomMessageRequest)

func (*GetRoomMessageRequest) FromJsonString 

func (r *GetRoomMessageRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetRoomMessageRequest) ToJsonString 

func (r *GetRoomMessageRequest) ToJsonString() string

type GetRoomMessageRequestParams 

type GetRoomMessageRequestParams struct {
	// The SDKAppID assigned by LCIC.
	SdkAppId *int64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The room ID.
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// The starting message sequence. Messages before this sequence will be returned (not including the message whose sequence is `seq`).
	Seq *int64 `json:"Seq,omitnil,omitempty" name:"Seq"`

	// The maximum number of messages to return. The value of this parameter cannot exceed the maximum message count allowed by your package.
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

Predefined struct for user

type GetRoomMessageResponse 

type GetRoomMessageResponse struct {
	*tchttp.BaseResponse
	Response *GetRoomMessageResponseParams `json:"Response"`
}

func NewGetRoomMessageResponse 

func NewGetRoomMessageResponse() (response *GetRoomMessageResponse)

func (*GetRoomMessageResponse) FromJsonString 

func (r *GetRoomMessageResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetRoomMessageResponse) ToJsonString 

func (r *GetRoomMessageResponse) ToJsonString() string

type GetRoomMessageResponseParams 

type GetRoomMessageResponseParams struct {
	// The message list.
	Messages []*MessageList `json:"Messages,omitnil,omitempty" name:"Messages"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type GetRoomsRequest 

type GetRoomsRequest struct {
	*tchttp.BaseRequest

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The start time. The default start time is 30 minutes before the current time.
	StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// The end time. The default end time is 30 minutes after the current time.
	EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// The page to return records from. Pagination starts from 1.
	Page *uint64 `json:"Page,omitnil,omitempty" name:"Page"`

	// The number of records per page. The default is 10.
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// Classroom status. Default display all classes, 0 is not started, 1 is in class, 2 is finished, 3 is expired
	Status []*uint64 `json:"Status,omitnil,omitempty" name:"Status"`
}

func NewGetRoomsRequest 

func NewGetRoomsRequest() (request *GetRoomsRequest)

func (*GetRoomsRequest) FromJsonString 

func (r *GetRoomsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetRoomsRequest) ToJsonString 

func (r *GetRoomsRequest) ToJsonString() string

type GetRoomsRequestParams 

type GetRoomsRequestParams struct {
	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The start time. The default start time is 30 minutes before the current time.
	StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// The end time. The default end time is 30 minutes after the current time.
	EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// The page to return records from. Pagination starts from 1.
	Page *uint64 `json:"Page,omitnil,omitempty" name:"Page"`

	// The number of records per page. The default is 10.
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// Classroom status. Default display all classes, 0 is not started, 1 is in class, 2 is finished, 3 is expired
	Status []*uint64 `json:"Status,omitnil,omitempty" name:"Status"`
}

Predefined struct for user

type GetRoomsResponse 

type GetRoomsResponse struct {
	*tchttp.BaseResponse
	Response *GetRoomsResponseParams `json:"Response"`
}

func NewGetRoomsResponse 

func NewGetRoomsResponse() (response *GetRoomsResponse)

func (*GetRoomsResponse) FromJsonString 

func (r *GetRoomsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetRoomsResponse) ToJsonString 

func (r *GetRoomsResponse) ToJsonString() string

type GetRoomsResponseParams 

type GetRoomsResponseParams struct {
	// The total number of rooms.
	Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"`

	// The room list.
	Rooms []*RoomItem `json:"Rooms,omitnil,omitempty" name:"Rooms"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type GetWatermarkRequest 

type GetWatermarkRequest struct {
	*tchttp.BaseRequest

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

func NewGetWatermarkRequest 

func NewGetWatermarkRequest() (request *GetWatermarkRequest)

func (*GetWatermarkRequest) FromJsonString 

func (r *GetWatermarkRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetWatermarkRequest) ToJsonString 

func (r *GetWatermarkRequest) ToJsonString() string

type GetWatermarkRequestParams 

type GetWatermarkRequestParams struct {
	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

Predefined struct for user

type GetWatermarkResponse 

type GetWatermarkResponse struct {
	*tchttp.BaseResponse
	Response *GetWatermarkResponseParams `json:"Response"`
}

func NewGetWatermarkResponse 

func NewGetWatermarkResponse() (response *GetWatermarkResponse)

func (*GetWatermarkResponse) FromJsonString 

func (r *GetWatermarkResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetWatermarkResponse) ToJsonString 

func (r *GetWatermarkResponse) ToJsonString() string

type GetWatermarkResponseParams 

type GetWatermarkResponseParams struct {
	TeacherLogo *WatermarkConfig `json:"TeacherLogo,omitnil,omitempty" name:"TeacherLogo"`

	BoardLogo *WatermarkConfig `json:"BoardLogo,omitnil,omitempty" name:"BoardLogo"`

	// The background image. Note: This field may return null, indicating that no valid values can be obtained.
	BackgroundPicture *BackgroundPictureConfig `json:"BackgroundPicture,omitnil,omitempty" name:"BackgroundPicture"`

	// The watermark text. Note: This field may return null, indicating that no valid values can be obtained.
	Text *TextMarkConfig `json:"Text,omitnil,omitempty" name:"Text"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type GroupBaseInfo 

type GroupBaseInfo struct {
	// The group names. Note: This field may return null, indicating that no valid values can be obtained.
	GroupName *string `json:"GroupName,omitnil,omitempty" name:"GroupName"`

	// The user ID of the teacher. Note: This field may return null, indicating that no valid values can be obtained.
	TeacherId *string `json:"TeacherId,omitnil,omitempty" name:"TeacherId"`
}

type GroupInfo 

type GroupInfo struct {
	//
	// Note: This field may return null, indicating that no valid values can be obtained.
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	//
	// Note: This field may return null, indicating that no valid values can be obtained.
	GroupName *string `json:"GroupName,omitnil,omitempty" name:"GroupName"`

	//
	// Note: This field may return null, indicating that no valid values can be obtained.
	TeacherId *string `json:"TeacherId,omitnil,omitempty" name:"TeacherId"`

	//
	// Note: This field may return null, indicating that no valid values can be obtained.
	GroupType *uint64 `json:"GroupType,omitnil,omitempty" name:"GroupType"`

	//
	// Note: This field may return null, indicating that no valid values can be obtained.
	SubGroupIds *string `json:"SubGroupIds,omitnil,omitempty" name:"SubGroupIds"`
}

type KickUserFromRoomRequest 

type KickUserFromRoomRequest struct {
	*tchttp.BaseRequest

	// The room ID.
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The ID of the user to be removed.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// The removal type:
	// `1`: Keep the user out temporarily. The `Duration` parameter specifies the ban duration, during which the user is banned from entering the room.
	// `2`: Remove the user permanently.
	KickType *uint64 `json:"KickType,omitnil,omitempty" name:"KickType"`

	// The ban duration (seconds). This parameter is valid if `KickType` is `1`. The default value is `0`.
	Duration *uint64 `json:"Duration,omitnil,omitempty" name:"Duration"`
}

func NewKickUserFromRoomRequest 

func NewKickUserFromRoomRequest() (request *KickUserFromRoomRequest)

func (*KickUserFromRoomRequest) FromJsonString 

func (r *KickUserFromRoomRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*KickUserFromRoomRequest) ToJsonString 

func (r *KickUserFromRoomRequest) ToJsonString() string

type KickUserFromRoomRequestParams 

type KickUserFromRoomRequestParams struct {
	// The room ID.
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The ID of the user to be removed.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// The removal type:
	// `1`: Keep the user out temporarily. The `Duration` parameter specifies the ban duration, during which the user is banned from entering the room.
	// `2`: Remove the user permanently.
	KickType *uint64 `json:"KickType,omitnil,omitempty" name:"KickType"`

	// The ban duration (seconds). This parameter is valid if `KickType` is `1`. The default value is `0`.
	Duration *uint64 `json:"Duration,omitnil,omitempty" name:"Duration"`
}

Predefined struct for user

type KickUserFromRoomResponse 

type KickUserFromRoomResponse struct {
	*tchttp.BaseResponse
	Response *KickUserFromRoomResponseParams `json:"Response"`
}

func NewKickUserFromRoomResponse 

func NewKickUserFromRoomResponse() (response *KickUserFromRoomResponse)

func (*KickUserFromRoomResponse) FromJsonString 

func (r *KickUserFromRoomResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*KickUserFromRoomResponse) ToJsonString 

func (r *KickUserFromRoomResponse) ToJsonString() string

type KickUserFromRoomResponseParams 

type KickUserFromRoomResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type LoginOriginIdRequest 

type LoginOriginIdRequest struct {
	*tchttp.BaseRequest

	// LCIC SdkAppId
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// User's ID in the customer system, which should be unique under the same application
	OriginId *string `json:"OriginId,omitnil,omitempty" name:"OriginId"`
}

func NewLoginOriginIdRequest 

func NewLoginOriginIdRequest() (request *LoginOriginIdRequest)

func (*LoginOriginIdRequest) FromJsonString 

func (r *LoginOriginIdRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*LoginOriginIdRequest) ToJsonString 

func (r *LoginOriginIdRequest) ToJsonString() string

type LoginOriginIdRequestParams 

type LoginOriginIdRequestParams struct {
	// LCIC SdkAppId
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// User's ID in the customer system, which should be unique under the same application
	OriginId *string `json:"OriginId,omitnil,omitempty" name:"OriginId"`
}

Predefined struct for user

type LoginOriginIdResponse 

type LoginOriginIdResponse struct {
	*tchttp.BaseResponse
	Response *LoginOriginIdResponseParams `json:"Response"`
}

func NewLoginOriginIdResponse 

func NewLoginOriginIdResponse() (response *LoginOriginIdResponse)

func (*LoginOriginIdResponse) FromJsonString 

func (r *LoginOriginIdResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*LoginOriginIdResponse) ToJsonString 

func (r *LoginOriginIdResponse) ToJsonString() string

type LoginOriginIdResponseParams 

type LoginOriginIdResponseParams struct {
	// User ID
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// Login status token returned after successful login or registration. The token is valid for seven days.
	Token *string `json:"Token,omitnil,omitempty" name:"Token"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type LoginUserRequest 

type LoginUserRequest struct {
	*tchttp.BaseRequest

	// User ID obtained during registration
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`
}

func NewLoginUserRequest 

func NewLoginUserRequest() (request *LoginUserRequest)

func (*LoginUserRequest) FromJsonString 

func (r *LoginUserRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*LoginUserRequest) ToJsonString 

func (r *LoginUserRequest) ToJsonString() string

type LoginUserRequestParams 

type LoginUserRequestParams struct {
	// User ID obtained during registration
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`
}

Predefined struct for user

type LoginUserResponse 

type LoginUserResponse struct {
	*tchttp.BaseResponse
	Response *LoginUserResponseParams `json:"Response"`
}

func NewLoginUserResponse 

func NewLoginUserResponse() (response *LoginUserResponse)

func (*LoginUserResponse) FromJsonString 

func (r *LoginUserResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*LoginUserResponse) ToJsonString 

func (r *LoginUserResponse) ToJsonString() string

type LoginUserResponseParams 

type LoginUserResponseParams struct {
	// User ID
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// Login status token returned after successful login or registration. The token is valid for seven days.
	Token *string `json:"Token,omitnil,omitempty" name:"Token"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type MemberRecord 

type MemberRecord struct {
	// User ID
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// Username
	UserName *string `json:"UserName,omitnil,omitempty" name:"UserName"`

	// Online duration, in seconds
	PresentTime *uint64 `json:"PresentTime,omitnil,omitempty" name:"PresentTime"`

	// Whether the camera is enabled
	Camera *uint64 `json:"Camera,omitnil,omitempty" name:"Camera"`

	// Whether the mic is enabled
	Mic *uint64 `json:"Mic,omitnil,omitempty" name:"Mic"`

	// Whether the user is muted
	Silence *uint64 `json:"Silence,omitnil,omitempty" name:"Silence"`

	// Number of questions answered by the user
	AnswerQuestions *uint64 `json:"AnswerQuestions,omitnil,omitempty" name:"AnswerQuestions"`

	// Number of hand raising times
	HandUps *uint64 `json:"HandUps,omitnil,omitempty" name:"HandUps"`

	// First time that the user entered the room, in UNIX timestamp format
	FirstJoinTimestamp *uint64 `json:"FirstJoinTimestamp,omitnil,omitempty" name:"FirstJoinTimestamp"`

	// Last time that the user left the room, in UNIX timestamp format
	LastQuitTimestamp *uint64 `json:"LastQuitTimestamp,omitnil,omitempty" name:"LastQuitTimestamp"`

	// Number of rewards received
	Rewords *uint64 `json:"Rewords,omitnil,omitempty" name:"Rewords"`

	// The user's IP address.
	IPAddress *string `json:"IPAddress,omitnil,omitempty" name:"IPAddress"`

	// The user's location.
	Location *string `json:"Location,omitnil,omitempty" name:"Location"`

	// The user's device type. 0: Unknown; 1: Windows; 2: macOS; 3: Android; 4: iOS; 5: Web; 6: Mobile webpage; 7: Weixin Mini Program.
	Device *int64 `json:"Device,omitnil,omitempty" name:"Device"`

	// The number of times a user turned their mic on.
	PerMemberMicCount *int64 `json:"PerMemberMicCount,omitnil,omitempty" name:"PerMemberMicCount"`

	// The number of messages sent by a user.
	PerMemberMessageCount *int64 `json:"PerMemberMessageCount,omitnil,omitempty" name:"PerMemberMessageCount"`

	// The user role. `0`: Student; `1`: Teacher; `2`: Teaching Assistant; `3`: Spectator.
	Role *uint64 `json:"Role,omitnil,omitempty" name:"Role"`

	// The class number.
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// The sub-class number.
	// Note: This field may return null, indicating that no valid values can be obtained.
	SubGroupId []*string `json:"SubGroupId,omitnil,omitempty" name:"SubGroupId"`

	// Whether the user is on the stage.
	// Note: This field may return null, indicating that no valid values can be obtained.
	Stage *int64 `json:"Stage,omitnil,omitempty" name:"Stage"`

	// User status. 0 is not present, 1 is online, 2 is offline, 3 is kicked, 4 is permanently kicked, 5 is temporarily offline
	CurrentState *uint64 `json:"CurrentState,omitnil,omitempty" name:"CurrentState"`
}

type MessageItem 

type MessageItem struct {
	// The message type. `0`: Text; `1`: Image.
	// Note: This field may return null, indicating that no valid values can be obtained.
	MessageType *int64 `json:"MessageType,omitnil,omitempty" name:"MessageType"`

	// The text. This parameter is valid if `MessageType` is `0`.
	// Note: This field may return null, indicating that no valid values can be obtained.
	TextMessage *string `json:"TextMessage,omitnil,omitempty" name:"TextMessage"`

	// The image URL. This parameter is valid if `MessageType` is `1`.
	// Note: This field may return null, indicating that no valid values can be obtained.
	ImageMessage *string `json:"ImageMessage,omitnil,omitempty" name:"ImageMessage"`

	// Customize the message content. Vaild when message type=2.
	CustomMessage *CustomMsgContent `json:"CustomMessage,omitnil,omitempty" name:"CustomMessage"`
}

type MessageList 

type MessageList struct {
	// The message timestamp.
	// Note: This field may return null, indicating that no valid values can be obtained.
	Timestamp *int64 `json:"Timestamp,omitnil,omitempty" name:"Timestamp"`

	// The sender.
	// Note: This field may return null, indicating that no valid values can be obtained.
	FromAccount *string `json:"FromAccount,omitnil,omitempty" name:"FromAccount"`

	// The message sequence, which is unique across a class. The earlier a message is sent, the lower the sequence.
	// Note: This field may return null, indicating that no valid values can be obtained.
	Seq *int64 `json:"Seq,omitnil,omitempty" name:"Seq"`

	// The message content.
	// Note: This field may return null, indicating that no valid values can be obtained.
	MessageBody []*MessageItem `json:"MessageBody,omitnil,omitempty" name:"MessageBody"`
}

type ModifyAppRequest 

type ModifyAppRequest struct {
	*tchttp.BaseRequest

	// LCIC SdkAppId
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Callback URL. Currently, only port 80 and port 443 are supported.
	Callback *string `json:"Callback,omitnil,omitempty" name:"Callback"`

	// The callback key.
	CallbackKey *string `json:"CallbackKey,omitnil,omitempty" name:"CallbackKey"`

	// Transfer Id
	TransferId *string `json:"TransferId,omitnil,omitempty" name:"TransferId"`

	// Transfer Url
	TransferUrl *string `json:"TransferUrl,omitnil,omitempty" name:"TransferUrl"`
}

func NewModifyAppRequest 

func NewModifyAppRequest() (request *ModifyAppRequest)

func (*ModifyAppRequest) FromJsonString 

func (r *ModifyAppRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyAppRequest) ToJsonString 

func (r *ModifyAppRequest) ToJsonString() string

type ModifyAppRequestParams 

type ModifyAppRequestParams struct {
	// LCIC SdkAppId
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Callback URL. Currently, only port 80 and port 443 are supported.
	Callback *string `json:"Callback,omitnil,omitempty" name:"Callback"`

	// The callback key.
	CallbackKey *string `json:"CallbackKey,omitnil,omitempty" name:"CallbackKey"`

	// Transfer Id
	TransferId *string `json:"TransferId,omitnil,omitempty" name:"TransferId"`

	// Transfer Url
	TransferUrl *string `json:"TransferUrl,omitnil,omitempty" name:"TransferUrl"`
}

Predefined struct for user

type ModifyAppResponse 

type ModifyAppResponse struct {
	*tchttp.BaseResponse
	Response *ModifyAppResponseParams `json:"Response"`
}

func NewModifyAppResponse 

func NewModifyAppResponse() (response *ModifyAppResponse)

func (*ModifyAppResponse) FromJsonString 

func (r *ModifyAppResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyAppResponse) ToJsonString 

func (r *ModifyAppResponse) ToJsonString() string

type ModifyAppResponseParams 

type ModifyAppResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ModifyGroupRequest 

type ModifyGroupRequest struct {
	*tchttp.BaseRequest

	// The ID of the group to modify.
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The user ID of the teacher.
	TeacherId *string `json:"TeacherId,omitnil,omitempty" name:"TeacherId"`

	// The new group name.
	GroupName *string `json:"GroupName,omitnil,omitempty" name:"GroupName"`
}

func NewModifyGroupRequest 

func NewModifyGroupRequest() (request *ModifyGroupRequest)

func (*ModifyGroupRequest) FromJsonString 

func (r *ModifyGroupRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyGroupRequest) ToJsonString 

func (r *ModifyGroupRequest) ToJsonString() string

type ModifyGroupRequestParams 

type ModifyGroupRequestParams struct {
	// The ID of the group to modify.
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The user ID of the teacher.
	TeacherId *string `json:"TeacherId,omitnil,omitempty" name:"TeacherId"`

	// The new group name.
	GroupName *string `json:"GroupName,omitnil,omitempty" name:"GroupName"`
}

Predefined struct for user

type ModifyGroupResponse 

type ModifyGroupResponse struct {
	*tchttp.BaseResponse
	Response *ModifyGroupResponseParams `json:"Response"`
}

func NewModifyGroupResponse 

func NewModifyGroupResponse() (response *ModifyGroupResponse)

func (*ModifyGroupResponse) FromJsonString 

func (r *ModifyGroupResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyGroupResponse) ToJsonString 

func (r *ModifyGroupResponse) ToJsonString() string

type ModifyGroupResponseParams 

type ModifyGroupResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ModifyRoomRequest 

type ModifyRoomRequest struct {
	*tchttp.BaseRequest

	// The room ID.
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The room start time (Unix timestamp).
	StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// The room end time (Unix timestamp).
	EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// The user ID of the teacher. User IDs are returned by the user registration APIs.
	TeacherId *string `json:"TeacherId,omitnil,omitempty" name:"TeacherId"`

	// The room name.
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// The resolution. Valid values: 1: SD; 2: HD; 3: FHD.
	Resolution *uint64 `json:"Resolution,omitnil,omitempty" name:"Resolution"`

	// The maximum number of mic-on users (excluding the teacher). Value range: 0-16.
	MaxMicNumber *uint64 `json:"MaxMicNumber,omitnil,omitempty" name:"MaxMicNumber"`

	// Whether to automatically turn the mic on when a user enters the room. Valid values: 0: No (default value); 1: Yes.
	AutoMic *uint64 `json:"AutoMic,omitnil,omitempty" name:"AutoMic"`

	// Whether to enable the high audio quality mode. Valid values: 0: No (default value); 1: Yes.
	AudioQuality *uint64 `json:"AudioQuality,omitnil,omitempty" name:"AudioQuality"`

	// The room subtype. Valid values: videodoc: Document + Video; video: Video only; coteaching: Dual-teacher.
	SubType *string `json:"SubType,omitnil,omitempty" name:"SubType"`

	// Whether to disable auto recording. Valid values: 0: No (default); 1: Yes. If this parameter is 0, recording will start when the class starts and stops when the class ends.
	DisableRecord *uint64 `json:"DisableRecord,omitnil,omitempty" name:"DisableRecord"`

	// The user IDs of the teacher assistants. User IDs are returned by the user registration APIs.
	Assistants []*string `json:"Assistants,omitnil,omitempty" name:"Assistants"`

	// The ID of the group to bind.
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// Whether the students' consent is required to control their cameras/microphones.
	EnableDirectControl *uint64 `json:"EnableDirectControl,omitnil,omitempty" name:"EnableDirectControl"`
}

func NewModifyRoomRequest 

func NewModifyRoomRequest() (request *ModifyRoomRequest)

func (*ModifyRoomRequest) FromJsonString 

func (r *ModifyRoomRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyRoomRequest) ToJsonString 

func (r *ModifyRoomRequest) ToJsonString() string

type ModifyRoomRequestParams 

type ModifyRoomRequestParams struct {
	// The room ID.
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The room start time (Unix timestamp).
	StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// The room end time (Unix timestamp).
	EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// The user ID of the teacher. User IDs are returned by the user registration APIs.
	TeacherId *string `json:"TeacherId,omitnil,omitempty" name:"TeacherId"`

	// The room name.
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// The resolution. Valid values: 1: SD; 2: HD; 3: FHD.
	Resolution *uint64 `json:"Resolution,omitnil,omitempty" name:"Resolution"`

	// The maximum number of mic-on users (excluding the teacher). Value range: 0-16.
	MaxMicNumber *uint64 `json:"MaxMicNumber,omitnil,omitempty" name:"MaxMicNumber"`

	// Whether to automatically turn the mic on when a user enters the room. Valid values: 0: No (default value); 1: Yes.
	AutoMic *uint64 `json:"AutoMic,omitnil,omitempty" name:"AutoMic"`

	// Whether to enable the high audio quality mode. Valid values: 0: No (default value); 1: Yes.
	AudioQuality *uint64 `json:"AudioQuality,omitnil,omitempty" name:"AudioQuality"`

	// The room subtype. Valid values: videodoc: Document + Video; video: Video only; coteaching: Dual-teacher.
	SubType *string `json:"SubType,omitnil,omitempty" name:"SubType"`

	// Whether to disable auto recording. Valid values: 0: No (default); 1: Yes. If this parameter is 0, recording will start when the class starts and stops when the class ends.
	DisableRecord *uint64 `json:"DisableRecord,omitnil,omitempty" name:"DisableRecord"`

	// The user IDs of the teacher assistants. User IDs are returned by the user registration APIs.
	Assistants []*string `json:"Assistants,omitnil,omitempty" name:"Assistants"`

	// The ID of the group to bind.
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// Whether the students' consent is required to control their cameras/microphones.
	EnableDirectControl *uint64 `json:"EnableDirectControl,omitnil,omitempty" name:"EnableDirectControl"`
}

Predefined struct for user

type ModifyRoomResponse 

type ModifyRoomResponse struct {
	*tchttp.BaseResponse
	Response *ModifyRoomResponseParams `json:"Response"`
}

func NewModifyRoomResponse 

func NewModifyRoomResponse() (response *ModifyRoomResponse)

func (*ModifyRoomResponse) FromJsonString 

func (r *ModifyRoomResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyRoomResponse) ToJsonString 

func (r *ModifyRoomResponse) ToJsonString() string

type ModifyRoomResponseParams 

type ModifyRoomResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ModifyUserProfileRequest 

type ModifyUserProfileRequest struct {
	*tchttp.BaseRequest

	// The ID of the user whose profile will be modified.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// The new username to use.
	Nickname *string `json:"Nickname,omitnil,omitempty" name:"Nickname"`

	// The URL of the new profile photo.
	Avatar *string `json:"Avatar,omitnil,omitempty" name:"Avatar"`
}

func NewModifyUserProfileRequest 

func NewModifyUserProfileRequest() (request *ModifyUserProfileRequest)

func (*ModifyUserProfileRequest) FromJsonString 

func (r *ModifyUserProfileRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyUserProfileRequest) ToJsonString 

func (r *ModifyUserProfileRequest) ToJsonString() string

type ModifyUserProfileRequestParams 

type ModifyUserProfileRequestParams struct {
	// The ID of the user whose profile will be modified.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// The new username to use.
	Nickname *string `json:"Nickname,omitnil,omitempty" name:"Nickname"`

	// The URL of the new profile photo.
	Avatar *string `json:"Avatar,omitnil,omitempty" name:"Avatar"`
}

Predefined struct for user

type ModifyUserProfileResponse 

type ModifyUserProfileResponse struct {
	*tchttp.BaseResponse
	Response *ModifyUserProfileResponseParams `json:"Response"`
}

func NewModifyUserProfileResponse 

func NewModifyUserProfileResponse() (response *ModifyUserProfileResponse)

func (*ModifyUserProfileResponse) FromJsonString 

func (r *ModifyUserProfileResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyUserProfileResponse) ToJsonString 

func (r *ModifyUserProfileResponse) ToJsonString() string

type ModifyUserProfileResponseParams 

type ModifyUserProfileResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type QuestionInfo 

type QuestionInfo struct {
	// The question ID.
	QuestionId *string `json:"QuestionId,omitnil,omitempty" name:"QuestionId"`

	// The question.
	QuestionContent *string `json:"QuestionContent,omitnil,omitempty" name:"QuestionContent"`

	// The time limit for the question. If you set this parameter to `0`, there will not be a time limit.
	Duration *uint64 `json:"Duration,omitnil,omitempty" name:"Duration"`

	// The correct answer. Bits are used to indicate the options that should be chosen. For example, `0x1` indicates option A; `0x11` indicates A and B, and so on.
	CorrectAnswer *int64 `json:"CorrectAnswer,omitnil,omitempty" name:"CorrectAnswer"`

	// The statistics for each type of answer.
	// Note: This field may return null, indicating that no valid values can be obtained.
	AnswerStats []*AnswerStat `json:"AnswerStats,omitnil,omitempty" name:"AnswerStats"`
}

type RegisterUserRequest 

type RegisterUserRequest struct {
	*tchttp.BaseRequest

	// LCIC SdkAppId
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Username
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// User's ID in the customer system, which should be unique under the same application
	OriginId *string `json:"OriginId,omitnil,omitempty" name:"OriginId"`

	// User's profile photo
	Avatar *string `json:"Avatar,omitnil,omitempty" name:"Avatar"`
}

func NewRegisterUserRequest 

func NewRegisterUserRequest() (request *RegisterUserRequest)

func (*RegisterUserRequest) FromJsonString 

func (r *RegisterUserRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*RegisterUserRequest) ToJsonString 

func (r *RegisterUserRequest) ToJsonString() string

type RegisterUserRequestParams 

type RegisterUserRequestParams struct {
	// LCIC SdkAppId
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// Username
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// User's ID in the customer system, which should be unique under the same application
	OriginId *string `json:"OriginId,omitnil,omitempty" name:"OriginId"`

	// User's profile photo
	Avatar *string `json:"Avatar,omitnil,omitempty" name:"Avatar"`
}

Predefined struct for user

type RegisterUserResponse 

type RegisterUserResponse struct {
	*tchttp.BaseResponse
	Response *RegisterUserResponseParams `json:"Response"`
}

func NewRegisterUserResponse 

func NewRegisterUserResponse() (response *RegisterUserResponse)

func (*RegisterUserResponse) FromJsonString 

func (r *RegisterUserResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*RegisterUserResponse) ToJsonString 

func (r *RegisterUserResponse) ToJsonString() string

type RegisterUserResponseParams 

type RegisterUserResponseParams struct {
	// User ID
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// Login status token returned after successful login or registration. The token is valid for seven days.
	Token *string `json:"Token,omitnil,omitempty" name:"Token"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type RoomInfo 

type RoomInfo struct {
	// The room name.
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// The room start time (Unix timestamp).
	StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// The room end time (Unix timestamp).
	EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// The resolution. Valid values: `1`: SD; `2`: HD; `3`: FHD.
	Resolution *uint64 `json:"Resolution,omitnil,omitempty" name:"Resolution"`

	// The maximum number of mic-on users (excluding the teacher). Value range: 0-16.
	MaxMicNumber *uint64 `json:"MaxMicNumber,omitnil,omitempty" name:"MaxMicNumber"`

	// The room subtype. Valid values: `videodoc`: Document + Video; `video`: Video only; `coteaching`: Dual-teacher.
	SubType *string `json:"SubType,omitnil,omitempty" name:"SubType"`

	// The user ID of the teacher. User IDs are returned by the user registration APIs.
	TeacherId *string `json:"TeacherId,omitnil,omitempty" name:"TeacherId"`

	// Whether to automatically turn the mic on when a user enters the room. Valid values: `0` (default): No; `1`: Yes.
	AutoMic *uint64 `json:"AutoMic,omitnil,omitempty" name:"AutoMic"`

	// Whether to disconnect communication after audio/video permissions are revoked. Valid values: `0` (default): Yes; `1`: No.
	TurnOffMic *uint64 `json:"TurnOffMic,omitnil,omitempty" name:"TurnOffMic"`

	// Whether to enable the high audio quality mode. Valid values: `0` (default): No; `1`: Yes.
	AudioQuality *uint64 `json:"AudioQuality,omitnil,omitempty" name:"AudioQuality"`

	// Whether to disable auto recording. Valid values: `0` (default): No; `1`: Yes. If this parameter is `0`, recording will start when the class starts and stops when the class ends.
	DisableRecord *uint64 `json:"DisableRecord,omitnil,omitempty" name:"DisableRecord"`

	// The user IDs of the teacher assistants. User IDs are returned by the user registration APIs.
	Assistants []*string `json:"Assistants,omitnil,omitempty" name:"Assistants"`

	// The number of RTC users.
	RTCAudienceNumber *uint64 `json:"RTCAudienceNumber,omitnil,omitempty" name:"RTCAudienceNumber"`

	// The audience type.
	AudienceType *uint64 `json:"AudienceType,omitnil,omitempty" name:"AudienceType"`

	// The recording layout.
	RecordLayout *uint64 `json:"RecordLayout,omitnil,omitempty" name:"RecordLayout"`

	// The ID of the group to bind. Note: This field may return null, indicating that no valid values can be obtained.
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// Whether the students' consent is required to control their cameras/microphones.
	EnableDirectControl *uint64 `json:"EnableDirectControl,omitnil,omitempty" name:"EnableDirectControl"`

	// Turn on focus mode. 0 Watch all character audio and video (default) 1 Watch only teachers and teaching assistants
	InteractionMode *int64 `json:"InteractionMode,omitnil,omitempty" name:"InteractionMode"`

	// Horizontal and vertical screen. 0: Horizontal screen to open broadcast (default); 1: Vertical screen to open broadcast, currently only support mobile pure video type
	VideoOrientation *int64 `json:"VideoOrientation,omitnil,omitempty" name:"VideoOrientation"`

	// Whether the room is enabled for grading after the lesson. 0: not enabled 1: enabled
	IsGradingRequiredPostClass *int64 `json:"IsGradingRequiredPostClass,omitnil,omitempty" name:"IsGradingRequiredPostClass"`

	// Room Type: 0 Small Classroom(default); 1 Lecture Hall(public class)
	RoomType *int64 `json:"RoomType,omitnil,omitempty" name:"RoomType"`

	// Drag class time: unit minutes, 0 is unlimited (default), -1 is can't drag the class, greater than 0 is the time of dragging the class, the maximum value of 120 minutes
	EndDelayTime *int64 `json:"EndDelayTime,omitnil,omitempty" name:"EndDelayTime"`

	// Live type: 0 regular (default) 1 Simulated Live
	LiveType *uint64 `json:"LiveType,omitnil,omitempty" name:"LiveType"`

	// Simulated Live link
	RecordLiveUrl *string `json:"RecordLiveUrl,omitnil,omitempty" name:"RecordLiveUrl"`

	// Whether to start the lesson automatically: 0 not automatic lesson (default) 1 automatic lesson live_type=1 is valid
	EnableAutoStart *uint64 `json:"EnableAutoStart,omitnil,omitempty" name:"EnableAutoStart"`

	// Recorded file background image, support png, jpg, jpeg, bmp format, does not support transparent channel for the time being
	RecordBackground *string `json:"RecordBackground,omitnil,omitempty" name:"RecordBackground"`

	// Record customized scene, only recordlayout=9 this parameter is valid, the data content for the user-defined scene parameters, data format for the json key-value pairs, where the key-value pairs of the value for the string type.
	RecordScene *string `json:"RecordScene,omitnil,omitempty" name:"RecordScene"`

	// Record customized language, only when recordlayout=9, this parameter is valid.
	//
	// Deprecated: RecordLang is deprecated.
	RecordLang *string `json:"RecordLang,omitnil,omitempty" name:"RecordLang"`
}

type RoomItem 

type RoomItem struct {
	// The name.
	// Note: This field may return null, indicating that no valid values can be obtained.
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// The room ID.
	// Note: This field may return null, indicating that no valid values can be obtained.
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// The room status. `0`: Not started; `1`: Started; `2`: Ended.
	// Note: This field may return null, indicating that no valid values can be obtained.
	Status *uint64 `json:"Status,omitnil,omitempty" name:"Status"`

	// The scheduled start time.
	// Note: This field may return null, indicating that no valid values can be obtained.
	StartTime *uint64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// The scheduled end time.
	// Note: This field may return null, indicating that no valid values can be obtained.
	EndTime *uint64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// The actual start time.
	// Note: This field may return null, indicating that no valid values can be obtained.
	RealStartTime *uint64 `json:"RealStartTime,omitnil,omitempty" name:"RealStartTime"`

	// The actual end time.
	// Note: This field may return null, indicating that no valid values can be obtained.
	RealEndTime *uint64 `json:"RealEndTime,omitnil,omitempty" name:"RealEndTime"`

	// The resolution. `1`: SD.
	// `2`: HD
	// `3`: FHD
	// Note: This field may return null, indicating that no valid values can be obtained.
	Resolution *uint64 `json:"Resolution,omitnil,omitempty" name:"Resolution"`

	// The maximum number of mic-on users allowed.
	// Note: This field may return null, indicating that no valid values can be obtained.
	MaxRTCMember *uint64 `json:"MaxRTCMember,omitnil,omitempty" name:"MaxRTCMember"`

	// The URL of the room's recording. This parameter has been deprecated. Please use `RecordUrl` instead.
	// Note: This field may return null, indicating that no valid values can be obtained.
	ReplayUrl *string `json:"ReplayUrl,omitnil,omitempty" name:"ReplayUrl"`

	// The recording URL (HTTPS), which is generated only after a room ends.
	// Note: This field may return null, indicating that no valid values can be obtained.
	RecordUrl *string `json:"RecordUrl,omitnil,omitempty" name:"RecordUrl"`

	// The maximum number of users allowed (including teachers) in the room. The default value is `0`, which indicates that no limit is set.
	// Note: This field may return null, indicating that no valid values can be obtained.
	MaxMicNumber *uint64 `json:"MaxMicNumber,omitnil,omitempty" name:"MaxMicNumber"`

	// Whether the students' consent is required to control their cameras/microphones.
	// Note: This field may return null, indicating that no valid value was found.
	EnableDirectControl *uint64 `json:"EnableDirectControl,omitnil,omitempty" name:"EnableDirectControl"`

	InteractionMode *int64 `json:"InteractionMode,omitnil,omitempty" name:"InteractionMode"`

	VideoOrientation *int64 `json:"VideoOrientation,omitnil,omitempty" name:"VideoOrientation"`

	IsGradingRequiredPostClass *int64 `json:"IsGradingRequiredPostClass,omitnil,omitempty" name:"IsGradingRequiredPostClass"`

	// Room Type: 0 Small Classroom(default); 1 Lecture Hall(public class)
	RoomType *int64 `json:"RoomType,omitnil,omitempty" name:"RoomType"`

	EndDelayTime *int64 `json:"EndDelayTime,omitnil,omitempty" name:"EndDelayTime"`

	LiveType *uint64 `json:"LiveType,omitnil,omitempty" name:"LiveType"`

	RecordLiveUrl *string `json:"RecordLiveUrl,omitnil,omitempty" name:"RecordLiveUrl"`

	EnableAutoStart *uint64 `json:"EnableAutoStart,omitnil,omitempty" name:"EnableAutoStart"`

	RecordBackground *string `json:"RecordBackground,omitnil,omitempty" name:"RecordBackground"`

	RecordScene *string `json:"RecordScene,omitnil,omitempty" name:"RecordScene"`

	RecordLang *string `json:"RecordLang,omitnil,omitempty" name:"RecordLang"`
}

type SetAppCustomContentRequest 

type SetAppCustomContentRequest struct {
	*tchttp.BaseRequest

	// Custom content
	CustomContent []*AppCustomContent `json:"CustomContent,omitnil,omitempty" name:"CustomContent"`

	// Application ID
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

func NewSetAppCustomContentRequest 

func NewSetAppCustomContentRequest() (request *SetAppCustomContentRequest)

func (*SetAppCustomContentRequest) FromJsonString 

func (r *SetAppCustomContentRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*SetAppCustomContentRequest) ToJsonString 

func (r *SetAppCustomContentRequest) ToJsonString() string

type SetAppCustomContentRequestParams 

type SetAppCustomContentRequestParams struct {
	// Custom content
	CustomContent []*AppCustomContent `json:"CustomContent,omitnil,omitempty" name:"CustomContent"`

	// Application ID
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`
}

Predefined struct for user

type SetAppCustomContentResponse 

type SetAppCustomContentResponse struct {
	*tchttp.BaseResponse
	Response *SetAppCustomContentResponseParams `json:"Response"`
}

func NewSetAppCustomContentResponse 

func NewSetAppCustomContentResponse() (response *SetAppCustomContentResponse)

func (*SetAppCustomContentResponse) FromJsonString 

func (r *SetAppCustomContentResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*SetAppCustomContentResponse) ToJsonString 

func (r *SetAppCustomContentResponse) ToJsonString() string

type SetAppCustomContentResponseParams 

type SetAppCustomContentResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type SetWatermarkRequest 

type SetWatermarkRequest struct {
	*tchttp.BaseRequest

	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The URL of the watermark for the teacher’s video. If you pass in an empty string, the teacher’s video will not have a watermark.
	TeacherUrl *string `json:"TeacherUrl,omitnil,omitempty" name:"TeacherUrl"`

	// The URL of the watermark for the whiteboard. If you pass in an empty string, the whiteboard video will not have a watermark.
	BoardUrl *string `json:"BoardUrl,omitnil,omitempty" name:"BoardUrl"`

	// The image displayed when there is no video. If you pass in an empty string, no images will be displayed.
	VideoUrl *string `json:"VideoUrl,omitnil,omitempty" name:"VideoUrl"`

	// The width of the whiteboard’s watermark, which is expressed as a percentage of the video width. The value range is 0-100, and the default value is 0.
	BoardW *float64 `json:"BoardW,omitnil,omitempty" name:"BoardW"`

	// The height of the whiteboard’s watermark, which is expressed as a percentage of the video height. The value range is 0-100, and the default value is 0.
	BoardH *float64 `json:"BoardH,omitnil,omitempty" name:"BoardH"`

	// The horizontal offset of the whiteboard’s watermark, which is expressed as a percentage of the video width. For example, 50 indicates that the watermark will appear in the middle horizontally. Value range: 0-100.
	BoardX *float64 `json:"BoardX,omitnil,omitempty" name:"BoardX"`

	// The vertical offset of the whiteboard’s watermark, which is expressed as a percentage of the video width. For example, 50 indicates that the watermark will appear in the middle vertically. Value range: 0-100.
	BoardY *float64 `json:"BoardY,omitnil,omitempty" name:"BoardY"`

	// The width of the watermark for the teacher’s video, which is expressed as a percentage of the video width. The value range is 0-100, and the default value is 0.
	TeacherW *float64 `json:"TeacherW,omitnil,omitempty" name:"TeacherW"`

	// The height of the watermark for the teacher’s video, which is expressed as a percentage of the video height. The value range is 0-100, and the default value is 0.
	TeacherH *float64 `json:"TeacherH,omitnil,omitempty" name:"TeacherH"`

	// The horizontal offset of the watermark for the teacher’s video, which is expressed as a percentage of the video width. For example, 50 indicates that the watermark will appear in the middle horizontally. Value range: 0-100.
	TeacherX *float64 `json:"TeacherX,omitnil,omitempty" name:"TeacherX"`

	// The vertical offset of the watermark for the teacher’s video, which is expressed as a percentage of the video width. For example, 50 indicates that the watermark will appear in the middle vertically. Value range: 0-100.
	TeacherY *float64 `json:"TeacherY,omitnil,omitempty" name:"TeacherY"`

	// The watermark text. If you pass in an empty string, there will be no text.
	Text *string `json:"Text,omitnil,omitempty" name:"Text"`

	// The watermark text color.
	TextColor *string `json:"TextColor,omitnil,omitempty" name:"TextColor"`
}

func NewSetWatermarkRequest 

func NewSetWatermarkRequest() (request *SetWatermarkRequest)

func (*SetWatermarkRequest) FromJsonString 

func (r *SetWatermarkRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*SetWatermarkRequest) ToJsonString 

func (r *SetWatermarkRequest) ToJsonString() string

type SetWatermarkRequestParams 

type SetWatermarkRequestParams struct {
	// The SDKAppID assigned by LCIC.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// The URL of the watermark for the teacher’s video. If you pass in an empty string, the teacher’s video will not have a watermark.
	TeacherUrl *string `json:"TeacherUrl,omitnil,omitempty" name:"TeacherUrl"`

	// The URL of the watermark for the whiteboard. If you pass in an empty string, the whiteboard video will not have a watermark.
	BoardUrl *string `json:"BoardUrl,omitnil,omitempty" name:"BoardUrl"`

	// The image displayed when there is no video. If you pass in an empty string, no images will be displayed.
	VideoUrl *string `json:"VideoUrl,omitnil,omitempty" name:"VideoUrl"`

	// The width of the whiteboard’s watermark, which is expressed as a percentage of the video width. The value range is 0-100, and the default value is 0.
	BoardW *float64 `json:"BoardW,omitnil,omitempty" name:"BoardW"`

	// The height of the whiteboard’s watermark, which is expressed as a percentage of the video height. The value range is 0-100, and the default value is 0.
	BoardH *float64 `json:"BoardH,omitnil,omitempty" name:"BoardH"`

	// The horizontal offset of the whiteboard’s watermark, which is expressed as a percentage of the video width. For example, 50 indicates that the watermark will appear in the middle horizontally. Value range: 0-100.
	BoardX *float64 `json:"BoardX,omitnil,omitempty" name:"BoardX"`

	// The vertical offset of the whiteboard’s watermark, which is expressed as a percentage of the video width. For example, 50 indicates that the watermark will appear in the middle vertically. Value range: 0-100.
	BoardY *float64 `json:"BoardY,omitnil,omitempty" name:"BoardY"`

	// The width of the watermark for the teacher’s video, which is expressed as a percentage of the video width. The value range is 0-100, and the default value is 0.
	TeacherW *float64 `json:"TeacherW,omitnil,omitempty" name:"TeacherW"`

	// The height of the watermark for the teacher’s video, which is expressed as a percentage of the video height. The value range is 0-100, and the default value is 0.
	TeacherH *float64 `json:"TeacherH,omitnil,omitempty" name:"TeacherH"`

	// The horizontal offset of the watermark for the teacher’s video, which is expressed as a percentage of the video width. For example, 50 indicates that the watermark will appear in the middle horizontally. Value range: 0-100.
	TeacherX *float64 `json:"TeacherX,omitnil,omitempty" name:"TeacherX"`

	// The vertical offset of the watermark for the teacher’s video, which is expressed as a percentage of the video width. For example, 50 indicates that the watermark will appear in the middle vertically. Value range: 0-100.
	TeacherY *float64 `json:"TeacherY,omitnil,omitempty" name:"TeacherY"`

	// The watermark text. If you pass in an empty string, there will be no text.
	Text *string `json:"Text,omitnil,omitempty" name:"Text"`

	// The watermark text color.
	TextColor *string `json:"TextColor,omitnil,omitempty" name:"TextColor"`
}

Predefined struct for user

type SetWatermarkResponse 

type SetWatermarkResponse struct {
	*tchttp.BaseResponse
	Response *SetWatermarkResponseParams `json:"Response"`
}

func NewSetWatermarkResponse 

func NewSetWatermarkResponse() (response *SetWatermarkResponse)

func (*SetWatermarkResponse) FromJsonString 

func (r *SetWatermarkResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*SetWatermarkResponse) ToJsonString 

func (r *SetWatermarkResponse) ToJsonString() string

type SetWatermarkResponseParams 

type SetWatermarkResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type StartRoomRequest 

type StartRoomRequest struct {
	*tchttp.BaseRequest

	// The room ID.
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`
}

func NewStartRoomRequest 

func NewStartRoomRequest() (request *StartRoomRequest)

func (*StartRoomRequest) FromJsonString 

func (r *StartRoomRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*StartRoomRequest) ToJsonString 

func (r *StartRoomRequest) ToJsonString() string

type StartRoomRequestParams 

type StartRoomRequestParams struct {
	// The room ID.
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`
}

Predefined struct for user

type StartRoomResponse 

type StartRoomResponse struct {
	*tchttp.BaseResponse
	Response *StartRoomResponseParams `json:"Response"`
}

func NewStartRoomResponse 

func NewStartRoomResponse() (response *StartRoomResponse)

func (*StartRoomResponse) FromJsonString 

func (r *StartRoomResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*StartRoomResponse) ToJsonString 

func (r *StartRoomResponse) ToJsonString() string

type StartRoomResponseParams 

type StartRoomResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type TextMarkConfig 

type TextMarkConfig struct {
	// The watermark text. Note: This field may return null, indicating that no valid values can be obtained.
	Text *string `json:"Text,omitnil,omitempty" name:"Text"`

	// The watermark text color. Note: This field may return null, indicating that no valid values can be obtained.
	Color *string `json:"Color,omitnil,omitempty" name:"Color"`
}

type UnbindDocumentFromRoomRequest 

type UnbindDocumentFromRoomRequest struct {
	*tchttp.BaseRequest

	// Room ID
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// Document ID
	DocumentId *string `json:"DocumentId,omitnil,omitempty" name:"DocumentId"`
}

func NewUnbindDocumentFromRoomRequest 

func NewUnbindDocumentFromRoomRequest() (request *UnbindDocumentFromRoomRequest)

func (*UnbindDocumentFromRoomRequest) FromJsonString 

func (r *UnbindDocumentFromRoomRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UnbindDocumentFromRoomRequest) ToJsonString 

func (r *UnbindDocumentFromRoomRequest) ToJsonString() string

type UnbindDocumentFromRoomRequestParams 

type UnbindDocumentFromRoomRequestParams struct {
	// Room ID
	RoomId *uint64 `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// Document ID
	DocumentId *string `json:"DocumentId,omitnil,omitempty" name:"DocumentId"`
}

Predefined struct for user

type UnbindDocumentFromRoomResponse 

type UnbindDocumentFromRoomResponse struct {
	*tchttp.BaseResponse
	Response *UnbindDocumentFromRoomResponseParams `json:"Response"`
}

func NewUnbindDocumentFromRoomResponse 

func NewUnbindDocumentFromRoomResponse() (response *UnbindDocumentFromRoomResponse)

func (*UnbindDocumentFromRoomResponse) FromJsonString 

func (r *UnbindDocumentFromRoomResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UnbindDocumentFromRoomResponse) ToJsonString 

func (r *UnbindDocumentFromRoomResponse) ToJsonString() string

type UnbindDocumentFromRoomResponseParams 

type UnbindDocumentFromRoomResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type UserInfo 

type UserInfo struct {
	//
	// Note: This field may return null, indicating that no valid values can be obtained.
	SdkAppId *uint64 `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	//
	// Note: This field may return null, indicating that no valid values can be obtained.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	//
	// Note: This field may return null, indicating that no valid values can be obtained.
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	//
	// Note: This field may return null, indicating that no valid values can be obtained.
	Avatar *string `json:"Avatar,omitnil,omitempty" name:"Avatar"`

	// User's Id in the client system
	OriginId *string `json:"OriginId,omitnil,omitempty" name:"OriginId"`
}

type WatermarkConfig 

type WatermarkConfig struct {
	// The URL of the watermark image. Note: This field may return null, indicating that no valid values can be obtained.
	Url *string `json:"Url,omitnil,omitempty" name:"Url"`

	// The watermark width, which is expressed as a percentage of the video width. Note: This field may return null, indicating that no valid values can be obtained.
	Width *float64 `json:"Width,omitnil,omitempty" name:"Width"`

	// The watermark height, which is expressed as a percentage of the video height. Note: This field may return null, indicating that no valid values can be obtained.
	Height *float64 `json:"Height,omitnil,omitempty" name:"Height"`

	// The horizontal offset of the watermark, which is expressed as a percentage of the video width. For example, 50 indicates that the watermark will appear in the middle horizontally. Value range: 0-100. Note: This field may return null, indicating that no valid values can be obtained.
	LocationX *float64 `json:"LocationX,omitnil,omitempty" name:"LocationX"`

	// The vertical offset of the watermark, which is expressed as a percentage of the video width. For example, 50 indicates that the watermark will appear in the middle vertically. Value range: 0-100. Note: This field may return null, indicating that no valid values can be obtained.
	LocationY *float64 `json:"LocationY,omitnil,omitempty" name:"LocationY"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.