SessionInterface

Hierarchy

SessionInterface

Implemented by

Methods

addStickTopSession

addStickTopSession(options: { id: string; topCustom?: string; done: any }): void

添加云端置顶的会话。下次登录时，在初始化回调函数 onStickTopSessions 接收置顶会话列表。调用后，当前账户所有登录用户收到 onupdatesessions 回调
关联函数
Parameters
- options: { id: string; topCustom?: string; done: any }
  - id: string
    
    sessionId
    
    例如 p2p-cs1、team-113879441
  - Optional topCustom?: string
    
    云端置顶会话的扩展字段
  - done:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: { stickTopSession: NIMSession }): void
    - Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      - data: { stickTopSession: NIMSession }
        stickTopSession: NIMSession
      Returns void
Returns void

deleteLocalSession

deleteLocalSession(options: { id: string; isDeleteRoaming?: boolean; isLogic?: boolean; done?: any }): void

删除指定的本地数据库会话。以及可选删除服务器上漫游消息。
关联函数
- MessageLogInterface.clearServerHistoryMsgsWithSync 删除历史消息(以及漫游消息)
示例场景
- 群成员管理
Parameters
- options: { id: string; isDeleteRoaming?: boolean; isLogic?: boolean; done?: any }
  
  入参
  - id: string
    
    会话 id
  - Optional isDeleteRoaming?: boolean
    
    是否需要删除此会话的服务器漫游消息, 默认 false。8.2.0 版本新增，写 true 的话，下次登录服务器不再下发此会话的漫游消息，此规则会影响多端登录的其他端，慎用。
  - Optional isLogic?: boolean
    
    是否为逻辑删除, 默认 false。7.9.1 版本新增，逻辑删除不会真的删除本地会话，而是标记会话为“已删除”状态，这样可以保留会话的unread和msgReceiptTime，下次新建该会话时，可以保持正确的未读数和已读时间戳
  - done?:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: NIMSession): void
    - Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      - data: NIMSession
      Returns void
Returns void

deleteSession

deleteSession(options: { scene: "p2p" | "team" | "superTeam"; to: string; done?: any }): void

deprecated
已废弃。推荐开发者调用 deleteLocalSession 和 clearServerHistoryMsgsWithSync

Parameters
- options: { scene: "p2p" | "team" | "superTeam"; to: string; done?: any }
  - scene: "p2p" | "team" | "superTeam"
  - to: string
  - done?:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj): void
    - Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      Returns void
Returns void

deleteSessions

deleteSessions(options: { sessions: NIMSession[]; done?: any }): void

deprecated
已废弃。推荐开发者调用 deleteLocalSession 和 clearServerHistoryMsgsWithSync

Parameters
- options: { sessions: NIMSession[]; done?: any }
  - sessions: NIMSession[]
  - done?:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj): void
    - Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      Returns void
Returns void

deleteSessionsWithMoreRoaming

deleteSessionsWithMoreRoaming(options: { id: string; done?: any }): void

deprecated
已废弃。根据会话 id 删除漫游消息不全的会话

Parameters
- options: { id: string; done?: any }
  - id: string
    
    会话 id
  - done?:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: NIMStrAnyObj): void
    - Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      - data: NIMStrAnyObj
      Returns void
Returns void

deleteStickTopSession

deleteStickTopSession(options: { id: string; done: any }): void

取消云端置顶的会话。下次登录时，在初始化回调函数 onStickTopSessions 接收置顶会话列表。调用后，当前账户所有登录用户收到 onupdatesessions 回调
关联函数
Parameters
- options: { id: string; done: any }
  - id: string
    
    sessionId
    
    例如 p2p-cs1、team-113879441
  - done:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: { stickTopSession: NIMSession }): void
    - Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      - data: { stickTopSession: NIMSession }
        stickTopSession: NIMSession
      Returns void
Returns void

getLocalSession

getLocalSession(options: { sessionId: string; done: any }): void

通过 sessionId 获取本地数据库里的会话

Parameters
- options: { sessionId: string; done: any }
  - sessionId: string
    
    即 session.id
  - done:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: undefined | NIMSession): void
    - Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      - data: undefined | NIMSession
      Returns void
Returns void

getLocalSessions

getLocalSessions(options: { lastSessionId?: string; limit?: number; reverse?: boolean; done: any }): void

分页查询会话列表
示例场景
- 会话排序(开启db)
Parameters
- options: { lastSessionId?: string; limit?: number; reverse?: boolean; done: any }
  - Optional lastSessionId?: string
    
    上一页最后一条会话的 id，第一次查询可以不填。
  - Optional limit?: number
    
    分页查询数量限制，默认 100 条记录
  - Optional reverse?: boolean
    
    查询顺序
    
    false 从最早的会话开始查找
    
    true 从最晚的会话开始查找
  - done:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: { sessions: NIMSession[] }): void
    - Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      - data: { sessions: NIMSession[] }
        sessions: NIMSession[]
      Returns void
Returns void

getLocalSessionsByMsgType

getLocalSessionsByMsgType(options: NIMStrAnyObj): void

deprecated
已废弃。请使用 SessionInterface.getLocalSessions

Parameters
- options: NIMStrAnyObj
Returns void

getSessionsWithMoreRoaming

getSessionsWithMoreRoaming(options: { id: string; done?: any }): void

deprecated
已废弃.查询漫游消息不全的会话/会话列表

Parameters
- options: { id: string; done?: any }
  - id: string
    
    会话 id
  - done?:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: NIMStrAnyObj): void
    - Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      - data: NIMStrAnyObj
      Returns void
Returns void

getStickTopSessions

getStickTopSessions(options: { done: any }): void

获取云端置顶会话的列表

Parameters
- options: { done: any }
  - done:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: NIMSession[]): void
    - Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      - data: NIMSession[]
      Returns void
Returns void

insertLocalSession

insertLocalSession(options: { scene: "p2p" | "team" | "superTeam"; to: string; done?: any }): void

往本地数据库 indexdb 中插入一个会话
- 如果不支持数据库, 则会在 sdk 内存中插入一条会话。不推荐没有 db 时使用该函数。用户应该在自己的内存数据中维护会话列表。
- 如果会话已存在, 那么会返回错误
- 如果有对应会话的本地历史消息, 那么会更新会话的 lastMsg 为最后一条消息
- 插入成功后, 会触发onupdatesession回调
Parameters
- options: { scene: "p2p" | "team" | "superTeam"; to: string; done?: any }
  - scene: "p2p" | "team" | "superTeam"
  - to: string
  - done?:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: NIMSession): void
    - Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      - data: NIMSession
      Returns void
Returns void

resetAllSessionUnread

resetAllSessionUnread(): void

重置所有会话的未读数。
注意
- 初始化参数 NIMGetInstanceOptions.syncSessionUnread = true时，该函数会同步未读数至服务器，否则仅影响内存中的session。
- 调用该函数后，会触发 NIMGetInstanceOptions.onupdatesessions 回调函数
Returns void

resetCurrSession

resetCurrSession(sessionId: string): void

取消 “setCurrSession” 的效果。取消后，会话收到消息后，未读数会变更。
关联函数
- SessionInterface.setCurrSession
Parameters
- sessionId: string
Returns void

resetSessionUnread

resetSessionUnread(sessionId: string, done: (err: null | Error, failedSessionId: string) => void): void

重置某个会话的未读数。重置超级群未读数请使用 SessionInterface.resetSuperTeamSessionsUnread。
注意
- 初始化参数 NIMGetInstanceOptions.syncSessionUnread = true时，该函数会同步未读数至服务器，否则仅影响内存中的session。
- 调用该函数后，会触发 NIMGetInstanceOptions.onupdatesessions 回调函数
Parameters
- sessionId: string
- done: (err: null | Error, failedSessionId: string) => void
  - - (err: null | Error, failedSessionId: string): void
    - Parameters
      - err: null | Error
      - failedSessionId: string
      Returns void
Returns void

resetSessionsUnread

resetSessionsUnread(sessionIds: string[], done: (err: null | Error) => void): Promise<void>

重置某些会话的未读数。重置超级群未读数请使用 SessionInterface.resetSuperTeamSessionsUnread
注意
- 初始化参数 NIMGetInstanceOptions.syncSessionUnread = true时，该函数会同步未读数至服务器，否则仅影响内存中的session。
- 调用该函数后，会触发 NIMGetInstanceOptions.onupdatesessions 回调函数
Parameters
- sessionIds: string[]
- done: (err: null | Error) => void
  - - (err: null | Error): void
    - Parameters
      - err: null | Error
      Returns void
Returns Promise<void>

resetSuperTeamSessionsUnread

resetSuperTeamSessionsUnread(sessionIds: string[], done: (err: null | Error) => void): Promise<void>

重置某些超级群的会话的未读数
注意
- 初始化参数 NIMGetInstanceOptions.syncSessionUnread = true时，该函数会同步未读数至服务器，否则仅影响内存中的session。
- 调用该函数后，会触发 NIMGetInstanceOptions.onupdatesessions 回调函数
Parameters
- sessionIds: string[]
- done: (err: null | Error) => void
  - - (err: null | Error): void
    - Parameters
      - err: null | Error
      Returns void
Returns Promise<void>

setCurrSession

setCurrSession(sessionId: string): void

设置“进入当前会话”
注：这是 sdk 的一个便于操作的复合接口，做的逻辑有：在内存里记录当前进入的会话，进入会话时调用 resetSessionUnread 清空未读，且后续 onMsg 接收新消息时 resetSessionUnread 清空未读。

注2：如果不满足开发者的场景，开发者可以组合调用 API，须小心接到新消息而触发的 onupdatesessions 变更时，忽略当前选中的会话的 unread 数变更。

关联函数
- SessionInterface.resetCurrSession
Parameters
- sessionId: string
Returns void

updateLocalSession

updateLocalSession(options: { id: string; localCustom?: string; needNotify?: boolean; done?: any }): void

更新本地数据库里的会话

Parameters
- options: { id: string; localCustom?: string; needNotify?: boolean; done?: any }
  
  入参
  - id: string
    
    会话 id
  - Optional localCustom?: string
    
    本地扩展字段
  - Optional needNotify?: boolean
    
    是否触发onupdatesession或onupdatesessions回调，默认是true
  - done?:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: NIMSession): void
    - Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      - data: NIMSession
      Returns void
Returns void

updateSessionsWithMoreRoaming

updateSessionsWithMoreRoaming(options: { msg: NIMMessage; done?: any }): void

deprecated
已废弃。更新漫游消息不全的会话的漫游时间戳

Parameters
- options: { msg: NIMMessage; done?: any }
  - msg: NIMMessage
    
    完整漫游消息列表中最早的一条消息，即在这条消息之后的本地消息列表是完整的
  - done?:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: NIMStrAnyObj): void
    - Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      - data: NIMStrAnyObj
      Returns void
Returns void

updateStickTopSession

updateStickTopSession(options: { id: string; topCustom?: string; done: any }): void

更新云端置顶的会话（目前仅能更新它的扩展字段）。调用后，当前账户所有登录用户收到 onupdatesessions 回调
关联函数
Parameters
- options: { id: string; topCustom?: string; done: any }
  - id: string
    
    sessionId
    
    例如 p2p-cs1、team-113879441
  - Optional topCustom?: string
    
    云端置顶会话的扩展字段
  - done:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: { stickTopSession: NIMSession }): void
    - Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      - data: { stickTopSession: NIMSession }
        stickTopSession: NIMSession
      Returns void
Returns void

Hierarchy

Implemented by

Index

Methods

Methods

addStickTopSession

关联函数

Parameters

options: { id: string; topCustom?: string; done: any }

id: string

Optional topCustom?: string

done:function

Parameters

err: null | NIMCommonError | Error | NIMStrAnyObj

data: { stickTopSession: NIMSession }

stickTopSession: NIMSession

Returns void

Returns void

deleteLocalSession

关联函数

示例场景

Parameters

options: { id: string; isDeleteRoaming?: boolean; isLogic?: boolean; done?: any }

id: string

Optional isDeleteRoaming?: boolean

Optional isLogic?: boolean

done?:function

Parameters

err: null | NIMCommonError | Error | NIMStrAnyObj

data: NIMSession

Returns void

Returns void

deleteSession

Parameters

options: { scene: "p2p" | "team" | "superTeam"; to: string; done?: any }

scene: "p2p" | "team" | "superTeam"

to: string

done?:function

Parameters

err: null | NIMCommonError | Error | NIMStrAnyObj

Returns void

Returns void

deleteSessions

Parameters

options: { sessions: NIMSession[]; done?: any }

sessions: NIMSession[]

done?:function

Parameters

err: null | NIMCommonError | Error | NIMStrAnyObj

Returns void

Returns void

deleteSessionsWithMoreRoaming

Parameters

options: { id: string; done?: any }

id: string

done?:function

Parameters

err: null | NIMCommonError | Error | NIMStrAnyObj

data: NIMStrAnyObj

Returns void

Returns void

deleteStickTopSession

关联函数

Parameters

options: { id: string; done: any }

id: string

done:function

Parameters

err: null | NIMCommonError | Error | NIMStrAnyObj

data: { stickTopSession: NIMSession }

stickTopSession: NIMSession

Returns void

Returns void

getLocalSession

Parameters

options: { sessionId: string; done: any }

sessionId: string

done:function

Parameters

err: null | NIMCommonError | Error | NIMStrAnyObj