Options
All
  • Public
  • Public/Protected
  • All
Menu

Module ChatroomInterface

Index

Interfaces

Type Aliases

Type Aliases

ChatroomInitializeOptions

ChatroomInitializeOptions: { account: string; appkey: string; authType?: number; chatroomAddresses: string[]; chatroomId: string; debugLevel?: string; isAnonymous?: boolean; isFixedDeviceId?: boolean; loginExt?: string; needReconnect?: boolean; notifyTargetTags?: string; reconnectionAttempts?: number; tags?: string[]; token: string }

聊天室实例初始化参数

eg. new sdk({ ...ChatroomInitializeOptions })

Type declaration

  • account: string
  • appkey: string

    注意 k 是小写的

  • Optional authType?: number

    鉴权方式，默认0 0 表示最初的loginToken的校验方式， 1 表示基于appSecret计算的token鉴权方式， 2 表示基于第三方回调的token鉴权方式，

  • chatroomAddresses: string[]

    聊天室地址列表

  • chatroomId: string

    聊天室 id

  • Optional debugLevel?: string

    日志分级

    可选值，"off" | "error" | "warn" | "log" | "debug"

  • Optional isAnonymous?: boolean

    是否为游客

  • Optional isFixedDeviceId?: boolean

    是否 deviceId 需要固定下来。默认 false。

    true：sdk 随机对设备生成一个设备标识并存入 localstorage 缓存起来，也就是说一个浏览器来说所有 SDK 实例连接都被认为是共同的设备。

    false：每一个 sdk 实例连接时，使用随机的字符串作为设备标识，相当于每个实例采用的不同的设备连接上来的。

    注意：这个参数会影响多端互踢的策略。有关于多端互踢策略的配置可以参见服务器文档。

  • Optional loginExt?: string

    登录自定义字段，用于提交给用户的第三方回调服务进行登录检测

  • Optional needReconnect?: boolean

    是否需要自动重连

  • Optional notifyTargetTags?: string

    登录登出等通知目标的标签，是一个标签表达式

  • Optional reconnectionAttempts?: number

    自动重连尝试次数

  • Optional tags?: string[]

    标签，可设置多个，仅代表本次登录

  • token: string

ChatroomOtherOptions

ChatroomOtherOptions: { cloudStorageConfig: { s3?: any } }

Type declaration

TKickedReason

TKickedReason: { message: string; reason: "unknow" | "chatroomClosed" | "managerKick" | "samePlatformKick" | "silentlyKick" | "blacked" }

Type declaration

  • message: string
  • reason: "unknow" | "chatroomClosed" | "managerKick" | "samePlatformKick" | "silentlyKick" | "blacked"

    未知 | 聊天室已经被解散 | 被管理员或踢了 | 多端被踢-不允许同一个帐号在多个地方同时登录 | 被悄悄踢掉, 表示这个链接已经废掉了 | 被拉黑了

TLoginedResult

TLoginedResult: { chatroom: Chatroom; member: ChatroomMember }

Type declaration

TWillReconnect

TWillReconnect: { duration: number; retryCount: number }

Type declaration

  • duration: number

    重试间隔

  • retryCount: number

    重试次数