SignallingService class
信令服务
- Annotations
Constructors
- SignallingService()
-
factory
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
-
onMultiClientEvent
→ Stream<
NIMSignallingEvent> -
多端事件回调
no setter
-
onOfflineEvent
→ Stream<
List< NIMSignallingEvent> > -
离线事件回调
no setter
-
onOnlineEvent
→ Stream<
NIMSignallingEvent> -
在线事件回调
no setter
-
onSyncRoomInfoList
→ Stream<
List< NIMSignallingRoomInfo> > -
同步还在的信令频道房间列表
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
acceptInvite(
NIMSignallingAcceptInviteParams params) → Future< NIMResult< void> > - 接受别人的邀请加入信令房间请求 该接口调用后会触发接受邀请通知给对方
-
call(
NIMSignallingCallParams params) → Future< NIMResult< NIMSignallingCallResult> > - 直接呼叫对方加入房间 信令正常流程： 创建房间（createRoom），房间创建默认有效时间2个小时， 自己加入房间（join） 邀请对方加入房间（invite） 上述的房间是信令的房间，不是音视频的房间，因此需要三次向服务器交互才能建立相关流程 call接口同时由服务器实现了上述三个接口的功能， 可以加速呼叫流程， 如果你需要精确控制每一步，则需要调用上述每一个接口
-
callSetup(
NIMSignallingCallSetupParams params) → Future< NIMResult< NIMSignallingCallSetupResult> > - 呼叫建立， 包括加入信令频道房间， 同时接受对方呼叫 组合接口（join+accept） 如果需要详细处理每一步骤， 则可以单独调用join接口，之后再调用accept接口
-
cancelInvite(
NIMSignallingCancelInviteParams params) → Future< NIMResult< void> > - 取消邀请
-
closeRoom(
String channelId, bool? offlineEnabled, String? serverExtension) → Future< NIMResult< void> > - 关闭信令房间 该接口调用后会触发关闭通知给房间内所有人 房间内的所有人均可以调用该接口 信令房间如果没有主动调用接口关闭，会等待2个小时，2个小时没有新的用户加入，则服务器自行销毁对应的信令房间
-
createRoom(
NIMSignallingChannelType channelType, String? channelName, String? channelExtension) → Future< NIMResult< NIMSignallingChannelInfo> > - 创建信令房间 频道与房间一一对应， 可以理解为同一个东西 相同的频道名，在服务器同时只能存在一个 房间创建默认有效时间2个小时
-
getRoomInfoByChannelName(
String channelName) → Future< NIMResult< NIMSignallingRoomInfo> > - 根据频道名称查询频道房间信息 相同的频道名，在服务器同时只能存在一个
-
invite(
NIMSignallingInviteParams params) → Future< NIMResult< void> > - 邀请他人加入信令房间 该接口调用后会触发邀请通知给对方， 发送方可以配置是否需要发送推送 默认不推送 如果不配置推送相关信息， 则服务器回填默认内容 音频： xx邀请你进行语音通话 视频：xx邀请你进行视频通话 其它： xx邀请你进行音视频通话 房间内的人均可以发送邀请
-
joinRoom(
NIMSignallingJoinParams params) → Future< NIMResult< V2NIMSignallingJoinResult> > - 加入信令房间 该接口调用后会触发加入通知给房间内所有人 默认有效期为5分钟
-
leaveRoom(
String channelId, bool? offlineEnabled, String? serverExtension) → Future< NIMResult< void> > - 离开信令房间 该接口调用后会触发离开通知给房间内所有人
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
rejectInvite(
NIMSignallingRejectInviteParams params) → Future< NIMResult< void> > - 拒绝别人的邀请加入信令房间请求 该接口调用后会触发拒绝邀请通知给对方
-
sendControl(
String channelId, String receiverAccountId, String? serverExtension) → Future< NIMResult< void> > - 发送控制消息 发送自定义控制指令，可以实现自定义相关的业务逻辑 可以发送给指定用户， 如果不指定， 则发送给信令房间内的所有人 该接口不做成员校验， 允许非频道房间内的成员调用， 但是接受者必须在频道房间内或者是创建者 接口调用后会发送一个控制通知 如果指定了接受者： 则通知发送给接受者 如果未指定接受者：则发送给房间内的所有人 通知仅发在线
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited