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) DissolveRoom(request *DissolveRoomRequest) (response *DissolveRoomResponse, err error)
  • func (c *Client) KickOutUser(request *KickOutUserRequest) (response *KickOutUserResponse, err error)
• type DissolveRoomRequest
  • func NewDissolveRoomRequest() (request *DissolveRoomRequest)
  • func (r *DissolveRoomRequest) FromJsonString(s string) error
  • func (r *DissolveRoomRequest) ToJsonString() string
• type DissolveRoomResponse
  • func NewDissolveRoomResponse() (response *DissolveRoomResponse)
  • func (r *DissolveRoomResponse) FromJsonString(s string) error
  • func (r *DissolveRoomResponse) ToJsonString() string
• type KickOutUserRequest
  • func NewKickOutUserRequest() (request *KickOutUserRequest)
  • func (r *KickOutUserRequest) FromJsonString(s string) error
  • func (r *KickOutUserRequest) ToJsonString() string
• type KickOutUserResponse
  • func NewKickOutUserResponse() (response *KickOutUserResponse)
  • func (r *KickOutUserResponse) FromJsonString(s string) error
  • func (r *KickOutUserResponse) 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) DissolveRoom

func (c *Client) DissolveRoom(request *DissolveRoomRequest) (response *DissolveRoomResponse, err error)

接口说明：把房间所有用户从房间踢出，解散房间。支持 TRTC SDK 6.6及以上版本，包括Android、iOS、Windows 和 macOS。

func (*Client) KickOutUser

func (c *Client) KickOutUser(request *KickOutUserRequest) (response *KickOutUserResponse, err error)

接口说明：将用户从房间踢出。支持 TRTC SDK 6.6及以上版本，包括Android、iOS、Windows 和 macOS。

type DissolveRoomRequest

type DissolveRoomRequest struct {
	*tchttp.BaseRequest

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

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

func NewDissolveRoomRequest

func NewDissolveRoomRequest() (request *DissolveRoomRequest)

func (*DissolveRoomRequest) FromJsonString

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

func (*DissolveRoomRequest) ToJsonString

func (r *DissolveRoomRequest) ToJsonString() string

type DissolveRoomResponse

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

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

func NewDissolveRoomResponse

func NewDissolveRoomResponse() (response *DissolveRoomResponse)

func (*DissolveRoomResponse) FromJsonString

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

func (*DissolveRoomResponse) ToJsonString

func (r *DissolveRoomResponse) ToJsonString() string

type KickOutUserRequest

type KickOutUserRequest 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 NewKickOutUserRequest

func NewKickOutUserRequest() (request *KickOutUserRequest)

func (*KickOutUserRequest) FromJsonString

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

func (*KickOutUserRequest) ToJsonString

func (r *KickOutUserRequest) ToJsonString() string

type KickOutUserResponse

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

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

func NewKickOutUserResponse

func NewKickOutUserResponse() (response *KickOutUserResponse)

func (*KickOutUserResponse) FromJsonString

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

func (*KickOutUserResponse) ToJsonString

func (r *KickOutUserResponse) ToJsonString() string