Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SessionServiceInterface

调用方式:

nim.session.getSession(options)

Hierarchy

  • SessionServiceInterface

Index

Methods

Methods

addStickTopSession

deleteAllSessionsFromLocal

  • deleteAllSessionsFromLocal(): void

deleteSession

  • deleteSession(options: { id: string; isSyncToServer: boolean }): Promise<void>

deleteStickTopSession

getAllSessions

  • 获取内存中的全部会话列表

    Returns Session[]

getSession

  • 根据 sessionId 从内存中获取会话

    会话保存在内存中的 im 实例里。

    Parameters

    Returns void | Session

getSessions

resetAllSessionsUnreadCount

  • resetAllSessionsUnreadCount(): Promise<void>

  • 重置所有会话的未读数

    • 如果所有会话的未读数都是 0，则不会有任何效果
    • 如果有会话未读数为 0，则会将其未读数置为 0，同时会收到多个 updateSession 事件
    • 多端同步用户也会收到 updateSession 事件

    Returns Promise<void>

resetMultiSessionUnreadCount

  • 批量重置多个会话未读数

    • 如果所有选中会话的未读数都是 0，则不会有任何效果
    • 如果有会话未读数为 0，则会将其未读数置为 0，同时会收到多个 updateSession 事件
    • 多端同步用户也会收到 updateSession 事件

    如果是已经存在的会话记录, 会将此会话未读数置为 0，并且实例能收到 updateSession 事件代表会话被更新 之后此会话在收到消息之后依然会更新未读数 会同步至多端登录的其他端

    Parameters

    Returns Promise<void>

resetSessionUnreadCount

updateStickTopSession