Documentation

Class: Signaling

Signaling

new Signaling()

请使用 NIM.getInstance 来初始化信令SDK环境.

See:

Methods

signalingAccept(options)

接受别人的邀请

Parameters:
Name Type Description
options Object

参数对象

Properties
Name Type Description
channelId String

对应的频道id
account String

邀请者的账号
requestId String

邀请者邀请的请求id，用于被邀请者回传request_id_作对应的回应操作
offlineEnabled Boolean

是否存离线通知，默认false
attachExt String

操作者附加的自定义信息，透传给其他人，可缺省
autoJoin Boolean

是否自动加入房间，默认不打开，打开后后续参数uid、joinAttachExt有效
uid String

自己在频道中对应的uid，大于零有效，无效时服务器会分配随机唯一的uid，可缺省
joinAttachExt String

加入频道的自定义扩展信息，将在加入频道通知中带给其他频道成员，可缺省
nertcChannelName String

云信G2-RTC的房间名，加入频道请求时携带，则会返回token
nertcTokenTtl String

云信G2-RTC的token的有效期，表示token的过期时间，单位秒，选填，默认10分钟
nertcJoinRoomQueryParamMap String

云信G2-RTC加入房间的请求参数，推荐传入 JSON 序列化字符串
Returns:
Type
Promise.<void>

signalingCall(options)

用于用户新开一个频道并邀请对方加入频道

Parameters:
Name Type Description
options Object

参数对象

Properties
Name Type Description
type Number

通话类型,1:音频;2:视频;3:其他
channelName String

频道名，可缺省
ext String

频道的自定义扩展信息，可缺省
uid String

自己在频道中对应的uid，大于零有效，无效时服务器会分配随机唯一的uid，可缺省填0
account String

被邀请者的账号
requestId String

邀请者邀请的请求id，用于被邀请者回传request_id_作对应的回应操作
offlineEnabled Boolean

是否存离线通知，默认0
attachExt String

操作者附加的自定义信息，透传给其他人，可缺省
nertcChannelName String

云信G2-RTC的房间名，加入频道请求时携带，则会返回token
nertcTokenTtl String

云信G2-RTC的token的有效期，表示token的过期时间，单位秒，选填，默认10分钟
nertcJoinRoomQueryParamMap String

云信G2-RTC加入房间的请求参数，推荐传入 JSON 序列化字符串
pushInfo String

推送信息

signalingCallEx(options)

创建和加入房间并邀请
9.5.0 新增接口

Parameters:
Name Type Description
options Object

参数对象

Properties
Name Type Description
channelName String

频道名，可缺省
type Number

通话类型,1:音频;2:视频;3:其他，必须
ext String

频道的自定义扩展信息，可缺省
account String

对方accid，必须
requestId String

必须，邀请者邀请的请求id，需要邀请者填写，之后取消邀请、拒绝、接受需要复用该requestId
pushInfo.needPush Boolean

是否需要推送，默认false
pushInfo.pushTitle String

推送标题
pushInfo.pushContent String

推送内容
pushInfo.pushPayload String

推送自定义字段,必须JSON
pushInfo.needBadge Boolean

是否计入未读计数,默认true
options.attachExt String

操作者附加的自定义信息，透传给其他人，可缺省
options.offlineEnabled Boolean

是否存离线通知，默认false
options.uid Number

自己在频道中对应的uid，大于零有效，无效时服务器会分配随机唯一的uid
options.nertcChannelName String

云信G2-RTC的房间名，加入频道请求时携带，则会返回token
options.nertcTokenTtl String

云信G2-RTC的token的有效期，表示token的过期时间，单位秒，选填，默认10分钟
options.nertcJoinRoomQueryParamMap String

云信G2-RTC加入房间的请求参数，推荐传入 JSON 序列化字符串
Returns:
Type
Promise.<void>

signalingCancel(options)

取消邀请别人加入频道

Parameters:
Name Type Description
options Object

参数对象

Properties
Name Type Description
channelId String

对应的频道id，必填
account String

对方accid，必填
requestId String

邀请者邀请的请求id，用于取消对应的请求消息，必填
offlineEnabled Boolean

是否存离线通知，默认false
attachExt String

操作者附加的自定义信息，透传给其他人，可缺省
Returns:
Type
Promise.<void>

signalingClose(options)

独立呼叫信令-关闭频道.
该接口可以由创建者和频道内所有成员调用，无权限限制。调用该接口成功后，其他所有频道内的成员都回收到频道结束的通知，被动离开频道。此时其他成员不需要调用离开接口，也不会收到别人的离开通知。

Parameters:
Name Type Description
options Object

参数对象

Properties
Name Type Description
channelId String

对应的频道id，必须
offlineEnabled Boolean

是否存离线通知，默认false
attachExt String

操作者附加的自定义信息，透传给其他人，可缺省
Returns:
Type
Promise.<void>
Example
nim.signalingClose({
  channelId: 'qq',
  offlineEnabled: true
});

signalingControl(options)

用户自定义控制指令接口，该接口用于在频道中透传一些自定义指令，协助频道管理，该接口允许非频道内成员调用，但接收者必须是频道内成员或创建者。

Parameters:
Name Type Description
options Object

参数对象

Properties
Name Type Description
channelId String

对应的频道id
account String

对方accid，如果为空，则通知所有人
attachExt String

操作者附加的自定义信息，透传给其他人，可缺省
Returns:
Type
Promise.<void>

signalingCreate(options)

独立呼叫信令-创建频道

Parameters:
Name Type Description
options Object

参数对象

Properties
Name Type Description
type Number

通话类型,1:音频;2:视频;3:其他，必须
channelName String

频道名，可缺省
ext String

频道的自定义扩展信息，可缺省
Returns:
Type
Promise
Example
nim.signalingCreate({
  type: 1,
  channelName: '11'
});

signalingCreateAndJoin(options)

如果不存在房间则创建并加入，如果存在则加入

Parameters:
Name Type Description
options Object

参数对象

Properties
Name Type Description
type Number

通话类型,1:音频;2:视频;3:其他
channelName String

频道名，可缺省
ext String

频道的自定义扩展信息，可缺省
uid String

自己在频道中对应的uid，大于零有效，无效时服务器会分配随机唯一的uid，可缺省填0
offlineEnabled Boolean

是否存离线通知，默认0
attachExt String

操作者附加的自定义信息，透传给其他人，可缺省

signalingDelay(options)

独立呼叫信令-延迟频道有效期（同时延迟操作者和房间）

Parameters:
Name Type Description
options Object

参数对象

Properties
Name Type Description
channelId String

对应的频道id，必须
Returns:
Type
Promise.<void>
Example
nim.signalingDelay({
  channelId: 'qq',
});

signalingGetChannelInfo(options)

独立呼叫信令-根据channelName查询房间信息，包括channelId, members

Parameters:
Name Type Description
options Object

参数对象

Properties
Name Type Description
channelName String

频道名，可缺省
ext String

频道的自定义扩展信息，可缺省
Returns:
Type
Promise
Example
nim.signalingGetChannelInfo({
  channelName: '11'
}).then(function(channelInfo){
  console.log('channelInfo:',channelInfo)
  console.log('房间id',channelInfo.channelId)
  let members = channelInfo.members;
  console.log('房间人数为':memner.length)
  console.log('房间内的用户列表':memner)
});

signalingInvite(options)

邀请别人加入频道

Parameters:
Name Type Description
options Object

参数对象

Properties
Name Type Description
channelId String

对应的频道id，必须
account String

对方accid，必须
requestId String

必须，邀请者邀请的请求id，需要邀请者填写，之后取消邀请、拒绝、接受需要复用该requestId
offlineEnabled Boolean

是否存离线通知，默认false
attachExt String

邀请者附加的自定义信息，透传给被邀请者，可缺省
pushInfo Object

推送信息
pushInfo.needPush Boolean

是否需要推送，默认false
pushInfo.needBadge Boolean

是否计入未读计数,默认true
pushInfo.pushTitle String

推送标题
pushInfo.pushContent String

推送内容
pushInfo.pushPayload String

推送自定义字段,必须JSON
Returns:
Type
Promise.<void>

signalingJoin(options)

独立呼叫信令-加入频道

Parameters:
Name Type Description
options Object

参数对象

Properties
Name Type Description
channelId String

对应的频道id,必须
uid Number

自己在频道中对应的uid，大于零有效，无效时服务器会分配随机唯一的uid
offlineEnabled Boolean

是否存离线通知，默认false
attachExt String

操作者附加的自定义信息，透传给其他人，可缺省
nertcChannelName String

云信G2-RTC的房间名，加入频道请求时携带，则会返回token
nertcTokenTtl String

云信G2-RTC的token的有效期，表示token的过期时间，单位秒，选填，默认10分钟
nertcJoinRoomQueryParamMap String

云信G2-RTC加入房间的请求参数，推荐传入 JSON 序列化字符串
Returns:
Type
Promise.<void>

signalingJoinAndAccept(options)

该接口为组合接口，等同于用户先加入频道，成功后接受邀请
9.5.0 新增接口

Parameters:
Name Type Description
options Object

参数对象

Properties
Name Type Description
channelId String

对应的频道id，必须
attachExt String

操作者附加的自定义信息，透传给其他人，可缺省
offlineEnabled Boolean

是否存离线通知，默认false
uid Number

自己在频道中对应的uid，大于零有效，无效时服务器会分配随机唯一的uid
account String

对方accid，必须
requestId String

必须，邀请者邀请的请求id，需要邀请者填写，之后取消邀请、拒绝、接受需要复用该requestId
nertcChannelName String

云信G2-RTC的房间名，加入频道请求时携带，则会返回token
nertcTokenTtl String

云信G2-RTC的token的有效期，表示token的过期时间，单位秒，选填，默认10分钟
nertcJoinRoomQueryParamMap String

云信G2-RTC加入房间的请求参数，推荐传入 JSON 序列化字符串
Returns:
Type
Promise.<void>

signalingLeave(options)

独立呼叫信令-离开频道

Parameters:
Name Type Description
options Object

参数对象，必填

Properties
Name Type Description
channelId String

对应的频道id
offlineEnabled Boolean

是否存离线通知，默认false
attachExt String

操作者附加的自定义信息，透传给其他人，可缺省
Returns:
Type
Promise.<void>

signalingMarkMsgRead(options)

标记信令消息已读

Parameters:
Name Type Description
options Object

参数对象

Properties
Name Type Description
msgid Array.<String>

需要标记的已读消息id
Returns:
Type
Promise.<void>

signalingReject(options)

拒绝别人的邀请

Parameters:
Name Type Description
options Object

参数对象

Properties
Name Type Description
channelId String

对应的频道id
account String

邀请者的账号
requestId String

邀请者邀请的请求id，用于被邀请者回传request_id_作对应的回应操作
offlineEnabled Boolean

是否存离线通知，默认false
attachExt String

操作者附加的自定义信息，透传给其他人，可缺省
Returns:
Type
Promise.<void>

signalingSync()

同步离线时的信令消息

Parameters:
Type Description
Void
Returns:
Type
Promise.<void>