v20220817

package
v3.0.616+incompatible Latest Latest
Warning

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

 Go to latest Published: Jan 12, 2023 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// 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"

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

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

	// Internal error.
	INTERNALERROR = "InternalError"

	// Invalid parameter.
	INVALIDPARAMETER = "InvalidParameter"

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

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

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

	// 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 file does not exist.
	RESOURCENOTFOUND_DOCUMENT = "ResourceNotFound.Document"

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

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

	// Getting room data. Please wait.
	RESOURCEUNAVAILABLE_ROOMSTATISTICS = "ResourceUnavailable.RoomStatistics"
)
View Source 
const APIVersion = "2022-08-17"

Variables

This section is empty.

Functions

This section is empty.

Types

type AppCustomContent 

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

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

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

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

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

type BindDocumentToRoomRequest 

type BindDocumentToRoomRequest struct {
	*tchttp.BaseRequest

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

	// Document ID
	DocumentId *string `json:"DocumentId,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,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,omitempty" name:"RoomId"`

	// Document ID
	DocumentId *string `json:"DocumentId,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,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, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,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) 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: 

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: 

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: 

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: 

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

func (*Client) CreateRoom 

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

CreateRoom This API is used to create a room.

error code that may be returned: 

FAILEDOPERATION_CLASSTOOLONG = "FailedOperation.ClassTooLong"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_ENDTIME = "InvalidParameter.EndTime"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTIME = "InvalidParameter.StartTime"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEINSUFFICIENT_RECORD = "ResourceInsufficient.Record"
RESOURCEINSUFFICIENT_ROOM = "ResourceInsufficient.Room"
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.

error code that may be returned: 

FAILEDOPERATION_CLASSTOOLONG = "FailedOperation.ClassTooLong"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_ENDTIME = "InvalidParameter.EndTime"
INVALIDPARAMETER_SDKAPPID = "InvalidParameter.SdkAppId"
INVALIDPARAMETER_STARTTIME = "InvalidParameter.StartTime"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEINSUFFICIENT_RECORD = "ResourceInsufficient.Record"
RESOURCEINSUFFICIENT_ROOM = "ResourceInsufficient.Room"
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) 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) DescribeRoom 

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

DescribeRoom This API is used to get room information.

error code that may be returned: 

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.

error code that may be returned: 

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.

error code that may be returned: 

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.

error code that may be returned: 

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

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

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.

error code that may be returned: 

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

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_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_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: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
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: 

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

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,omitempty" name:"SdkAppId"`

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

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

	// Document owner ID
	Owner *string `json:"Owner,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,omitempty" name:"TranscodeType"`

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

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

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

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,omitempty" name:"SdkAppId"`

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

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

	// Document owner ID
	Owner *string `json:"Owner,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,omitempty" name:"TranscodeType"`

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

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

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

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,omitempty" name:"DocumentId"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type CreateRoomRequest 

type CreateRoomRequest struct {
	*tchttp.BaseRequest

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

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

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

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

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

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

	// Room subtype. Valid values: `videodoc`: Document + Video; `video`: Video only; `coteaching`: Dual-teacher
	SubType *string `json:"SubType,omitempty" name:"SubType"`

	// Teacher ID, which is the `UserId` obtained by the `RegisterUser` API.
	TeacherId *string `json:"TeacherId,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,omitempty" name:"AutoMic"`

	// Whether to enable the high audio quality mode. Valid values: `0`: No (default value); `1`: Yes.
	AudioQuality *uint64 `json:"AudioQuality,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,omitempty" name:"DisableRecord"`

	// Teacher assistant IDs, which are the `UserId` obtained by the `RegisterUser` API.
	Assistants []*string `json:"Assistants,omitempty" name:"Assistants"`

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

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,omitempty" name:"Name"`

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

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

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

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

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

	// Room subtype. Valid values: `videodoc`: Document + Video; `video`: Video only; `coteaching`: Dual-teacher
	SubType *string `json:"SubType,omitempty" name:"SubType"`

	// Teacher ID, which is the `UserId` obtained by the `RegisterUser` API.
	TeacherId *string `json:"TeacherId,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,omitempty" name:"AutoMic"`

	// Whether to enable the high audio quality mode. Valid values: `0`: No (default value); `1`: Yes.
	AudioQuality *uint64 `json:"AudioQuality,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,omitempty" name:"DisableRecord"`

	// Teacher assistant IDs, which are the `UserId` obtained by the `RegisterUser` API.
	Assistants []*string `json:"Assistants,omitempty" name:"Assistants"`

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

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,omitempty" name:"RoomId"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type CreateSupervisorRequest 

type CreateSupervisorRequest struct {
	*tchttp.BaseRequest
}

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 {
}

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, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeleteRoomRequest 

type DeleteRoomRequest struct {
	*tchttp.BaseRequest

	// Room ID
	RoomId *uint64 `json:"RoomId,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,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, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeRoomRequest 

type DescribeRoomRequest struct {
	*tchttp.BaseRequest

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

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,omitempty" name:"RoomId"`
}

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,omitempty" name:"Name"`

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

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

	// Teacher ID
	TeacherId *string `json:"TeacherId,omitempty" name:"TeacherId"`

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

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

	// Maximum number of mic-on users (excluding teachers). Value range: [0, 16]
	MaxMicNumber *uint64 `json:"MaxMicNumber,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,omitempty" name:"AutoMic"`

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

	// Room subtype. Valid values: `videodoc`: Document + Video; `video`: Video only; `coteaching`: Dual-teacher
	SubType *string `json:"SubType,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,omitempty" name:"DisableRecord"`

	// Assistant ID list
	// Note: This field may return null, indicating that no valid values can be obtained.
	Assistants []*string `json:"Assistants,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,omitempty" name:"RecordUrl"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeRoomStatisticsRequest 

type DescribeRoomStatisticsRequest struct {
	*tchttp.BaseRequest

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

	// Current page in pagination, which starts from 1.
	Page *uint64 `json:"Page,omitempty" name:"Page"`

	// Number of data entries to return per page. Maximum value: 1000
	Limit *uint64 `json:"Limit,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,omitempty" name:"RoomId"`

	// Current page in pagination, which starts from 1.
	Page *uint64 `json:"Page,omitempty" name:"Page"`

	// Number of data entries to return per page. Maximum value: 1000
	Limit *uint64 `json:"Limit,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,omitempty" name:"PeakMemberNumber"`

	// Accumulated number of online members
	MemberNumber *uint64 `json:"MemberNumber,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,omitempty" name:"Total"`

	// Member record list
	MemberRecords []*MemberRecord `json:"MemberRecords,omitempty" name:"MemberRecords"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeUserRequest 

type DescribeUserRequest struct {
	*tchttp.BaseRequest

	// User ID
	UserId *string `json:"UserId,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,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,omitempty" name:"SdkAppId"`

	// User ID
	UserId *string `json:"UserId,omitempty" name:"UserId"`

	// Username
	Name *string `json:"Name,omitempty" name:"Name"`

	// URL of user profile photo.
	Avatar *string `json:"Avatar,omitempty" name:"Avatar"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type LoginOriginIdRequest 

type LoginOriginIdRequest struct {
	*tchttp.BaseRequest

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

	// User's ID in the customer system, which should be unique under the same application
	OriginId *string `json:"OriginId,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,omitempty" name:"SdkAppId"`

	// User's ID in the customer system, which should be unique under the same application
	OriginId *string `json:"OriginId,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,omitempty" name:"UserId"`

	// Login status token returned after successful login or registration. The token is valid for seven days.
	Token *string `json:"Token,omitempty" name:"Token"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type LoginUserRequest 

type LoginUserRequest struct {
	*tchttp.BaseRequest

	// User ID obtained during registration
	UserId *string `json:"UserId,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,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,omitempty" name:"UserId"`

	// Login status token returned after successful login or registration. The token is valid for seven days.
	Token *string `json:"Token,omitempty" name:"Token"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type MemberRecord 

type MemberRecord struct {
	// User ID
	UserId *string `json:"UserId,omitempty" name:"UserId"`

	// Username
	UserName *string `json:"UserName,omitempty" name:"UserName"`

	// Online duration, in seconds
	PresentTime *uint64 `json:"PresentTime,omitempty" name:"PresentTime"`

	// Whether the camera is enabled
	Camera *uint64 `json:"Camera,omitempty" name:"Camera"`

	// Whether the mic is enabled
	Mic *uint64 `json:"Mic,omitempty" name:"Mic"`

	// Whether the user is muted
	Silence *uint64 `json:"Silence,omitempty" name:"Silence"`

	// Number of questions answered by the user
	AnswerQuestions *uint64 `json:"AnswerQuestions,omitempty" name:"AnswerQuestions"`

	// Number of hand raising times
	HandUps *uint64 `json:"HandUps,omitempty" name:"HandUps"`

	// First time that the user entered the room, in UNIX timestamp format
	FirstJoinTimestamp *uint64 `json:"FirstJoinTimestamp,omitempty" name:"FirstJoinTimestamp"`

	// Last time that the user left the room, in UNIX timestamp format
	LastQuitTimestamp *uint64 `json:"LastQuitTimestamp,omitempty" name:"LastQuitTimestamp"`

	// Number of rewards received
	Rewords *uint64 `json:"Rewords,omitempty" name:"Rewords"`
}

type ModifyAppRequest 

type ModifyAppRequest struct {
	*tchttp.BaseRequest

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

	// Callback URL. Currently, only port 80 and port 443 are supported.
	Callback *string `json:"Callback,omitempty" name:"Callback"`
}

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,omitempty" name:"SdkAppId"`

	// Callback URL. Currently, only port 80 and port 443 are supported.
	Callback *string `json:"Callback,omitempty" name:"Callback"`
}

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, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type RegisterUserRequest 

type RegisterUserRequest struct {
	*tchttp.BaseRequest

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

	// Username
	Name *string `json:"Name,omitempty" name:"Name"`

	// User's ID in the customer system, which should be unique under the same application
	OriginId *string `json:"OriginId,omitempty" name:"OriginId"`

	// User's profile photo
	Avatar *string `json:"Avatar,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,omitempty" name:"SdkAppId"`

	// Username
	Name *string `json:"Name,omitempty" name:"Name"`

	// User's ID in the customer system, which should be unique under the same application
	OriginId *string `json:"OriginId,omitempty" name:"OriginId"`

	// User's profile photo
	Avatar *string `json:"Avatar,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,omitempty" name:"UserId"`

	// Login status token returned after successful login or registration. The token is valid for seven days.
	Token *string `json:"Token,omitempty" name:"Token"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type SetAppCustomContentRequest 

type SetAppCustomContentRequest struct {
	*tchttp.BaseRequest

	// Custom content
	CustomContent []*AppCustomContent `json:"CustomContent,omitempty" name:"CustomContent"`

	// Application ID
	SdkAppId *uint64 `json:"SdkAppId,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,omitempty" name:"CustomContent"`

	// Application ID
	SdkAppId *uint64 `json:"SdkAppId,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, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type UnbindDocumentFromRoomRequest 

type UnbindDocumentFromRoomRequest struct {
	*tchttp.BaseRequest

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

	// Document ID
	DocumentId *string `json:"DocumentId,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,omitempty" name:"RoomId"`

	// Document ID
	DocumentId *string `json:"DocumentId,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, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

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.