AvSignallingService class
信令服务类 目前仅支持iOS和Android平台
Constructors
- AvSignallingService()
-
factory
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
-
offlineNotification
→ Stream<
List< ChannelCommonEvent> > -
离线通知事件观察者,在用户登录后sdk 会去服务器同步用户离线期间发生的各种通知,并以列表的形式返回。
列表的排序方式为时间递增排序。
注意:登录后第一次注册此回调时,如果sdk已经获取到了相应的离线通知列表,会立即回调一次(仅此一次)。
可以根据事件类型获取对象中的特殊属性
no setter
-
onlineNotification
→ Stream<
ChannelCommonEvent> -
在线通知事件回调
回调返回为
ChannelCommonEvent
的对象 可以根据事件类型获取对象中的特殊属性no setter -
onMemberUpdateNotification
→ Stream<
SyncChannelEvent> -
频道成员更新事件回调
no setter
-
otherClientInviteAckNotification
→ Stream<
ChannelCommonEvent> -
其他端响应(接收/拒绝)邀请事件回调,当其他端响应了邀请时触发
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
syncChannelListNotification
→ Stream<
List< SyncChannelEvent> > -
同步未退出频道列表事件回调 ,在用户登录后sdk会去服务器获取当前还未退出的频道列表 。
注意:登录后第一次注册此回调时,如果sdk已经获取到了相应的频道列表,会立即回调一次(仅此一次)。
no setter
Methods
-
acceptInvite(
InviteParam inviteParam) → Future< NIMResult< void> > -
接受对方邀请,但并不代表加入了频道
错误码如下:
10201:已经成功接受邀请但是对方不在线(推送可达,但是离线)
10404:频道不存在
10408:邀请不存在或已过期
10409:邀请已经拒绝
10410:邀请已经接受
paramBuilder
-
call(
CallParam callParam) → Future< NIMResult< ChannelFullInfo> > -
直接呼叫 , 用于用户新开一个频道并邀请对方加入频道。该接口为组合接口,等同于用户先创建频道,然后加入频道并邀请对方。
错误码如下:
10201:已经成功发出邀请但是对方不在线(推送可达,但是离线)
10202:已经成功发出邀请但是对方推送不可达
10405:频道已存在
callParamBuilder
-
cancelInvite(
InviteParam inviteParam) → Future< NIMResult< void> > -
取消邀请
错误码如下:
10404:频道不存在
10408:邀请不存在或已过期 (过期时间2min)
10409:邀请已经拒绝
10410:邀请已经接受
inviteParam
-
closeChannel(
{required String channelId, required bool offlineEnabled, String? customInfo}) → Future< NIMResult< void> > - 关闭频道 错误码如下: 10406:不在频道内
-
createChannel(
{required ChannelType type, String? channelName, String? channelExt}) → Future< NIMResult< ChannelBaseInfo> > - 创建频道 同一时刻频道名互斥,不能重复创建,但如果频道名缺省,服务器会自动分配频道id。 错误码如下: 10405:频道已存在
-
invite(
InviteParam inviteParam) → Future< NIMResult< void> > -
邀请他人加入频道
该接口用于邀请对方加入频道,邀请者必须是创建者或者是频道中成员。如果需要对离线成员邀请,
可以打开离线邀请开关并填写推送信息,被邀请者上线后通过离线通知接收到该邀请。
错误码如下:
10201:已经成功发出邀请但是对方不在线(推送可达,但是离线)
10202:已经成功发出邀请但是对方推送不可达
10404:频道不存在
10406:自己不在频道内(仅对于普通用户,频道创建者不在频道内也可以邀请别人)
10407:对方已经频道内
10419:频道人数超限
inviteParam
-
joinChannel(
{required String channelId, int? selfUid, String? customInfo, required bool offlineEnabled}) → Future< NIMResult< ChannelFullInfo> > - 加入频道 错误码如下: 10407:已经频道内 10417:uid冲突 10419:频道人数超限,默认100,可通过APPID配置 10420:自己的其他端已经在频道内
-
leaveChannel(
{required String channelId, required bool offlineEnabled, String? customInfo}) → Future< NIMResult< void> > - 离开频道 错误码如下: 10406:不在频道内
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
queryChannelInfo(
String channelName) → Future< NIMResult< ChannelFullInfo> > -
根据channelName反查channelInfo
10404:频道不存在
channelName
-
rejectInvite(
InviteParam inviteParam) → Future< NIMResult< void> > -
拒绝对方邀请
错误码如下:
10201:已经成功拒绝邀请但是对方不在线(推送可达,但是离线)
10404:频道不存在
10408:邀请不存在或已过期
10409:邀请已经拒绝
10410:邀请已经接受
paramBuilder
-
sendControl(
{required String channelId, required String accountId, String? customInfo}) → Future< NIMResult< void> > - 该接口用于在频道中透传一些自定义指令,协助频道管理。该接口允许非频道内成员调用,但接收者必须是频道内成员或创建者
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited