SignalingServiceInterface

调用方式:

nim.signaling.callEx(options)

Hierarchy

SignalingServiceInterface

Index

Methods

accept

accept(options: NIMESignalingAcceptOptions): Promise<void>

deprecated
- 请使用 joinAndAccept 替代此函数
接受进入频道的邀请
Parameters
- options: NIMESignalingAcceptOptions
Returns Promise<void>

callEx

callEx(options: NIMESignalingCallExOptions): Promise<NIMESignalingChannel>

呼叫并加入频道: 创建一个频道, 己方加入，并邀请对方加入音视频的频道
注: 组合接口, 等效于 create 创建频道 + join 加入频道 + invite 邀请他人进入频道
- 频道存在默认有效期。若房间内存在成员，频道会自动延长有效期。
影响范围
- 被邀请人收到 signalingInvite 事件通知
Parameters
- options: NIMESignalingCallExOptions
Returns Promise<NIMESignalingChannel>

cancelInvite

cancelInvite(options: NIMESignalingCancelInviteOptions): Promise<void>

取消邀请
影响范围
- 被邀请人会收到 signalingCancelInvite 事件通知
- 邀请人取消邀请后，被邀请人无法调用 joinAndAccept 加入频道
Parameters
- options: NIMESignalingCancelInviteOptions
Returns Promise<void>

close

close(options: NIMESignalingCloseOptions): Promise<void>

关闭频道。已经关闭的房间无法再加入
影响范围
- 房间内其它用户会收到 signalingClose 事件通知
Parameters
- options: NIMESignalingCloseOptions
Returns Promise<void>

create

create(options: NIMESignalingCreateOptions): Promise<NIMESignalingChannel>

- 推荐使用复合接口 callEx 替换此函数。
通过名称创建频道。注意创建房间后，需要调用 join 才可以加入房间。
- 频道存在默认有效期。若房间内存在成员，频道会自动延长有效期。
- 函数返回结果为频道的基本信息。其它用户根据返回值的 channelInfo.channelId 加入房间
- 创建房间后，应用内所有用户可以通过 queryInfo 查询房间信息
Parameters
- options: NIMESignalingCreateOptions
Returns Promise<NIMESignalingChannel>

invite

invite(options: NIMESignalingInviteOptions): Promise<void>

邀请某人进入频道。
影响范围
- 被邀请人会收到 signalingInvite 事件通知
- 被邀请人通过 joinAndAccept 加入频道。
Parameters
- options: NIMESignalingInviteOptions
Returns Promise<void>

join

join(options: NIMESignalingJoinOptions): Promise<NIMESignalingChannel>

通过 channelId 加入频道。
- 相同 uid 不能同时进入一个频道。也不允许同一个 IM 账号多处同时进入一个房间。
影响范围
- 加入频道后，已在房间中的用户会收到 signalingJoin 事件通知
Parameters
- options: NIMESignalingJoinOptions
Returns Promise<NIMESignalingChannel>

joinAndAccept

joinAndAccept(options: NIMESignalingJoinAndAcceptOptions): Promise<NIMESignalingChannel>

接受呼叫邀请，并加入频道
- 收到 signalingInvite 事件通知后，调用此接口加入频道
影响范围
- 调用此接口后，邀请人收到 signalingAccept 事件通知
- 调用此接口后，频道内的成员收到 signalingJoin 事件通知
Parameters
- options: NIMESignalingJoinAndAcceptOptions
Returns Promise<NIMESignalingChannel>

leave

leave(options: NIMESignalingLeaveOptions): Promise<void>

离开频道
影响范围
- 房间内其它用户会收到 signalingLeave 事件通知
Parameters
- options: NIMESignalingLeaveOptions
Returns Promise<void>

queryInfo

queryInfo(options: NIMESignalingQueryInfoOptions): Promise<NIMESignalingChannel>

通过频道名称(name)查询频道信息。返回结果包括频道基本信息，以及频道的在线成员列表。

Parameters
- options: NIMESignalingQueryInfoOptions
Returns Promise<NIMESignalingChannel>

reject

reject(options: NIMESignalingRejectOptions): Promise<void>

收到 signalingInvite 事件通知后，通过该函数拒绝进入频道的邀请。
影响范围
- 邀请人收到 signalingReject 事件通知
Parameters
- options: NIMESignalingRejectOptions
Returns Promise<void>

sendCustomCommand

sendCustomCommand(options: NIMESignalingSendCustomCommandOptions): Promise<void>

发送自定义信令, 只有频道内的用户才可以接收指令
影响范围
- 信令接收方会收到 signalingCustomCommand 事件通知
Parameters
- options: NIMESignalingSendCustomCommandOptions
Returns Promise<void>

Hierarchy

Index

Methods

Methods

accept

Parameters

options: NIMESignalingAcceptOptions

Returns Promise<void>

callEx

影响范围

Parameters

options: NIMESignalingCallExOptions

Returns Promise<NIMESignalingChannel>

cancelInvite

影响范围

Parameters

options: NIMESignalingCancelInviteOptions

Returns Promise<void>

close

影响范围

Parameters

options: NIMESignalingCloseOptions

Returns Promise<void>

create

Parameters

options: NIMESignalingCreateOptions

Returns Promise<NIMESignalingChannel>

invite

影响范围

Parameters

options: NIMESignalingInviteOptions

Returns Promise<void>

join

影响范围

Parameters

options: NIMESignalingJoinOptions

Returns Promise<NIMESignalingChannel>

joinAndAccept

影响范围

Parameters

options: NIMESignalingJoinAndAcceptOptions

Returns Promise<NIMESignalingChannel>

leave

影响范围

Parameters

options: NIMESignalingLeaveOptions

Returns Promise<void>

queryInfo

Parameters

options: NIMESignalingQueryInfoOptions

Returns Promise<NIMESignalingChannel>

reject

影响范围

Parameters

options: NIMESignalingRejectOptions

Returns Promise<void>

sendCustomCommand

影响范围

Parameters

options: NIMESignalingSendCustomCommandOptions

Returns Promise<void>