NIM 跨平台 C++ SDK
载入中...
搜索中...
未找到
v2_nim_signalling_service.hpp
浏览该文件的文档.
1#ifndef V2_NIM_SIGNALLING_SERVICE_H
2#define V2_NIM_SIGNALLING_SERVICE_H
3
4#include "v2_nim_internal.hpp"
5
6namespace v2 {
7
18public:
45 virtual void call(const V2NIMSignallingCallParams& params,
47 const V2NIMFailureCallback& failure) = 0;
48
71 virtual void callSetup(const V2NIMSignallingCallSetupParams& params,
73 const V2NIMFailureCallback& failure) = 0;
74
97 virtual void createRoom(V2NIMSignallingChannelType channelType,
98 const nstd::optional<nstd::string>& channelName,
99 const nstd::optional<nstd::string>& channelExtension,
101 const V2NIMFailureCallback& failure) = 0;
102
125 virtual void closeRoom(const nstd::string& channelId,
126 const nstd::optional<bool>& offlineEnabled,
127 const nstd::optional<nstd::string>& serverExtension,
128 const V2NIMSuccessCallback<void>& success,
129 const V2NIMFailureCallback& failure) = 0;
130
150 virtual void joinRoom(const V2NIMSignallingJoinParams& params,
152 const V2NIMFailureCallback& failure) = 0;
153
175 virtual void leaveRoom(const nstd::string& channelId,
176 const nstd::optional<bool>& offlineEnabled,
177 const nstd::optional<nstd::string>& serverExtension,
178 const V2NIMSuccessCallback<void>& success,
179 const V2NIMFailureCallback& failure) = 0;
180
202 virtual void invite(const V2NIMSignallingInviteParams& params,
203 const V2NIMSuccessCallback<void>& success,
204 const V2NIMFailureCallback& failure) = 0;
205
229 const V2NIMSuccessCallback<void>& success,
230 const V2NIMFailureCallback& failure) = 0;
231
253 const V2NIMSuccessCallback<void>& success,
254 const V2NIMFailureCallback& failure) = 0;
255
277 const V2NIMSuccessCallback<void>& success,
278 const V2NIMFailureCallback& failure) = 0;
279
306 virtual void sendControl(const nstd::string& channelId,
307 const nstd::optional<nstd::string>& receiverAccountId,
308 const nstd::optional<nstd::string>& serverExtension,
309 const V2NIMSuccessCallback<void>& success,
310 const V2NIMFailureCallback& failure) = 0;
311
328 virtual void getRoomInfoByChannelName(const nstd::string& channelName,
330 const V2NIMFailureCallback& failure) = 0;
331
339 virtual void addSignallingListener(const V2NIMSignallingListener& listener) = 0;
340
348 virtual void removeSignallingListener(const V2NIMSignallingListener& listener) = 0;
349};
350
351} // namespace v2
352
353#endif // V2_NIM_SIGNALLING_SERVICE_H
Definition: ne_stl_string.h:19
信令服务
Definition: v2_nim_signalling_service.hpp:17
virtual void addSignallingListener(const V2NIMSignallingListener &listener)=0
添加信令监听器
virtual void acceptInvite(const V2NIMSignallingAcceptInviteParams &params, const V2NIMSuccessCallback< void > &success, const V2NIMFailureCallback &failure)=0
接受别人的邀请加入信令房间请求,该接口调用后会触发接受邀请通知给对方
virtual void invite(const V2NIMSignallingInviteParams &params, const V2NIMSuccessCallback< void > &success, const V2NIMFailureCallback &failure)=0
邀请成员加入信令房间接口,房间内的人均可以发送邀请 该接口调用后会触发邀请通知给对方, 发送方可以配置是否需要发送推送,默认情况下不推送
virtual void createRoom(V2NIMSignallingChannelType channelType, const nstd::optional< nstd::string > &channelName, const nstd::optional< nstd::string > &channelExtension, const V2NIMSuccessCallback< const V2NIMSignallingChannelInfo & > &success, const V2NIMFailureCallback &failure)=0
创建信令房间 频道与房间一一对应,可以理解为同一概念,相同的频道名,在服务器同时只能存在一个 房间创建默认有效时间 2 个小时,房间人数默认上限 100 人
virtual void callSetup(const V2NIMSignallingCallSetupParams &params, const V2NIMSuccessCallback< V2NIMSignallingCallSetupResult > &success, const V2NIMFailureCallback &failure)=0
呼叫建立,包括加入信令频道房间,同时接受对方呼叫
virtual void getRoomInfoByChannelName(const nstd::string &channelName, const V2NIMSuccessCallback< const V2NIMSignallingRoomInfo & > &success, const V2NIMFailureCallback &failure)=0
根据频道名称查询频道房间信息
virtual void rejectInvite(const V2NIMSignallingRejectInviteParams &params, const V2NIMSuccessCallback< void > &success, const V2NIMFailureCallback &failure)=0
拒绝别人的邀请加入信令房间请求,该接口调用后会触发拒绝邀请通知给对方
virtual void sendControl(const nstd::string &channelId, const nstd::optional< nstd::string > &receiverAccountId, const nstd::optional< nstd::string > &serverExtension, const V2NIMSuccessCallback< void > &success, const V2NIMFailureCallback &failure)=0
发送自定义控制指令,可以实现自定义相关的业务逻辑 可以发送给指定用户,如果不指定,则发送给信令房间内的所有人 该接口不做成员校验,允许非频道房间内的成员调用,但是接受者必须在频道房间内或者是创建者 接口...
virtual void call(const V2NIMSignallingCallParams &params, const V2NIMSuccessCallback< const V2NIMSignallingCallResult & > &success, const V2NIMFailureCallback &failure)=0
直接呼叫对方加入房间 信令正常流程为
virtual void joinRoom(const V2NIMSignallingJoinParams &params, const V2NIMSuccessCallback< const V2NIMSignallingRoomInfo & > &success, const V2NIMFailureCallback &failure)=0
加入信令房间接口 该接口调用后会触发加入通知给房间内所有人,默认有效期为 5 分钟
virtual void removeSignallingListener(const V2NIMSignallingListener &listener)=0
移除信令监听器
virtual void cancelInvite(const V2NIMSignallingCancelInviteParams &params, const V2NIMSuccessCallback< void > &success, const V2NIMFailureCallback &failure)=0
取消之前的邀请成员加入信令房间接口
virtual void closeRoom(const nstd::string &channelId, const nstd::optional< bool > &offlineEnabled, const nstd::optional< nstd::string > &serverExtension, const V2NIMSuccessCallback< void > &success, const V2NIMFailureCallback &failure)=0
关闭信令房间接口 该接口调用后会触发关闭通知给房间内所有人,房间内的所有人均可以调用该接口 信令房间如果没有主动调用接口关闭,会等待 2 个小时,2 个小时没有新的用户加入,则服务器自行销毁对应的信令房...
virtual void leaveRoom(const nstd::string &channelId, const nstd::optional< bool > &offlineEnabled, const nstd::optional< nstd::string > &serverExtension, const V2NIMSuccessCallback< void > &success, const V2NIMFailureCallback &failure)=0
离开信令房间接口 该接口调用后会触发离开通知给房间内所有人
通用成功
Definition: v2_nim_def_callback.hpp:7
Definition: v2_nim_ai_service.hpp:4
V2NIMSignallingChannelType
Definition: v2_nim_def_enum.hpp:1540
Definition: ne_stl_optional.h:16
Definition: ne_stl_bind.h:132
拒绝别人邀请加入信令房间请求参数
Definition: v2_nim_def_struct.hpp:2298
信令呼叫参数
Definition: v2_nim_def_struct.hpp:2135
呼叫建立请求参数,包括接收方进入频道房间相关信息,以及接受方需要的相关音视频房间信息
Definition: v2_nim_def_struct.hpp:2216
取消之前的邀请成员加入信令房间请求参数
Definition: v2_nim_def_struct.hpp:2270
邀请成员加入信令房间请求参数
Definition: v2_nim_def_struct.hpp:2254
加入信令房间请求参数
Definition: v2_nim_def_struct.hpp:2242
Definition: v2_nim_def_callback.hpp:250
拒绝别人邀请加入信令房间请求参数
Definition: v2_nim_def_struct.hpp:2284