apis

package
v1.54.0 Latest Latest
Warning

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

 Go to latest Published: Apr 15, 2021 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateRoomRequest 

type CreateRoomRequest struct {
	core.JDCloudRequest

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

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

	/* 用户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: 用户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: 用户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"`
	CreateTime string `json:"createTime"`
	UpdateTime string `json:"updateTime"`
}

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 DeleteRoomRequest added in v1.52.0 

type DeleteRoomRequest struct {
	core.JDCloudRequest

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

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

func NewDeleteRoomRequest added in v1.52.0 

func NewDeleteRoomRequest(
	appId string,
	roomId int,
) *DeleteRoomRequest

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

func NewDeleteRoomRequestWithAllParams added in v1.52.0 

func NewDeleteRoomRequestWithAllParams(
	appId string,
	roomId int,
) *DeleteRoomRequest

* param appId: 应用ID (Required) * param roomId: 房间ID (Required)

func NewDeleteRoomRequestWithoutParam added in v1.52.0 

func NewDeleteRoomRequestWithoutParam() *DeleteRoomRequest

This constructor has better compatible ability when API parameters changed

func (DeleteRoomRequest) GetRegionId added in v1.52.0 

func (r DeleteRoomRequest) GetRegionId() string

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

func (*DeleteRoomRequest) SetAppId added in v1.52.0 

func (r *DeleteRoomRequest) SetAppId(appId string)

param appId: 应用ID(Required)

func (*DeleteRoomRequest) SetRoomId added in v1.52.0 

func (r *DeleteRoomRequest) SetRoomId(roomId int)

param roomId: 房间ID(Required)

type DeleteRoomResponse added in v1.52.0 

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

type DeleteRoomResult added in v1.52.0 

type DeleteRoomResult struct {
}

type DescribeAppKeyRequest added in v1.52.0 

type DescribeAppKeyRequest struct {
	core.JDCloudRequest

	/* 应用ID  */
	AppId string `json:"appId"`
}

func NewDescribeAppKeyRequest added in v1.52.0 

func NewDescribeAppKeyRequest(
	appId string,
) *DescribeAppKeyRequest

* param appId: 应用ID (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeAppKeyRequestWithAllParams added in v1.52.0 

func NewDescribeAppKeyRequestWithAllParams(
	appId string,
) *DescribeAppKeyRequest

* param appId: 应用ID (Required)

func NewDescribeAppKeyRequestWithoutParam added in v1.52.0 

func NewDescribeAppKeyRequestWithoutParam() *DescribeAppKeyRequest

This constructor has better compatible ability when API parameters changed

func (DescribeAppKeyRequest) GetRegionId added in v1.52.0 

func (r DescribeAppKeyRequest) GetRegionId() string

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

func (*DescribeAppKeyRequest) SetAppId added in v1.52.0 

func (r *DescribeAppKeyRequest) SetAppId(appId string)

param appId: 应用ID(Required)

type DescribeAppKeyResponse added in v1.52.0 

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

type DescribeAppKeyResult added in v1.52.0 

type DescribeAppKeyResult struct {
	AppId  string `json:"appId"`
	AppKey string `json:"appKey"`
}

type DescribeAppRequest added in v1.52.0 

type DescribeAppRequest struct {
	core.JDCloudRequest

	/* 应用ID  */
	AppId string `json:"appId"`
}

func NewDescribeAppRequest added in v1.52.0 

func NewDescribeAppRequest(
	appId string,
) *DescribeAppRequest

* param appId: 应用ID (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeAppRequestWithAllParams added in v1.52.0 

func NewDescribeAppRequestWithAllParams(
	appId string,
) *DescribeAppRequest

* param appId: 应用ID (Required)

func NewDescribeAppRequestWithoutParam added in v1.52.0 

func NewDescribeAppRequestWithoutParam() *DescribeAppRequest

This constructor has better compatible ability when API parameters changed

func (DescribeAppRequest) GetRegionId added in v1.52.0 

func (r DescribeAppRequest) GetRegionId() string

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

func (*DescribeAppRequest) SetAppId added in v1.52.0 

func (r *DescribeAppRequest) SetAppId(appId string)

param appId: 应用ID(Required)

type DescribeAppResponse added in v1.52.0 

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

type DescribeAppResult added in v1.52.0 

type DescribeAppResult struct {
	AppId      string `json:"appId"`
	AppName    string `json:"appName"`
	Status     string `json:"status"`
	BillType   string `json:"billType"`
	CreateTime string `json:"createTime"`
}

type DescribeAppsRequest added in v1.52.0 

type DescribeAppsRequest struct {
	core.JDCloudRequest

	/* 页码；默认值为 1 (Optional) */
	PageNumber *int `json:"pageNumber"`

	/* 分页大小；默认值为 10；取值范围 [10, 100] (Optional) */
	PageSize *int `json:"pageSize"`
}

func NewDescribeAppsRequest added in v1.52.0 

func NewDescribeAppsRequest() *DescribeAppsRequest

* * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeAppsRequestWithAllParams added in v1.52.0 

func NewDescribeAppsRequestWithAllParams(
	pageNumber *int,
	pageSize *int,
) *DescribeAppsRequest

* param pageNumber: 页码；默认值为 1 (Optional) * param pageSize: 分页大小；默认值为 10；取值范围 [10, 100] (Optional)

func NewDescribeAppsRequestWithoutParam added in v1.52.0 

func NewDescribeAppsRequestWithoutParam() *DescribeAppsRequest

This constructor has better compatible ability when API parameters changed

func (DescribeAppsRequest) GetRegionId added in v1.52.0 

func (r DescribeAppsRequest) GetRegionId() string

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

func (*DescribeAppsRequest) SetPageNumber added in v1.52.0 

func (r *DescribeAppsRequest) SetPageNumber(pageNumber int)

param pageNumber: 页码；默认值为 1(Optional)

func (*DescribeAppsRequest) SetPageSize added in v1.52.0 

func (r *DescribeAppsRequest) SetPageSize(pageSize int)

param pageSize: 分页大小；默认值为 10；取值范围 [10, 100](Optional)

type DescribeAppsResponse added in v1.52.0 

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

type DescribeAppsResult added in v1.52.0 

type DescribeAppsResult struct {
	PageNumber    int                      `json:"pageNumber"`
	PageSize      int                      `json:"pageSize"`
	TotalElements int                      `json:"totalElements"`
	TotalPages    int                      `json:"totalPages"`
	Content       []openjrtc.AppInfoObject `json:"content"`
}

type DescribeRoomInfoRequest added in v1.52.0 

type DescribeRoomInfoRequest struct {
	core.JDCloudRequest

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

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

func NewDescribeRoomInfoRequest added in v1.52.0 

func NewDescribeRoomInfoRequest(
	appId string,
	roomId int,
) *DescribeRoomInfoRequest

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

func NewDescribeRoomInfoRequestWithAllParams added in v1.52.0 

func NewDescribeRoomInfoRequestWithAllParams(
	appId string,
	roomId int,
) *DescribeRoomInfoRequest

* param appId: 应用ID (Required) * param roomId: 房间ID (Required)

func NewDescribeRoomInfoRequestWithoutParam added in v1.52.0 

func NewDescribeRoomInfoRequestWithoutParam() *DescribeRoomInfoRequest

This constructor has better compatible ability when API parameters changed

func (DescribeRoomInfoRequest) GetRegionId added in v1.52.0 

func (r DescribeRoomInfoRequest) GetRegionId() string

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

func (*DescribeRoomInfoRequest) SetAppId added in v1.52.0 

func (r *DescribeRoomInfoRequest) SetAppId(appId string)

param appId: 应用ID(Required)

func (*DescribeRoomInfoRequest) SetRoomId added in v1.52.0 

func (r *DescribeRoomInfoRequest) SetRoomId(roomId int)

param roomId: 房间ID(Required)

type DescribeRoomInfoResponse added in v1.52.0 

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

type DescribeRoomInfoResult added in v1.52.0 

type DescribeRoomInfoResult struct {
	RoomId     int64  `json:"roomId"`
	RoomName   string `json:"roomName"`
	AppId      string `json:"appId"`
	PeerId     int64  `json:"peerId"`
	CreateTime string `json:"createTime"`
	UpdateTime string `json:"updateTime"`
}

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"`
}

type DescribeRoomsRequest added in v1.52.0 

type DescribeRoomsRequest struct {
	core.JDCloudRequest

	/* 页码；默认值为 1 (Optional) */
	PageNumber *int `json:"pageNumber"`

	/* 分页大小；默认值为 10；取值范围 [10, 100] (Optional) */
	PageSize *int `json:"pageSize"`

	/* 传参字段描述:
	 appId:   应用ID
	(Optional) */
	Filters []openjrtc.Filter `json:"filters"`
}

func NewDescribeRoomsRequest added in v1.52.0 

func NewDescribeRoomsRequest() *DescribeRoomsRequest

* * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeRoomsRequestWithAllParams added in v1.52.0 

func NewDescribeRoomsRequestWithAllParams(
	pageNumber *int,
	pageSize *int,
	filters []openjrtc.Filter,
) *DescribeRoomsRequest
  • param pageNumber: 页码；默认值为 1 (Optional)
  • param pageSize: 分页大小；默认值为 10；取值范围 [10, 100] (Optional)
  • param filters: 传参字段描述: appId: 应用ID

(Optional)

func NewDescribeRoomsRequestWithoutParam added in v1.52.0 

func NewDescribeRoomsRequestWithoutParam() *DescribeRoomsRequest

This constructor has better compatible ability when API parameters changed

func (DescribeRoomsRequest) GetRegionId added in v1.52.0 

func (r DescribeRoomsRequest) GetRegionId() string

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

func (*DescribeRoomsRequest) SetFilters added in v1.52.0 

func (r *DescribeRoomsRequest) SetFilters(filters []openjrtc.Filter)
param filters: 传参字段描述:
 appId:   应用ID

(Optional)

func (*DescribeRoomsRequest) SetPageNumber added in v1.52.0 

func (r *DescribeRoomsRequest) SetPageNumber(pageNumber int)

param pageNumber: 页码；默认值为 1(Optional)

func (*DescribeRoomsRequest) SetPageSize added in v1.52.0 

func (r *DescribeRoomsRequest) SetPageSize(pageSize int)

param pageSize: 分页大小；默认值为 10；取值范围 [10, 100](Optional)

type DescribeRoomsResponse added in v1.52.0 

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

type DescribeRoomsResult added in v1.52.0 

type DescribeRoomsResult struct {
	PageNumber    int                    `json:"pageNumber"`
	PageSize      int                    `json:"pageSize"`
	TotalElements int                    `json:"totalElements"`
	TotalPages    int                    `json:"totalPages"`
	Content       []openjrtc.RoomInfoObj `json:"content"`
}

type UpdateRoomRequest added in v1.52.0 

type UpdateRoomRequest struct {
	core.JDCloudRequest

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

	/* 房间ID (Optional) */
	RoomId *int64 `json:"roomId"`

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

func NewUpdateRoomRequest added in v1.52.0 

func NewUpdateRoomRequest(
	appId string,
) *UpdateRoomRequest

* param appId: 应用ID (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewUpdateRoomRequestWithAllParams added in v1.52.0 

func NewUpdateRoomRequestWithAllParams(
	appId string,
	roomId *int64,
	roomName *string,
) *UpdateRoomRequest

* param appId: 应用ID (Required) * param roomId: 房间ID (Optional) * param roomName: 房间名称 (Optional)

func NewUpdateRoomRequestWithoutParam added in v1.52.0 

func NewUpdateRoomRequestWithoutParam() *UpdateRoomRequest

This constructor has better compatible ability when API parameters changed

func (UpdateRoomRequest) GetRegionId added in v1.52.0 

func (r UpdateRoomRequest) GetRegionId() string

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

func (*UpdateRoomRequest) SetAppId added in v1.52.0 

func (r *UpdateRoomRequest) SetAppId(appId string)

param appId: 应用ID(Required)

func (*UpdateRoomRequest) SetRoomId added in v1.52.0 

func (r *UpdateRoomRequest) SetRoomId(roomId int64)

param roomId: 房间ID(Optional)

func (*UpdateRoomRequest) SetRoomName added in v1.52.0 

func (r *UpdateRoomRequest) SetRoomName(roomName string)

param roomName: 房间名称(Optional)

type UpdateRoomResponse added in v1.52.0 

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

type UpdateRoomResult added in v1.52.0 

type UpdateRoomResult struct {
	RoomId     int64  `json:"roomId"`
	RoomName   string `json:"roomName"`
	AppId      string `json:"appId"`
	PeerId     int64  `json:"peerId"`
	CreateTime string `json:"createTime"`
	UpdateTime string `json:"updateTime"`
}

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.