Documentation
¶
Index ¶
- type OpenjrtcClient
- func (c *OpenjrtcClient) CreateRoom(request *openjrtc.CreateRoomRequest) (*openjrtc.CreateRoomResponse, error)
- func (c *OpenjrtcClient) CreateToken(request *openjrtc.CreateTokenRequest) (*openjrtc.CreateTokenResponse, error)
- func (c *OpenjrtcClient) CreateUser(request *openjrtc.CreateUserRequest) (*openjrtc.CreateUserResponse, error)
- func (c *OpenjrtcClient) DeleteRoom(request *openjrtc.DeleteRoomRequest) (*openjrtc.DeleteRoomResponse, error)
- func (c *OpenjrtcClient) DescribeApp(request *openjrtc.DescribeAppRequest) (*openjrtc.DescribeAppResponse, error)
- func (c *OpenjrtcClient) DescribeAppKey(request *openjrtc.DescribeAppKeyRequest) (*openjrtc.DescribeAppKeyResponse, error)
- func (c *OpenjrtcClient) DescribeApps(request *openjrtc.DescribeAppsRequest) (*openjrtc.DescribeAppsResponse, error)
- func (c *OpenjrtcClient) DescribeRegisterUser(request *openjrtc.DescribeRegisterUserRequest) (*openjrtc.DescribeRegisterUserResponse, error)
- func (c *OpenjrtcClient) DescribeRegisterUsers(request *openjrtc.DescribeRegisterUsersRequest) (*openjrtc.DescribeRegisterUsersResponse, error)
- func (c *OpenjrtcClient) DescribeRoomInfo(request *openjrtc.DescribeRoomInfoRequest) (*openjrtc.DescribeRoomInfoResponse, error)
- func (c *OpenjrtcClient) DescribeRoomOnlineUserNum(request *openjrtc.DescribeRoomOnlineUserNumRequest) (*openjrtc.DescribeRoomOnlineUserNumResponse, error)
- func (c *OpenjrtcClient) DescribeRoomUsers(request *openjrtc.DescribeRoomUsersRequest) (*openjrtc.DescribeRoomUsersResponse, error)
- func (c *OpenjrtcClient) DescribeRoomUsersNum(request *openjrtc.DescribeRoomUsersNumRequest) (*openjrtc.DescribeRoomUsersNumResponse, error)
- func (c *OpenjrtcClient) DescribeRooms(request *openjrtc.DescribeRoomsRequest) (*openjrtc.DescribeRoomsResponse, error)
- func (c *OpenjrtcClient) DescribeUserByPeer(request *openjrtc.DescribeUserByPeerRequest) (*openjrtc.DescribeUserByPeerResponse, error)
- func (c *OpenjrtcClient) DescribeUserRoom(request *openjrtc.DescribeUserRoomRequest) (*openjrtc.DescribeUserRoomResponse, error)
- func (c *OpenjrtcClient) DescribeUserRooms(request *openjrtc.DescribeUserRoomsRequest) (*openjrtc.DescribeUserRoomsResponse, error)
- func (c *OpenjrtcClient) DisableLogger()
- func (c *OpenjrtcClient) PostMessageToUser(request *openjrtc.PostMessageToUserRequest) (*openjrtc.PostMessageToUserResponse, error)
- func (c *OpenjrtcClient) PostMessageToUserRoom(request *openjrtc.PostMessageToUserRoomRequest) (*openjrtc.PostMessageToUserRoomResponse, error)
- func (c *OpenjrtcClient) RegisterUser(request *openjrtc.RegisterUserRequest) (*openjrtc.RegisterUserResponse, error)
- func (c *OpenjrtcClient) RegisterUserRoom(request *openjrtc.RegisterUserRoomRequest) (*openjrtc.RegisterUserRoomResponse, error)
- func (c *OpenjrtcClient) RemoveAllRoomUsers(request *openjrtc.RemoveAllRoomUsersRequest) (*openjrtc.RemoveAllRoomUsersResponse, error)
- func (c *OpenjrtcClient) RemoveAllUsersByUserRoomId(request *openjrtc.RemoveAllUsersByUserRoomIdRequest) (*openjrtc.RemoveAllUsersByUserRoomIdResponse, error)
- func (c *OpenjrtcClient) RemoveRoomUser(request *openjrtc.RemoveRoomUserRequest) (*openjrtc.RemoveRoomUserResponse, error)
- func (c *OpenjrtcClient) RemoveUserByUserRoomId(request *openjrtc.RemoveUserByUserRoomIdRequest) (*openjrtc.RemoveUserByUserRoomIdResponse, error)
- func (c *OpenjrtcClient) SendMessageToRoom(request *openjrtc.SendMessageToRoomRequest) (*openjrtc.SendMessageToRoomResponse, error)
- func (c *OpenjrtcClient) SendMessageToUser(request *openjrtc.SendMessageToUserRequest) (*openjrtc.SendMessageToUserResponse, error)
- func (c *OpenjrtcClient) SetConfig(config *core.Config)
- func (c *OpenjrtcClient) SetLogger(logger core.Logger)
- func (c *OpenjrtcClient) UpdateRoom(request *openjrtc.UpdateRoomRequest) (*openjrtc.UpdateRoomResponse, error)
- func (c *OpenjrtcClient) UpdateUserRoom(request *openjrtc.UpdateUserRoomRequest) (*openjrtc.UpdateUserRoomResponse, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type OpenjrtcClient ¶
type OpenjrtcClient struct {
core.JDCloudClient
}
func NewOpenjrtcClient ¶
func NewOpenjrtcClient(credential *core.Credential) *OpenjrtcClient
func (*OpenjrtcClient) CreateRoom ¶
func (c *OpenjrtcClient) CreateRoom(request *openjrtc.CreateRoomRequest) (*openjrtc.CreateRoomResponse, error)
创建房间
func (*OpenjrtcClient) CreateToken ¶ added in v1.60.0
func (c *OpenjrtcClient) CreateToken(request *openjrtc.CreateTokenRequest) (*openjrtc.CreateTokenResponse, error)
生成token-用户加入房间时携带token校验通过后方能加入
func (*OpenjrtcClient) CreateUser ¶
func (c *OpenjrtcClient) CreateUser(request *openjrtc.CreateUserRequest) (*openjrtc.CreateUserResponse, error)
创建用户
func (*OpenjrtcClient) DeleteRoom ¶ added in v1.52.0
func (c *OpenjrtcClient) DeleteRoom(request *openjrtc.DeleteRoomRequest) (*openjrtc.DeleteRoomResponse, error)
删除房间
func (*OpenjrtcClient) DescribeApp ¶ added in v1.52.0
func (c *OpenjrtcClient) DescribeApp(request *openjrtc.DescribeAppRequest) (*openjrtc.DescribeAppResponse, error)
查询应用信息:
func (*OpenjrtcClient) DescribeAppKey ¶ added in v1.52.0
func (c *OpenjrtcClient) DescribeAppKey(request *openjrtc.DescribeAppKeyRequest) (*openjrtc.DescribeAppKeyResponse, error)
查询应用appKey
func (*OpenjrtcClient) DescribeApps ¶ added in v1.52.0
func (c *OpenjrtcClient) DescribeApps(request *openjrtc.DescribeAppsRequest) (*openjrtc.DescribeAppsResponse, error)
查询用户应用列表信息
func (*OpenjrtcClient) DescribeRegisterUser ¶ added in v1.60.0
func (c *OpenjrtcClient) DescribeRegisterUser(request *openjrtc.DescribeRegisterUserRequest) (*openjrtc.DescribeRegisterUserResponse, error)
查询注册用户
func (*OpenjrtcClient) DescribeRegisterUsers ¶ added in v1.60.0
func (c *OpenjrtcClient) DescribeRegisterUsers(request *openjrtc.DescribeRegisterUsersRequest) (*openjrtc.DescribeRegisterUsersResponse, error)
查询注册用户列表
允许通过条件过滤查询,支持的过滤字段如下:
- startTime[eq] 用户注册时间段开始时间-UTC时间 startTime,endTime同时有值时生效
- endTime[eq] 用户注册时间段结束时间-UTC时间 startTime,endTime同时有值时生效
func (*OpenjrtcClient) DescribeRoomInfo ¶ added in v1.52.0
func (c *OpenjrtcClient) DescribeRoomInfo(request *openjrtc.DescribeRoomInfoRequest) (*openjrtc.DescribeRoomInfoResponse, error)
获取房间信息
func (*OpenjrtcClient) DescribeRoomOnlineUserNum ¶
func (c *OpenjrtcClient) DescribeRoomOnlineUserNum(request *openjrtc.DescribeRoomOnlineUserNumRequest) (*openjrtc.DescribeRoomOnlineUserNumResponse, error)
查询房间实时在线人数
func (*OpenjrtcClient) DescribeRoomUsers ¶ added in v1.60.0
func (c *OpenjrtcClient) DescribeRoomUsers(request *openjrtc.DescribeRoomUsersRequest) (*openjrtc.DescribeRoomUsersResponse, error)
查询房间内人员列表
允许通过条件过滤查询,支持的过滤字段如下:
- status[eq] 在线状态 1-在线 2-离线
- startTime[eq] 用户加入时间段开始时间-UTC时间 startTime,endTime同时有值时生效
- endTime[eq] 用户加入时间段结束时间-UTC时间 startTime,endTime同时有值时生效
func (*OpenjrtcClient) DescribeRoomUsersNum ¶ added in v1.60.0
func (c *OpenjrtcClient) DescribeRoomUsersNum(request *openjrtc.DescribeRoomUsersNumRequest) (*openjrtc.DescribeRoomUsersNumResponse, error)
统计房间内人数
func (*OpenjrtcClient) DescribeRooms ¶ added in v1.52.0
func (c *OpenjrtcClient) DescribeRooms(request *openjrtc.DescribeRoomsRequest) (*openjrtc.DescribeRoomsResponse, error)
查询应用下的房间列表
允许通过条件过滤查询,支持的过滤字段如下:
- appId[eq] 按应用ID查询
func (*OpenjrtcClient) DescribeUserByPeer ¶ added in v1.60.0
func (c *OpenjrtcClient) DescribeUserByPeer(request *openjrtc.DescribeUserByPeerRequest) (*openjrtc.DescribeUserByPeerResponse, error)
查询peer对应的用户信息
func (*OpenjrtcClient) DescribeUserRoom ¶ added in v1.60.0
func (c *OpenjrtcClient) DescribeUserRoom(request *openjrtc.DescribeUserRoomRequest) (*openjrtc.DescribeUserRoomResponse, error)
查询注册房间号
func (*OpenjrtcClient) DescribeUserRooms ¶ added in v1.60.0
func (c *OpenjrtcClient) DescribeUserRooms(request *openjrtc.DescribeUserRoomsRequest) (*openjrtc.DescribeUserRoomsResponse, error)
查询注册房间号列表
允许通过条件过滤查询,支持的过滤字段如下:
- startTime[eq] 房间注册时间段开始时间-UTC时间 startTime,endTime同时有值时生效
- endTime[eq] 房间注册时间段结束时间-UTC时间 startTime,endTime同时有值时生效
func (*OpenjrtcClient) DisableLogger ¶
func (c *OpenjrtcClient) DisableLogger()
func (*OpenjrtcClient) PostMessageToUser ¶ added in v1.60.0
func (c *OpenjrtcClient) PostMessageToUser(request *openjrtc.PostMessageToUserRequest) (*openjrtc.PostMessageToUserResponse, error)
发送自定义信令给房间内的人员
func (*OpenjrtcClient) PostMessageToUserRoom ¶ added in v1.60.0
func (c *OpenjrtcClient) PostMessageToUserRoom(request *openjrtc.PostMessageToUserRoomRequest) (*openjrtc.PostMessageToUserRoomResponse, error)
发送自定义信令给房间
func (*OpenjrtcClient) RegisterUser ¶ added in v1.60.0
func (c *OpenjrtcClient) RegisterUser(request *openjrtc.RegisterUserRequest) (*openjrtc.RegisterUserResponse, error)
注册用户-将业务接入方用户体系的userId注册为jrtc系统内可识别和流转的用户id
func (*OpenjrtcClient) RegisterUserRoom ¶ added in v1.60.0
func (c *OpenjrtcClient) RegisterUserRoom(request *openjrtc.RegisterUserRoomRequest) (*openjrtc.RegisterUserRoomResponse, error)
注册用户房间号-将业务接入方定义的userRoomId注册为jrtc系统内可识别和流转的房间号
func (*OpenjrtcClient) RemoveAllRoomUsers ¶ added in v1.60.0
func (c *OpenjrtcClient) RemoveAllRoomUsers(request *openjrtc.RemoveAllRoomUsersRequest) (*openjrtc.RemoveAllRoomUsersResponse, error)
移除房间内所有人员
func (*OpenjrtcClient) RemoveAllUsersByUserRoomId ¶ added in v1.60.0
func (c *OpenjrtcClient) RemoveAllUsersByUserRoomId(request *openjrtc.RemoveAllUsersByUserRoomIdRequest) (*openjrtc.RemoveAllUsersByUserRoomIdResponse, error)
移除房间内所有人员
func (*OpenjrtcClient) RemoveRoomUser ¶ added in v1.60.0
func (c *OpenjrtcClient) RemoveRoomUser(request *openjrtc.RemoveRoomUserRequest) (*openjrtc.RemoveRoomUserResponse, error)
移除房间内人员
func (*OpenjrtcClient) RemoveUserByUserRoomId ¶ added in v1.60.0
func (c *OpenjrtcClient) RemoveUserByUserRoomId(request *openjrtc.RemoveUserByUserRoomIdRequest) (*openjrtc.RemoveUserByUserRoomIdResponse, error)
移除房间内人员
func (*OpenjrtcClient) SendMessageToRoom ¶ added in v1.60.0
func (c *OpenjrtcClient) SendMessageToRoom(request *openjrtc.SendMessageToRoomRequest) (*openjrtc.SendMessageToRoomResponse, error)
发送自定义信令给房间
func (*OpenjrtcClient) SendMessageToUser ¶ added in v1.60.0
func (c *OpenjrtcClient) SendMessageToUser(request *openjrtc.SendMessageToUserRequest) (*openjrtc.SendMessageToUserResponse, error)
发送自定义信令给房间内的人员
func (*OpenjrtcClient) SetConfig ¶
func (c *OpenjrtcClient) SetConfig(config *core.Config)
func (*OpenjrtcClient) SetLogger ¶
func (c *OpenjrtcClient) SetLogger(logger core.Logger)
func (*OpenjrtcClient) UpdateRoom ¶ added in v1.52.0
func (c *OpenjrtcClient) UpdateRoom(request *openjrtc.UpdateRoomRequest) (*openjrtc.UpdateRoomResponse, error)
修改房间
func (*OpenjrtcClient) UpdateUserRoom ¶ added in v1.60.0
func (c *OpenjrtcClient) UpdateUserRoom(request *openjrtc.UpdateUserRoomRequest) (*openjrtc.UpdateUserRoomResponse, error)
修改房间
Click to show internal directories.
Click to hide internal directories.