apis

Documentation

Index

• type CreateRoomRequest
  • func NewCreateRoomRequest() *CreateRoomRequest
  • func NewCreateRoomRequestWithAllParams(roomName *string, appId *string, peerId *int64) *CreateRoomRequest
  • func NewCreateRoomRequestWithoutParam() *CreateRoomRequest
  • func (r CreateRoomRequest) GetRegionId() string
  • func (r *CreateRoomRequest) SetAppId(appId string)
  • func (r *CreateRoomRequest) SetPeerId(peerId int64)
  • func (r *CreateRoomRequest) SetRoomName(roomName string)
• type CreateRoomResponse
• type CreateRoomResult
• type CreateUserRequest
  • func NewCreateUserRequest() *CreateUserRequest
  • func NewCreateUserRequestWithAllParams(appId *string, userName *string, userId *string, temporary *bool) *CreateUserRequest
  • func NewCreateUserRequestWithoutParam() *CreateUserRequest
  • func (r CreateUserRequest) GetRegionId() string
  • func (r *CreateUserRequest) SetAppId(appId string)
  • func (r *CreateUserRequest) SetTemporary(temporary bool)
  • func (r *CreateUserRequest) SetUserId(userId string)
  • func (r *CreateUserRequest) SetUserName(userName string)
• type CreateUserResponse
• type CreateUserResult
• type DescribeRoomOnlineUserNumRequest
  • func NewDescribeRoomOnlineUserNumRequest(roomId int) *DescribeRoomOnlineUserNumRequest
  • func NewDescribeRoomOnlineUserNumRequestWithAllParams(roomId int) *DescribeRoomOnlineUserNumRequest
  • func NewDescribeRoomOnlineUserNumRequestWithoutParam() *DescribeRoomOnlineUserNumRequest
  • func (r DescribeRoomOnlineUserNumRequest) GetRegionId() string
  • func (r *DescribeRoomOnlineUserNumRequest) SetRoomId(roomId int)
• type DescribeRoomOnlineUserNumResponse
• type DescribeRoomOnlineUserNumResult

Types

type CreateRoomRequest

type CreateRoomRequest struct {
	core.JDCloudRequest

	/* 房间名称 (Optional) */
	RoomName *string `json:"roomName"`

	/* 应用ID (Optional) */
	AppId *string `json:"appId"`

	/* JRtc用户ID(创建者ID) (Optional) */
	PeerId *int64 `json:"peerId"`
}

func NewCreateRoomRequest

func NewCreateRoomRequest() *CreateRoomRequest

* * @Deprecated, not compatible when mandatory parameters changed

func NewCreateRoomRequestWithAllParams

func NewCreateRoomRequestWithAllParams(
	roomName *string,
	appId *string,
	peerId *int64,
) *CreateRoomRequest

* param roomName: 房间名称 (Optional) * param appId: 应用ID (Optional) * param peerId: JRtc用户ID(创建者ID) (Optional)

func NewCreateRoomRequestWithoutParam

func NewCreateRoomRequestWithoutParam() *CreateRoomRequest

This constructor has better compatible ability when API parameters changed

func (CreateRoomRequest) GetRegionId

func (r CreateRoomRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*CreateRoomRequest) SetAppId

func (r *CreateRoomRequest) SetAppId(appId string)

param appId: 应用ID(Optional)

func (*CreateRoomRequest) SetPeerId

func (r *CreateRoomRequest) SetPeerId(peerId int64)

param peerId: JRtc用户ID(创建者ID)(Optional)

func (*CreateRoomRequest) SetRoomName

func (r *CreateRoomRequest) SetRoomName(roomName string)

param roomName: 房间名称(Optional)

type CreateRoomResponse

type CreateRoomResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    CreateRoomResult   `json:"result"`
}

type CreateRoomResult

type CreateRoomResult struct {
	RoomId   int64  `json:"roomId"`
	RoomName string `json:"roomName"`
	AppId    string `json:"appId"`
	PeerId   int64  `json:"peerId"`
}

type CreateUserRequest

type CreateUserRequest struct {
	core.JDCloudRequest

	/* 应用ID (Optional) */
	AppId *string `json:"appId"`

	/* 用户名称 (Optional) */
	UserName *string `json:"userName"`

	/* 业务接入方的用户ID (Optional) */
	UserId *string `json:"userId"`

	/* 是否临时用户 (Optional) */
	Temporary *bool `json:"temporary"`
}

func NewCreateUserRequest

func NewCreateUserRequest() *CreateUserRequest

* * @Deprecated, not compatible when mandatory parameters changed

func NewCreateUserRequestWithAllParams

func NewCreateUserRequestWithAllParams(
	appId *string,
	userName *string,
	userId *string,
	temporary *bool,
) *CreateUserRequest

* param appId: 应用ID (Optional) * param userName: 用户名称 (Optional) * param userId: 业务接入方的用户ID (Optional) * param temporary: 是否临时用户 (Optional)

func NewCreateUserRequestWithoutParam

func NewCreateUserRequestWithoutParam() *CreateUserRequest

This constructor has better compatible ability when API parameters changed

func (CreateUserRequest) GetRegionId

func (r CreateUserRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*CreateUserRequest) SetAppId

func (r *CreateUserRequest) SetAppId(appId string)

param appId: 应用ID(Optional)

func (*CreateUserRequest) SetTemporary

func (r *CreateUserRequest) SetTemporary(temporary bool)

param temporary: 是否临时用户(Optional)

func (*CreateUserRequest) SetUserId

func (r *CreateUserRequest) SetUserId(userId string)

param userId: 业务接入方的用户ID(Optional)

func (*CreateUserRequest) SetUserName

func (r *CreateUserRequest) SetUserName(userName string)

param userName: 用户名称(Optional)

type CreateUserResponse

type CreateUserResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    CreateUserResult   `json:"result"`
}

type CreateUserResult

type CreateUserResult struct {
	PeerId int64  `json:"peerId"`
	AppId  string `json:"appId"`
	UserId string `json:"userId"`
}

type DescribeRoomOnlineUserNumRequest

type DescribeRoomOnlineUserNumRequest struct {
	core.JDCloudRequest

	/* 房间ID  */
	RoomId int `json:"roomId"`
}

func NewDescribeRoomOnlineUserNumRequest

func NewDescribeRoomOnlineUserNumRequest(
	roomId int,
) *DescribeRoomOnlineUserNumRequest

* param roomId: 房间ID (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeRoomOnlineUserNumRequestWithAllParams

func NewDescribeRoomOnlineUserNumRequestWithAllParams(
	roomId int,
) *DescribeRoomOnlineUserNumRequest

* param roomId: 房间ID (Required)

func NewDescribeRoomOnlineUserNumRequestWithoutParam

func NewDescribeRoomOnlineUserNumRequestWithoutParam() *DescribeRoomOnlineUserNumRequest

This constructor has better compatible ability when API parameters changed

func (DescribeRoomOnlineUserNumRequest) GetRegionId

func (r DescribeRoomOnlineUserNumRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeRoomOnlineUserNumRequest) SetRoomId

func (r *DescribeRoomOnlineUserNumRequest) SetRoomId(roomId int)

param roomId: 房间ID(Required)

type DescribeRoomOnlineUserNumResponse

type DescribeRoomOnlineUserNumResponse struct {
	RequestID string                          `json:"requestId"`
	Error     core.ErrorResponse              `json:"error"`
	Result    DescribeRoomOnlineUserNumResult `json:"result"`
}

type DescribeRoomOnlineUserNumResult

type DescribeRoomOnlineUserNumResult struct {
	AppId      string `json:"appId"`
	RoomId     int64  `json:"roomId"`
	Number     int    `json:"number"`
	CreateTime string `json:"createTime"`
}