v20190722

Documentation

Index

• Constants
• type Client
  • func NewClient(credential *common.Credential, region string, ...) (client *Client, err error)
  • func NewClientWithSecretId(secretId, secretKey, region string) (client *Client, err error)
  • func (c *Client) DismissRoom(request *DismissRoomRequest) (response *DismissRoomResponse, err error)
  • func (c *Client) RemoveUser(request *RemoveUserRequest) (response *RemoveUserResponse, err error)
• type DismissRoomRequest
  • func NewDismissRoomRequest() (request *DismissRoomRequest)
  • func (r *DismissRoomRequest) FromJsonString(s string) error
  • func (r *DismissRoomRequest) ToJsonString() string
• type DismissRoomResponse
  • func NewDismissRoomResponse() (response *DismissRoomResponse)
  • func (r *DismissRoomResponse) FromJsonString(s string) error
  • func (r *DismissRoomResponse) ToJsonString() string
• type RemoveUserRequest
  • func NewRemoveUserRequest() (request *RemoveUserRequest)
  • func (r *RemoveUserRequest) FromJsonString(s string) error
  • func (r *RemoveUserRequest) ToJsonString() string
• type RemoveUserResponse
  • func NewRemoveUserResponse() (response *RemoveUserResponse)
  • func (r *RemoveUserResponse) FromJsonString(s string) error
  • func (r *RemoveUserResponse) ToJsonString() string

Constants

const APIVersion = "2019-07-22"

Types

type Client

type Client struct {
	common.Client
}

func NewClient

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

func NewClientWithSecretId

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

Deprecated

func (*Client) DismissRoom

func (c *Client) DismissRoom(request *DismissRoomRequest) (response *DismissRoomResponse, err error)

接口说明：把房间所有用户从房间移出，解散房间。支持所有平台，Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。

func (*Client) RemoveUser

func (c *Client) RemoveUser(request *RemoveUserRequest) (response *RemoveUserResponse, err error)

接口说明：将用户从房间移出，适用于主播/房主/管理员踢人等场景。支持所有平台，Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。

type DismissRoomRequest

type DismissRoomRequest struct {
	*tchttp.BaseRequest

	// TRTC的SDKAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitempty" name:"SdkAppId"`

	// 房间号。
	RoomId *uint64 `json:"RoomId,omitempty" name:"RoomId"`
}

func NewDismissRoomRequest

func NewDismissRoomRequest() (request *DismissRoomRequest)

func (*DismissRoomRequest) FromJsonString

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

func (*DismissRoomRequest) ToJsonString

func (r *DismissRoomRequest) ToJsonString() string

type DismissRoomResponse

type DismissRoomResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDismissRoomResponse

func NewDismissRoomResponse() (response *DismissRoomResponse)

func (*DismissRoomResponse) FromJsonString

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

func (*DismissRoomResponse) ToJsonString

func (r *DismissRoomResponse) ToJsonString() string

type RemoveUserRequest

type RemoveUserRequest struct {
	*tchttp.BaseRequest

	// TRTC的SDKAppId。
	SdkAppId *uint64 `json:"SdkAppId,omitempty" name:"SdkAppId"`

	// 房间号。
	RoomId *uint64 `json:"RoomId,omitempty" name:"RoomId"`

	// 要移出的用户列表，最多10个。
	UserIds []*string `json:"UserIds,omitempty" name:"UserIds" list`
}

func NewRemoveUserRequest

func NewRemoveUserRequest() (request *RemoveUserRequest)

func (*RemoveUserRequest) FromJsonString

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

func (*RemoveUserRequest) ToJsonString

func (r *RemoveUserRequest) ToJsonString() string

type RemoveUserResponse

type RemoveUserResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewRemoveUserResponse

func NewRemoveUserResponse() (response *RemoveUserResponse)

func (*RemoveUserResponse) FromJsonString

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

func (*RemoveUserResponse) ToJsonString

func (r *RemoveUserResponse) ToJsonString() string