Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PluginInterface

NIM 扩展服务 API 定义

Hierarchy

  • PluginInterface

Implemented by

Index

Methods

  • getChatroomAddress(options: { chatroomId: string; done: any }): void
  • 获取聊天室的连接地址,返回可用的连接地址列表

    depreacated

    推荐开发者使用 服务器接口 查询聊天室地址

    Parameters

    • options: { chatroomId: string; done: any }
      • chatroomId: string

        聊天室 id

      • done:function
        • done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: { address: string[]; chatroomId: string; ipType: number; isWeixinApp: boolean; type: number }): void
        • Parameters

          • err: null | NIMCommonError | Error | NIMStrAnyObj
          • data: { address: string[]; chatroomId: string; ipType: number; isWeixinApp: boolean; type: number }
            • address: string[]

              地址列表

            • chatroomId: string

              聊天室 id

            • ipType: number

              0 代表想要获取 ipv4 的连接,1 代表 ipv6,2 代表不限制。

              默认 0

            • isWeixinApp: boolean

              是否是提供给微信环境下用的链接

            • type: number

          Returns void

    Returns void