nim/types

Index

Enumerations

NIMEnumClientType

Type Aliases

NIMClientType

NIMClientType: keyof typeof NIMEnumClientType

NIMCommonError

NIMCommonError: { code: number; event: NIMStrAnyObj; message: string }

IM 扩展的通用错误对象，继承自 Error。

Type declaration

code: number

通用错误码
event: NIMStrAnyObj

引发错误的事件
message: string

通用错误原因解释

NIMDefaultDoneFn

NIMDefaultDoneFn<T>: ((err: NIMCommonError | Error | NIMStrAnyObj | null, data: T, ...args: any[]) => void)

Type Parameters

T extends NIMStrAnyObj | string | number | void

Type declaration

- (err: NIMCommonError | Error | NIMStrAnyObj | null, data: T, ...args: any[]): void
- 默认的 done 回调形式
  
  Parameters
  - err: NIMCommonError | Error | NIMStrAnyObj | null
  - data: T
  - Rest ...args: any[]
  Returns void

NIMGetInstanceOptions

NIMGetInstanceOptions: { account: string; appKey: string; authType?: number; autoMarkRead?: boolean; customClientType?: string; customTag?: string; db?: boolean; dbLog?: boolean; debug?: boolean; defaultLink?: string; expire?: number; lbsBackup?: boolean; lbsBackupUrlsCustomer?: string[]; lbsUrl?: string; logLevel?: "debug" | "log" | "info" | "warn" | "error" | "off"; loginExt?: string; needReconnect?: boolean; nosScenes?: string; nosSurvivalTime?: number; quickReconnect?: boolean; reconnectionAttempts?: number; resetUnreadMode?: boolean; rollbackClearMsgsUnread?: boolean; rollbackDelMsgUnread?: boolean; syncBroadcastMsgs?: boolean; syncExtraTeamInfo?: boolean; syncFriendUsers?: boolean; syncFriends?: boolean; syncMsgReceipts?: boolean; syncRelations?: boolean; syncRoamingMsgs?: boolean; syncSessionUnread?: boolean; syncStickTopSessions?: boolean; syncSuperTeamRoamingMsgs?: boolean; syncSuperTeams?: boolean; syncTeams?: boolean; token: string; logFunc?: any; onAddSuperTeamMembers?: any; onAddTeamMembers?: any; onClearServerHistoryMsgs?: any; onCreateTeam?: any; onDeleteMsgSelf?: any; onDeleteQuickComment?: any; onDismissSuperTeam?: any; onDismissTeam?: any; onPinMsgChange?: any; onQuickComment?: any; onRemoveSuperTeamMembers?: any; onRemoveTeamMembers?: any; onSessionsWithMoreRoaming?: any; onStickTopSessions?: any; onSuperTeams?: any; onSyncCreateSuperTeam?: any; onSyncUpdateServerSession?: any; onTeamMsgReceipt?: any; onTransferSuperTeam?: any; onTransferTeam?: any; onUpdateSuperTeam?: any; onUpdateSuperTeamManagers?: any; onUpdateSuperTeamMember?: any; onUpdateSuperTeamMembersMute?: any; onUpdateTeam?: any; onUpdateTeamManagers?: any; onUpdateTeamMembersMute?: any; onblacklist?: any; onbroadcastmsg?: any; onbroadcastmsgs?: any; onconnect?: any; oncustomsysmsg?: any; ondisconnect?: any; onerror?: any; onfriends?: any; onloginportschange?: any; onmsg?: any; onmutelist?: any; onmyinfo?: any; onofflinecustomsysmsgs?: any; onofflinemsgs?: any; onofflinesysmsgs?: any; onpushevents?: any; onroamingmsgs?: any; onroamingsysmsgs?: any; onsessions?: any; onsynccreateteam?: any; onsyncdone?: any; onsyncfriendaction?: any; onsyncmarkinblacklist?: any; onsyncmarkinmutelist?: any; onsysmsg?: any; onsysmsgunread?: any; onteams?: any; onupdatemyinfo?: any; onupdatesession?: any; onupdatesessions?: any; onupdatesysmsg?: any; onupdatesysmsgunread?: any; onupdateteammember?: any; onupdateuser?: any; onusers?: any; onwillreconnect?: any; shouldCountNotifyUnread?: any; shouldIgnoreNotification?: any }

Type declaration

account: string

帐号 ID

注：应用内唯一
appKey: string

应用的 appKey

注：在云信管理后台查看
Optional authType?: number

账号 token 的认证类型，默认 0。形式有三种

0：token是固定的，只有主动调用接口修改才会更改

1：token是动态的，有过期时间。token过期后已登录状态的连接不受影响，但之后的登录（包括自动重连、正常的登录连接）需使用新token。对于自动重连场景，开发者可在onwillreconnect中，判断token是否过期，若过期可调用setOptions更新token

2：账号和 token 由开发者的服务校验，云信服务器收到登录请求后会转发至开发者服务器，并将其校验结果返回
Optional autoMarkRead?: boolean

是否自动标记消息为已收到，默认为 true
Optional customClientType?: string

自定义客户端类型，请设置大于 0 的整数

注：默认端类型只有 Web，PC，AOS，iOS，如果开发者需要加以更细致的类型区分，如微信小程序等环境，可用这个字段自行做映射。
Optional customTag?: string

客户端自定义tag。最大32个字符

注：这个字段常用于登录时，多端同步通知其他端登陆，开发者设置可用于区分。
Optional db?: boolean

是否使用 IM 业务数据库，默认 true

注：在支持数据库的浏览器上 SDK 会将消息，会话，群等数据缓存到 indexedDB 数据库中, 后续同步都是增量更新, 加快初始化同步速度。
Optional dbLog?: boolean

是否将日志存储到本地数据库，默认 true

注：若开启，日志会被存储到数据库中，后续可通过服务器 API 来按需拉取本地数据库中日志。

注2：日志数据库与 IM 业务数据库为两个数据库，互不影响。
Optional debug?: boolean
deprecated
是否开启调试, 如果开启调试, 将会在控制台输出一些log。

默认false不输出日志, 可以传true来开启日志。
Optional defaultLink?: string

默认的备用长连接地址

注：当 LBS 请求出错时，SDK会尝试该长连接地址，若不传此参数，默认将使用的云信的公网的备用地址。
Optional expire?: number

本地数据库中的日志的有效期，单位小时，默认72小时

注：当 dbLog 为 true 时生效。
Optional lbsBackup?: boolean

是否开启备用lbs，默认为 true

注：若开启，SDK会将备用的lbs地址存储到本地LocalStorage，当主lbs意外不可用时，会尝试请求备用lbs地址连接
Optional lbsBackupUrlsCustomer?: string[]

开发者自定义的备用 lbs 地址数组

注：举例如 ['https://address1', 'https://address2']，用于自行定义接口去代理 lbs 返回，防止运营商劫持。当主lbs意外不可用时，会尝试请求备用lbs地址连接，优先级比 localstorage 里缓存的低。
Optional lbsUrl?: string

默认使用的 LBS 连接地址

注：NIM 需要先请求 LBS 地址能得到长连接地址，再建立长连接。若不传此参数，默认将使用云信提供的公网地址。
Optional logLevel?: "debug" | "log" | "info" | "warn" | "error" | "off"

日志等级

枚举值 debug | log | info | warn | error | off，默认 off，设置对应的日志等级后，仅输出高于或等于对应等级的日志, off 关闭所有日志
Optional loginExt?: string

登录时的扩展字段

注：可抄送给开发者服务器，不会同步至其他端
Optional needReconnect?: boolean

是否开启自动重连，默认 true

注：若长连接因为网络，心跳超时等原因断开，sdk 提供能力能够自动尝试重连。

注2：重连的时间间隔从 1.6～8s 之间累加，每次重连将触发 onwillreconnect 事件
Optional nosScenes?: string

上传文件存储全局配置-存储场景。

注：相当于使用的网易云存储的桶名，默认 “im”。
Optional nosSurvivalTime?: number

上传文件存储全局配置-存储有效时间。

注：默认 Infinity，设置的时间不得小于一天，单位秒
Optional quickReconnect?: boolean

是否开启快速自动重连，默认 false。

注：只有当 needReconnect: true 时该配置才有效。

注2：启用这个能力时，sdk 将会监听 window 的 offline 和 online 事件来嗅探网络断开和恢复，将会做相应的断开和重连策略
Optional reconnectionAttempts?: number

SDK 尝试重连的最大次数，超过后则不再尝试重连。

注：当重连尝试达到最大次数，将结束重连过程，最终触发 ondisconnect 回调，表示彻底断开。
Optional resetUnreadMode?: boolean

重置会话未读数时，若同步至服务器失败，是否仅重置本地会话未读数。

当同步至服务器失败时，若为 true，则本地未读数会被重置，服务器和其他端的未读数不会；若为false，则本地、服务器和其他端都不会被重置（重置失败），各端未读数会保持一致
Optional rollbackClearMsgsUnread?: boolean

清除会话的消息时会去同时更新会话的未读数与最近一条消息，默认 true
Optional rollbackDelMsgUnread?: boolean

撤回消息后是否更新该消息影响的会话未读数，默认 false

注：如某会话有两条消息未读，然后其中一条消息被撤回了，若该参数为true，则会话未读数变为 1，否则未读数仍是 2
Optional syncBroadcastMsgs?: boolean

是否同步离线广播，默认 false

注：若同步，初始化同步结束后收到 onbroadcastmsgs 回调
Optional syncExtraTeamInfo?: boolean

是否同步额外的群信息, 默认 true

注：若同步，则初始化同步接收群列表的额外信息，结束后收到 onteams 回调。

注2: 这里的“额外信息”举个例子，当前登录用户开启某个群的消息提醒 (SDK 只是存储了此信息, 具体用此信息来做什么事情完全由开发者控制)，开发者调用接口 updateInfoInTeam 来设置
Optional syncFriendUsers?: boolean

是否同步好友对应的用户名片列表, 默认true

注：若同步，则初始化同步接收好友所对应的用户信息，结束后收到 onusers 回调
Optional syncFriends?: boolean

是否同步好友列表, 默认 true.

注：若同步，则初始化同步接收好友信息，结束后收到 onfriends 回调
Optional syncMsgReceipts?: boolean

是否同步已读回执时间戳, 默认 true.
Optional syncRelations?: boolean

是否同步黑名单和静音列表, 默认true.

注：若同步，则初始化同步接收黑名单和静音列表，结束后收到 onblacklist 回调和 onmutelist 回调
Optional syncRoamingMsgs?: boolean

是否同步漫游消息, 默认 true.

注：若同步，则初始化同步结束后收到 onroamingmsgs 回调.
Optional syncSessionUnread?: boolean

是否同步会话的未读数, 默认 false

注：未读数即 session 的 unread 属性。
Optional syncStickTopSessions?: boolean

是否同步云端置顶会话信息，默认 false

注：初始化同步云端置顶会话信息可以通过 onStickTopSessions 回调获取，且附带在 session 定义的 isTop 属性中。
Optional syncSuperTeamRoamingMsgs?: boolean

是否额外同步超大群的漫游消息, 默认 true.

注：若同步，则初始化同步结束后收到 onroamingmsgs 回调.
Optional syncSuperTeams?: boolean

是否同步超大群列表, 默认true

注：若同步，则初始化同步接收超级群列表，结束后收到 onSuperTeams 回调
Optional syncTeams?: boolean

是否同步群列表, 默认 true.

注：若同步，则初始化同步接收群列表，结束后收到 onteams 回调
token: string

帐号的登录凭证

注：只会在初始化登录建立连接时会校验一次
logFunc?:function
- logFunc(...args: (string | NIMStrAnyObj)[]): void
- 是否对日志做额外的处理，诸如日志存储、日志上报等等，该函数会截获console日志的参数，供开发者使用
  
  Parameters
  - Rest ...args: (string | NIMStrAnyObj)[]
  Returns void
onAddSuperTeamMembers?:function
- onAddSuperTeamMembers(data: NIMOnAddSuperTeamMembersResult): void
- 钩子函数-(在线, 多端同步)收到了添加超级群成员的通知
  
  Parameters
  - data: NIMOnAddSuperTeamMembersResult
  Returns void
onAddTeamMembers?:function
- onAddTeamMembers(data: NIMOnAddTeamMembersResult): void
- 钩子函数-(在线, 多端同步)收到了添加群成员的通知
  
  Parameters
  - data: NIMOnAddTeamMembersResult
  Returns void
onClearServerHistoryMsgs?:function
- onClearServerHistoryMsgs(data: { sessionId: string; time: number }): void
- 钩子函数-(多端同步、初始化同步)收到清除会话历史消息的回调
  
  注: 传入被删除的 sessionId 以及删除时间
  
  Parameters
  - data: { sessionId: string; time: number }
    - sessionId: string
    - time: number
  Returns void
onCreateTeam?:function
- onCreateTeam(data: NIMTeam): void
- 钩子函数-(在线, 多端同步)收到了创建群的通知
  
  Parameters
  - data: NIMTeam
  Returns void
onDeleteMsgSelf?:function
- onDeleteMsgSelf(data: NIMOnDeleteMsgSelfResult): void
- 钩子函数-(多端同步)收到单向删除消息的回调
  
  Parameters
  - data: NIMOnDeleteMsgSelfResult
  Returns void
onDeleteQuickComment?:function
- onDeleteQuickComment(data: Pick<NIMMessage, "scene" | "from" | "time" | "idServer" | "idClient">, comment: NIMQuickComment): void
- 钩子函数-(在线, 多端同步)收到了删除快捷评论的回调
  
  Parameters
  - data: Pick<NIMMessage, "scene" | "from" | "time" | "idServer" | "idClient">
  - comment: NIMQuickComment
  Returns void
onDismissSuperTeam?:function
- onDismissSuperTeam(data: { teamId: string }): void
- 钩子函数-(在线, 多端同步)收到了解散超级群的通知
  
  Parameters
  - data: { teamId: string }
    - teamId: string
  Returns void
onDismissTeam?:function
- onDismissTeam(data: { teamId: string }): void
- 钩子函数-(在线, 多端同步)收到了解散群的通知
  
  Parameters
  - data: { teamId: string }
    - teamId: string
  Returns void
onPinMsgChange?:function
- onPinMsgChange(data: NIMOnPinMsgChangeResult, action: "add" | "update" | "delete"): void
- 钩子函数-(在线, 多端同步)收到了 pin msg 通知的回调
  
  Parameters
  - data: NIMOnPinMsgChangeResult
  - action: "add" | "update" | "delete"
  Returns void
onQuickComment?:function
- onQuickComment(data: Pick<NIMMessage, "scene" | "from" | "time" | "idServer" | "idClient">, comment: NIMQuickComment): void
- 钩子函数-(在线, 多端同步)收到了添加快捷评论的回调
  
  Parameters
  - data: Pick<NIMMessage, "scene" | "from" | "time" | "idServer" | "idClient">
  - comment: NIMQuickComment
  Returns void
onRemoveSuperTeamMembers?:function
- onRemoveSuperTeamMembers(data: NIMOnRemoveSuperTeamMembersResult): void
- 钩子函数-(在线, 多端同步)收到了删除超级群成员的通知
  
  注: 开发者需要判定 data 里 account 是否包含本账号, 来处理本账号被踢出群的情况.
  
  Parameters
  - data: NIMOnRemoveSuperTeamMembersResult
  Returns void
onRemoveTeamMembers?:function
- onRemoveTeamMembers(data: NIMOnRemoveTeamMembersResult): void
- 钩子函数-(在线, 多端同步)收到了删除群成员的通知
  
  注: 开发者需要判定 data 里 account 是否包含本账号, 来处理本账号被踢出群的情况.
  
  Parameters
  - data: NIMOnRemoveTeamMembersResult
  Returns void
onSessionsWithMoreRoaming?:function
- onSessionsWithMoreRoaming(datas: NIMSession[]): void
- 钩子函数-(初始化同步)收到会话仍有更多的漫游消息回调
  
  注：其中的 session.time 之前的时间里，仍有超过未漫游下来的消息。开发者可以进入会话时，通过获取历史消息再拉取消息。
  
  Parameters
  - datas: NIMSession[]
  Returns void
onStickTopSessions?:function
- onStickTopSessions(datas: NIMSession[]): void
- 钩子函数-(初始化同步/在线)收到远端置顶会话回调
  
  Parameters
  - datas: NIMSession[]
  Returns void
onSuperTeams?:function
- onSuperTeams(datas: NIMSuperTeam[]): void
- 钩子函数-(初始化同步)收到了超级群列表
  
  Parameters
  - datas: NIMSuperTeam[]
  Returns void
onSyncCreateSuperTeam?:function
- onSyncCreateSuperTeam(datas: NIMSuperTeam[]): void
- 钩子函数-(多端同步)收到了创建超级群的通知
  
  Parameters
  - datas: NIMSuperTeam[]
  Returns void
onSyncUpdateServerSession?:function
- onSyncUpdateServerSession(data: NIMCloudSession): void
- 钩子函数-(多端同步)收到了 cloud session 云端会话的更新通知
  
  Parameters
  - data: NIMCloudSession
  Returns void
onTeamMsgReceipt?:function
- onTeamMsgReceipt(data: NIMOnTeamMsgReceiptResult): void
- 钩子函数-(在线)收到群消息标记 receipt 的通知
  
  Parameters
  - data: NIMOnTeamMsgReceiptResult
  Returns void
onTransferSuperTeam?:function
- onTransferSuperTeam(data: NIMOnTransferSuperTeamResult): void
- 钩子函数-(在线, 多端同步)收到了转让超级群的通知
  
  Parameters
  - data: NIMOnTransferSuperTeamResult
  Returns void
onTransferTeam?:function
- onTransferTeam(data: NIMOnTransferTeamResult): void
- 钩子函数-(在线, 多端同步)收到了转让群的通知
  
  Parameters
  - data: NIMOnTransferTeamResult
  Returns void
onUpdateSuperTeam?:function
- onUpdateSuperTeam(data: Pick<NIMSuperTeam, "custom" | "announcement" | "avatar" | "intro" | "name" | "teamId" | "updateTime">): void
- 钩子函数-(在线, 多端同步)收到了更新超级群的通知
  
  Parameters
  - data: Pick<NIMSuperTeam, "custom" | "announcement" | "avatar" | "intro" | "name" | "teamId" | "updateTime">
  Returns void
onUpdateSuperTeamManagers?:function
- onUpdateSuperTeamManagers(data: NIMOnUpdateSuperTeamManagersResult): void
- 钩子函数-(在线, 多端同步)收到了更新超级群管理员的通知
  
  Parameters
  - data: NIMOnUpdateSuperTeamManagersResult
  Returns void
onUpdateSuperTeamMember?:function
- onUpdateSuperTeamMember(data: Pick<NIMSuperTeamMember, "custom" | "teamId" | "updateTime" | "account" | "id" | "muteNotiType" | "muteTeam" | "nickInTeam">): void
- 钩子函数-(在线, 多端同步)收到了超级群成员的信息变更
  
  Parameters
  - data: Pick<NIMSuperTeamMember, "custom" | "teamId" | "updateTime" | "account" | "id" | "muteNotiType" | "muteTeam" | "nickInTeam">
  Returns void
onUpdateSuperTeamMembersMute?:function
- onUpdateSuperTeamMembersMute(data: NIMOnUpdateSuperTeamMembersMuteResult): void
- 钩子函数-(在线, 多端同步)收到了超级群成员被静音的通知
  
  Parameters
  - data: NIMOnUpdateSuperTeamMembersMuteResult
  Returns void
onUpdateTeam?:function
- onUpdateTeam(data: Pick<NIMTeam, "custom" | "announcement" | "avatar" | "intro" | "name" | "teamId" | "updateTime">): void
- 钩子函数-(在线, 多端同步)收到了更新群的通知
  
  Parameters
  - data: Pick<NIMTeam, "custom" | "announcement" | "avatar" | "intro" | "name" | "teamId" | "updateTime">
  Returns void
onUpdateTeamManagers?:function
- onUpdateTeamManagers(data: NIMOnUpdateTeamManagersResult): void
- 钩子函数-(在线, 多端同步)收到了更新群管理员的通知
  
  Parameters
  - data: NIMOnUpdateTeamManagersResult
  Returns void
onUpdateTeamMembersMute?:function
- onUpdateTeamMembersMute(data: NIMOnUpdateTeamMembersMuteResult): void
- 钩子函数-(在线, 多端同步)收到了群成员被静音的通知
  
  Parameters
  - data: NIMOnUpdateTeamMembersMuteResult
  Returns void
onblacklist?:function
- onblacklist(datas: NIMMarkedUserInfo[]): void
- 钩子函数-(初始化同步)收到了黑名单列表
  
  Parameters
  - datas: NIMMarkedUserInfo[]
  Returns void
onbroadcastmsg?:function
- onbroadcastmsg(data: NIMBroadcastMessage): void
- 钩子函数-(在线)收到广播消息
  
  Parameters
  - data: NIMBroadcastMessage
  Returns void
onbroadcastmsgs?:function
- onbroadcastmsgs(datas: NIMBroadcastMessage[]): void
- 钩子函数-(初始化同步)收到广播消息
  
  Parameters
  - datas: NIMBroadcastMessage[]
  Returns void
onconnect?:function
- onconnect(data: NIMOnConnectResult): void
- 钩子函数-连接建立后的回调
  
  Parameters
  - data: NIMOnConnectResult
  Returns void
oncustomsysmsg?:function
- oncustomsysmsg(data: NIMSystemMessage): void
- 钩子函数-(在线)收到了自定义的系统消息
  
  注：自定义系统消息不存本地数据库，会直接回调透传给开发者
  
  Parameters
  - data: NIMSystemMessage
  Returns void
ondisconnect?:function
- ondisconnect(data: NIMOnDisconnectResult): void
- 钩子函数-断开链接的回调
  
  Parameters
  - data: NIMOnDisconnectResult
  Returns void
onerror?:function
- onerror(data: NIMStrAnyObj): void
- 钩子函数-发生错误的回调
  
  注：这里指的错误，通常是数据库的错误。也有少部分情况是连接时的，建议开发者做个收集。
  
  Parameters
  - data: NIMStrAnyObj
  Returns void
onfriends?:function
- onfriends(datas: NIMFriendProfile[]): void
- 同步好友列表的回调, 会传入好友列表。
  
  Parameters
  - datas: NIMFriendProfile[]
  Returns void
onloginportschange?:function
- onloginportschange(datas: NIMOnLoginPortsChangeResult[]): void
- 多端登录状态变化的回调, 会收到登录端列表, 以下情况会收到此回调
  1. 登录时其它端在线
  2. 登录后其它端上线或者下线
  Parameters
  - datas: NIMOnLoginPortsChangeResult[]
  Returns void
onmsg?:function
- onmsg(data: NIMMessage): void
- 钩子函数-(多端同步/在线)收到消息的回调
  
  Parameters
  - data: NIMMessage
  Returns void
onmutelist?:function
- onmutelist(datas: NIMMarkedUserInfo[]): void
- 钩子函数-(初始化同步)收到了静音列表
  
  Parameters
  - datas: NIMMarkedUserInfo[]
  Returns void
onmyinfo?:function
- onmyinfo(data: NIMUserNameCard): void
- 钩子函数-(初始化同步)收到了自己的用户名片
  
  Parameters
  - data: NIMUserNameCard
  Returns void
onofflinecustomsysmsgs?:function
- onofflinecustomsysmsgs(datas: NIMSystemMessage[]): void
- 钩子函数-(初始化同步)收到了离线的自定义的系统消息
  
  注：自定义系统消息不存本地数据库，会直接回调透传给开发者
  
  Parameters
  - datas: NIMSystemMessage[]
  Returns void
onofflinemsgs?:function
- onofflinemsgs(datas: NIMMessage[]): void
- 钩子函数-(初始化同步)收到离线消息的回调
  
  Parameters
  - datas: NIMMessage[]
  Returns void
onofflinesysmsgs?:function
- onofflinesysmsgs(datas: NIMSystemMessage[]): void
- 钩子函数-(初始化同步)收到离线的系统消息的回调
  
  Parameters
  - datas: NIMSystemMessage[]
  Returns void
onpushevents?:function
- onpushevents(result: { msgEvents: NIMPushEventInfo[] }): void
- 钩子函数-(初始化同步，在线)收到下推的事件服务的回调
  
  Parameters
  - result: { msgEvents: NIMPushEventInfo[] }
    - msgEvents: NIMPushEventInfo[]
  Returns void
onroamingmsgs?:function
- onroamingmsgs(datas: NIMMessage[]): void
- 钩子函数-(初始化同步)收到漫游消息回调
  
  注：初始化同步会触发多次这个事件，每一个会话触发一次。
  
  Parameters
  - datas: NIMMessage[]
  Returns void
onroamingsysmsgs?:function
- onroamingsysmsgs(datas: NIMSystemMessage[]): void
- 钩子函数-(初始化同步)收到漫游的系统消息的回调
  
  Parameters
  - datas: NIMSystemMessage[]
  Returns void
onsessions?:function
- onsessions(datas: NIMSession[]): void
- 钩子函数-(初始化同步)收到了会话列表
  
  Parameters
  - datas: NIMSession[]
  Returns void
onsynccreateteam?:function
- onsynccreateteam(data: NIMTeam): void
- 钩子函数-(多端同步)收到了创建群的通知
  
  注: 这个钩子函数被触发后，紧接着触发 onCreateTeam。
  
  Parameters
  - data: NIMTeam
  Returns void
onsyncdone?:function
- onsyncdone(): void
- 钩子函数-初始化同步完成的回调
  
  注：推荐开发者在此阶段后再调用实例对象的 API。
  
  Returns void
onsyncfriendaction?:function
- onsyncfriendaction(data: NIMOnSyncFriendActionResult): void
- 钩子函数-(多端同步)收到了好友动作
  
  Parameters
  - data: NIMOnSyncFriendActionResult
  Returns void
onsyncmarkinblacklist?:function
- onsyncmarkinblacklist(data: NIMMarkedUserResult): void
- 钩子函数-(多端同步)收到了拉黑/移出黑名单的事件
  
  Parameters
  - data: NIMMarkedUserResult
  Returns void
onsyncmarkinmutelist?:function
- onsyncmarkinmutelist(data: NIMMarkedUserResult): void
- 钩子函数-(多端同步)收到了把某人静音的事件
  
  Parameters
  - data: NIMMarkedUserResult
  Returns void
onsysmsg?:function
- onsysmsg(data: NIMSystemMessage): void
- 钩子函数-(在线)收到系统消息的回调
  
  Parameters
  - data: NIMSystemMessage
  Returns void
onsysmsgunread?:function
- onsysmsgunread(data: NIMSystemMessageUnreadInfo): void
- 钩子函数-(初始化同步)收到了系统消息未读数
  
  注: 这是本地端测维护的未读数，只统计了本次登录期间内所收到的未读数。
  
  Parameters
  - data: NIMSystemMessageUnreadInfo
  Returns void
onteams?:function
- onteams(datas: NIMTeam[]): void
- 钩子函数-(初始化同步)收到了群列表
  
  Parameters
  - datas: NIMTeam[]
  Returns void
onupdatemyinfo?:function
- onupdatemyinfo(data: NIMUserNameCard): void
- 钩子函数-(多端同步)收到了自己的用户名片更新
  
  Parameters
  - data: NIMUserNameCard
  Returns void
onupdatesession?:function
- onupdatesession(data: NIMSession): void
- deprecated
  please use {@link NIMGetInstanceOptions.onupdatesessions | onupdatesessions} instead
  
  钩子函数-(在线)更新会话的回调
  
  触发条件包括：收发消息，清理了会话未读数，撤回消息等。
  
  Parameters
  - data: NIMSession
  Returns void
onupdatesessions?:function
- onupdatesessions(datas: NIMSession[]): void
- 钩子函数-(在线)批量更新会话的回调
  
  触发条件包括：收发消息，清理了会话未读数，撤回消息等。
  
  注: v8.2.0 引入，为了解决高频次回调的问题
  
  Parameters
  - datas: NIMSession[]
  Returns void
onupdatesysmsg?:function
- onupdatesysmsg(data: NIMSystemMessage): void
- 钩子函数-(在线)收到系统消息的更新的回调
  
  注：触发更新的条件有：通过或者拒绝好友申请、接收或者拒绝入群申请、通过或者拒绝入群邀请。
  
  Parameters
  - data: NIMSystemMessage
  Returns void
onupdatesysmsgunread?:function
- onupdatesysmsgunread(data: NIMSystemMessageUnreadInfo): void
- 钩子函数-(在线)收到了系统消息未读数变更
  
  注: 这是本地端测维护的未读数，只统计了本次登录期间内所收到的未读数。
  
  Parameters
  - data: NIMSystemMessageUnreadInfo
  Returns void
onupdateteammember?:function
- onupdateteammember(data: Pick<NIMTeamMember, "custom" | "teamId" | "updateTime" | "account" | "id" | "muteNotiType" | "muteTeam" | "nickInTeam">): void
- 钩子函数-(在线, 多端同步)收到了群成员的信息变更
  
  Parameters
  - data: Pick<NIMTeamMember, "custom" | "teamId" | "updateTime" | "account" | "id" | "muteNotiType" | "muteTeam" | "nickInTeam">
  Returns void
onupdateuser?:function
- onupdateuser(data: NIMUserNameCard): void
- 钩子函数-(在线)接收消息后，发线聊天对象有用户名片上的信息更新，触发回调。
  
  Parameters
  - data: NIMUserNameCard
  Returns void
onusers?:function
- onusers(datas: NIMUserNameCard[]): void
- 钩子函数-(初始化同步)收到了好友的用户名片
  
  Parameters
  - datas: NIMUserNameCard[]
  Returns void
onwillreconnect?:function
- onwillreconnect(data: NIMOnWillReconnectResult): void
- 钩子函数-即将重连的回调
  
  注：此时说明 SDK 已经断开连接, 请开发者在界面上提示用户连接已断开, 而且正在重新建立连接
  
  Parameters
  - data: NIMOnWillReconnectResult
  Returns void
shouldCountNotifyUnread?:function
- shouldCountNotifyUnread(notification: NIMMessage): void
- 钩子函数-判定通知类消息是否该计入会话的未读数. 默认都返回 false
  
  注：该方法接收一个通知消息，如果函数结果返回 true，则将该通知消息计入未读数，否则不计入未读数。
  
  Parameters
  - notification: NIMMessage
  Returns void
shouldIgnoreNotification?:function
- shouldIgnoreNotification(notification: NIMMessage): void
- 钩子函数-判定通知类消息是否要忽略会话的更新。默认都返回 false
  
  注：该方法接收一个通知消息，如果函数结果返回 true，则将该通知消息计入未读数，否则不计入未读数。
  
  Parameters
  - notification: NIMMessage
  Returns void

NIMOnConnectResult

NIMOnConnectResult: { connectionId: string; country?: string; customTag?: string; ip: string; lastLoginDeviceId: string; port: string }

Type declaration

connectionId: string

本次登录的连接号
Optional country?: string

地区
Optional customTag?: string

客户端自定义tag,登录时多端同步改字段，最大32个字符
ip: string

IP 地址
lastLoginDeviceId: string

上次登录的设备的设备号
port: string

端口

NIMOnDisconnectResult

NIMOnDisconnectResult: NIMOnDisconnectResultKicked | NIMOnDisconnectResultOffline | NIMOnDisconnectResultOther

NIMOnDisconnectResultKicked

NIMOnDisconnectResultKicked: { code: "kicked"; custom: string; customClientType: number; from: NIMClientType; message: string; reason: string }

Type declaration

code: "kicked"

状态码
custom: string

扩展字段
customClientType: number

自定义端测类型
from: NIMClientType

客户端类型
message: string

原因描述
reason: string

原因简述

samePlatformKick: 不允许同一个帐号在多个地方同时登录 serverKick: 被服务器踢了 otherPlatformKick: 被其它端踢了

NIMOnDisconnectResultOffline

NIMOnDisconnectResultOffline: { callFunc: string; code: string; message: string }

Type declaration

callFunc: string

出处提示
code: string

断开的错误码。

manuallyDisconnect 为主动断开 offlineListener 为侦听到网络变化断开 allAttemptsFailed 为尝试完毕所有的重连次数而断开。
message: string

原因描述

NIMOnDisconnectResultOther

NIMOnDisconnectResultOther: { code: number; message: string }

Type declaration

code: number

状态码
message: string

原因描述

NIMOnLoginPortsChangeResult

NIMOnLoginPortsChangeResult: { account: string; connectionId: number; deviceId: string; ip: string; mac: string; online: boolean; os: string; time: number; type: string }

Type declaration

account: string

登录的帐号
connectionId: number

登录设备的连接号
deviceId: string

登录设备 ID
ip: string

登录的服务器 IP
mac: string

登录设备的 mac 地址
online: boolean

是否在线
os: string

登录设备的操作系统
time: number

登录时间
type: string

登录的设备类型

NIMOnWillReconnectResult

NIMOnWillReconnectResult: { duration: number; retryCount: number }

Type declaration

duration: number

重试间隔
retryCount: number

重试次数

NIMStrAnyObj

NIMStrAnyObj: {}

Type declaration

[key: string]: any

Index

Enumerations

Type Aliases

Type Aliases

NIMClientType

NIMCommonError

Type declaration

code: number

event: NIMStrAnyObj

message: string

NIMDefaultDoneFn

Type Parameters

T extends NIMStrAnyObj | string | number | void

Type declaration

Parameters

err: NIMCommonError | Error | NIMStrAnyObj | null

data: T

Rest ...args: any[]

Returns void

NIMGetInstanceOptions

Type declaration

account: string

appKey: string

Optional authType?: number

Optional autoMarkRead?: boolean

Optional customClientType?: string

Optional customTag?: string

Optional db?: boolean

Optional dbLog?: boolean

Optional debug?: boolean

Optional defaultLink?: string

Optional expire?: number

Optional lbsBackup?: boolean

Optional lbsBackupUrlsCustomer?: string[]

Optional lbsUrl?: string

Optional logLevel?: "debug" | "log" | "info" | "warn" | "error" | "off"

Optional loginExt?: string

Optional needReconnect?: boolean

Optional nosScenes?: string

Optional nosSurvivalTime?: number

Optional quickReconnect?: boolean

Optional reconnectionAttempts?: number

Optional resetUnreadMode?: boolean

Optional rollbackClearMsgsUnread?: boolean

Optional rollbackDelMsgUnread?: boolean

Optional syncBroadcastMsgs?: boolean

Optional syncExtraTeamInfo?: boolean

Optional syncFriendUsers?: boolean

Optional syncFriends?: boolean

Optional syncMsgReceipts?: boolean

Optional syncRelations?: boolean

Optional syncRoamingMsgs?: boolean

Optional syncSessionUnread?: boolean

Optional syncStickTopSessions?: boolean

Optional syncSuperTeamRoamingMsgs?: boolean

Optional syncSuperTeams?: boolean

Optional syncTeams?: boolean

token: string

logFunc?:function

Parameters

Rest ...args: (string | NIMStrAnyObj)[]

Returns void

onAddSuperTeamMembers?:function

Parameters

data: NIMOnAddSuperTeamMembersResult

Returns void

onAddTeamMembers?:function

Parameters

data: NIMOnAddTeamMembersResult

Returns void

onClearServerHistoryMsgs?:function

Parameters

data: { sessionId: string; time: number }

sessionId: string

time: number

Returns void

onCreateTeam?:function

Parameters

data: NIMTeam

Returns void