Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • SignalingInterface

Implemented by

Index

Methods

  • signalingAccept(options: { account: string; attachExt?: string; autoJoin?: boolean; channelId: string; joinAttachExt?: string; offlineEnabled?: boolean; requestId: string; uid?: number }): Promise<void>
  • 接受进入频道的邀请

    Parameters

    • options: { account: string; attachExt?: string; autoJoin?: boolean; channelId: string; joinAttachExt?: string; offlineEnabled?: boolean; requestId: string; uid?: number }
      • account: string

        邀请者的账号 account id

      • Optional attachExt?: string

        该操作的附加信息,透传给其他人

      • Optional autoJoin?: boolean

        接受邀请后,是否直接加入频道。默认为 true

      • channelId: string

        频道 id

      • Optional joinAttachExt?: string

        接受邀请后,加入频道的操作附加信息,将在加入频道通知中带给其他频道成员

      • Optional offlineEnabled?: boolean

        是否存入离线消息。默认 false

      • requestId: string

        邀请者邀请的请求id,需要邀请者填写,之后取消邀请、拒绝、接受需要复用该 requestId

      • Optional uid?: number

        接受邀请后,自己在频道中对应的uid。大于零有效,无效时服务器会分配随机唯一的uid

    Returns Promise<void>

  • signalingCall(options: { account: string; attachExt?: string; channelName: string; ext?: string; offlineEnabled?: boolean; pushInfo?: NIMSignalingPushInfo; requestId: string; type: number; uid?: string }): Promise<NIMSignalingChannel>
  • 呼叫: 创建一个频道, 己方加入,并邀请对方加入频道

    注: 组合接口, 相当于调用 signalingCreateAndJoin 后, 调用 signalingInvite.

    Parameters

    • options: { account: string; attachExt?: string; channelName: string; ext?: string; offlineEnabled?: boolean; pushInfo?: NIMSignalingPushInfo; requestId: string; type: number; uid?: string }
      • account: string

        受邀请者的账号 account id

      • Optional attachExt?: string

        该操作的附加信息,透传给受邀请者

      • channelName: string

        频道名称

      • Optional ext?: string

        扩展字段

      • Optional offlineEnabled?: boolean

        是否存入离线消息。默认 false

      • Optional pushInfo?: NIMSignalingPushInfo

        推送属性

      • requestId: string

        邀请者邀请的请求id,需要邀请者填写,之后取消邀请、拒绝、接受需要复用该 requestId

      • type: number

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

      • Optional uid?: string

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

    Returns Promise<NIMSignalingChannel>

  • signalingCallEx(options: { account: string; attachExt?: string; channelName: string; ext?: string; nertcChannelName?: string; nertcJoinRoomQueryParamMap?: string; nertcTokenTtl?: string; offlineEnabled?: boolean; pushInfo?: NIMSignalingPushInfo; requestId: string; type: number; uid?: string }): Promise<NIMSignalingChannel>
  • 呼叫加入音视频频道: 创建一个频道, 己方加入,并邀请对方加入音视频的频道

    注: 组合接口, 比 signalingCall 多了云信 G2 音视频相关的参数

    Parameters

    • options: { account: string; attachExt?: string; channelName: string; ext?: string; nertcChannelName?: string; nertcJoinRoomQueryParamMap?: string; nertcTokenTtl?: string; offlineEnabled?: boolean; pushInfo?: NIMSignalingPushInfo; requestId: string; type: number; uid?: string }
      • account: string

        受邀请者的账号 account id

      • Optional attachExt?: string

        该操作的附加信息,透传给受邀请者

      • channelName: string

        频道名称

      • Optional ext?: string

        扩展字段

      • Optional nertcChannelName?: string

        云信 G2-RTC 的房间名,加入频道时 sdk 会携带这个参数, 再返回对应的 token

      • Optional nertcJoinRoomQueryParamMap?: string

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

      • Optional nertcTokenTtl?: string

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

      • Optional offlineEnabled?: boolean

        是否存入离线消息。默认 false

      • Optional pushInfo?: NIMSignalingPushInfo

        推送属性

      • requestId: string

        邀请者邀请的请求id,需要邀请者填写,之后取消邀请、拒绝、接受需要复用该 requestId

      • type: number

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

      • Optional uid?: string

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

    Returns Promise<NIMSignalingChannel>

  • signalingCancel(options: { account: string; attachExt?: string; channelId: string; offlineEnabled?: boolean; requestId: string }): Promise<void>
  • 取消邀请

    Parameters

    • options: { account: string; attachExt?: string; channelId: string; offlineEnabled?: boolean; requestId: string }
      • account: string

        受邀请者的账号 account id

      • Optional attachExt?: string

        该操作的附加信息,透传给受邀请者

      • channelId: string

        频道 id

      • Optional offlineEnabled?: boolean

        是否存入离线消息。默认 false

      • requestId: string

        邀请者邀请的请求id,需要邀请者填写,之后取消邀请、拒绝、接受需要复用该 requestId

    Returns Promise<void>

  • signalingClose(options: { attachExt?: string; channelId: string; offlineEnabled?: boolean }): Promise<void>
  • 关闭频道

    Parameters

    • options: { attachExt?: string; channelId: string; offlineEnabled?: boolean }
      • Optional attachExt?: string

        该操作的附加信息,透传给其他人

      • channelId: string

        频道 id

      • Optional offlineEnabled?: boolean

        是否存入离线消息。默认 false

    Returns Promise<void>

  • signalingControl(options: { account?: string; attachExt?: string; channelId: string }): Promise<void>
  • 发送自定义信令

    Parameters

    • options: { account?: string; attachExt?: string; channelId: string }
      • Optional account?: string

        要通知的目标账号(account id)。如果不传则通知所有人

      • Optional attachExt?: string

        该操作的附加信息,透传给其他人

      • channelId: string

        频道 id

    Returns Promise<void>

  • signalingCreate(options: { channelName: string; ext?: string; type: number }): Promise<NIMSignalingChannel>
  • 创建频道

    Parameters

    • options: { channelName: string; ext?: string; type: number }
      • channelName: string

        频道名称

      • Optional ext?: string

        扩展字段

      • type: number

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

    Returns Promise<NIMSignalingChannel>

  • signalingCreateAndJoin(options: { attachExt?: string; channelName: string; ext?: string; offlineEnabled?: boolean; type: number; uid?: string }): Promise<NIMSignalingChannel>
  • 如果不存在房间, 则创建一个频道,并且己方加入. 如果已存在频道,则己方直接加入

    注: 组合接口, 相当于调用 signalingCreate 后, 调用 signalingJoin.

    Parameters

    • options: { attachExt?: string; channelName: string; ext?: string; offlineEnabled?: boolean; type: number; uid?: string }
      • Optional attachExt?: string

        该操作的附加信息,透传给受邀请者

      • channelName: string

        频道名称

      • Optional ext?: string

        扩展字段

      • Optional offlineEnabled?: boolean

        是否存入离线消息。默认 false

      • type: number

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

      • Optional uid?: string

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

    Returns Promise<NIMSignalingChannel>

  • 延长频道的有效期

    注:SDK 在 v9.8.0 及以后自动托管频道的有效期,不需要开发者再手动延迟.

    Parameters

    • options: { channelId: string }
      • channelId: string

        频道id,唯一标识

    Returns Promise<NIMSignalingChannel>

  • 查询频道信息. 根据 channelName 查询房间信息

    Parameters

    • options: { channelName: string }
      • channelName: string

        频道名

    Returns Promise<NIMSignalingChannel>

  • signalingInvite(options: { account: string; attachExt?: string; channelId: string; offlineEnabled?: boolean; pushInfo?: NIMSignalingPushInfo; requestId: string }): Promise<void>
  • 邀请某人进入频道

    Parameters

    • options: { account: string; attachExt?: string; channelId: string; offlineEnabled?: boolean; pushInfo?: NIMSignalingPushInfo; requestId: string }
      • account: string

        受邀请者的账号 account id

      • Optional attachExt?: string

        该操作的附加信息,透传给受邀请者

      • channelId: string

        频道 id

      • Optional offlineEnabled?: boolean

        是否存入离线消息。默认 false

      • Optional pushInfo?: NIMSignalingPushInfo

        推送属性

      • requestId: string

        邀请者邀请的请求id,需要邀请者填写,之后取消邀请、拒绝、接受需要复用该 requestId

    Returns Promise<void>

  • signalingJoin(options: { attachExt?: string; channelId: string; offlineEnabled?: boolean; uid?: number }): Promise<NIMSignalingChannel>
  • 加入频道

    Parameters

    • options: { attachExt?: string; channelId: string; offlineEnabled?: boolean; uid?: number }
      • Optional attachExt?: string

        该操作的附加信息,透传给其他人

      • channelId: string

        频道 id

      • Optional offlineEnabled?: boolean

        是否存入离线消息。默认 false

      • Optional uid?: number

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

    Returns Promise<NIMSignalingChannel>

  • signalingJoinAndAccept(_options: { account: string; attachExt?: string; channelId: string; nertcChannelName?: string; nertcJoinRoomQueryParamMap?: string; nertcTokenTtl?: number; offlineEnabled?: boolean; requestId: string; uid?: number }): Promise<void>
  • 加入频道并接受邀请。该接口实际为组合接口,等同于先调用加入频道,成功后再调用接受邀请接口。

    Parameters

    • _options: { account: string; attachExt?: string; channelId: string; nertcChannelName?: string; nertcJoinRoomQueryParamMap?: string; nertcTokenTtl?: number; offlineEnabled?: boolean; requestId: string; uid?: number }
      • account: string

        对方accid,必须

      • Optional attachExt?: string

        该操作的附加信息,透传给其他人

      • channelId: string

        频道 id

      • Optional nertcChannelName?: string

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

      • Optional nertcJoinRoomQueryParamMap?: string

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

      • Optional nertcTokenTtl?: number

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

      • Optional offlineEnabled?: boolean

        是否存离线通知,默认false

      • requestId: string

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

      • Optional uid?: number

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

    Returns Promise<void>

  • signalingLeave(options: { attachExt?: string; channelId: string; offlineEnabled?: boolean }): Promise<void>
  • 离开频道

    Parameters

    • options: { attachExt?: string; channelId: string; offlineEnabled?: boolean }
      • Optional attachExt?: string

        该操作的附加信息,透传给其他人

      • channelId: string

        频道 id

      • Optional offlineEnabled?: boolean

        是否存入离线消息。默认 false

    Returns Promise<void>

  • signalingMarkMsgRead(options: { msgid: string[] | number[] }): Promise<void>
  • 标记信令消息已收到, 下次不会在离线同步中收到此消息

    Parameters

    • options: { msgid: string[] | number[] }
      • msgid: string[] | number[]

        需要标记的已读的信令消息 id

    Returns Promise<void>

  • signalingReject(options: { account: string; attachExt?: string; channelId: string; offlineEnabled?: boolean; requestId: string }): Promise<void>
  • 拒绝进入频道的邀请

    Parameters

    • options: { account: string; attachExt?: string; channelId: string; offlineEnabled?: boolean; requestId: string }
      • account: string

        邀请者的账号 account id

      • Optional attachExt?: string

        该操作的附加信息,透传给其他人

      • channelId: string

        频道 id

      • Optional offlineEnabled?: boolean

        是否存入离线消息。默认 false

      • requestId: string

        邀请者邀请的请求id,需要邀请者填写,之后取消邀请、拒绝、接受需要复用该 requestId

    Returns Promise<void>