SessionInterface

Hierarchy

SessionInterface

Implemented by

Methods

addStickTopSession

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

Pin a conversation The next time a user logs in, the onStickTopSessions callback returns the list of pinned conversations during initialization. all logged-in users of the current account will get notified by the onupdatesessions callback
Associated function
Parameters
- options: { id: string; topCustom?: string; done: any }
  - id: string
    
    sessionId
    
    For example p2p-cs1, team-113879441
  - Optional topCustom?: string
    
    the extension field of pinned conversations.
  - 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

Delete the specified conversation from the local database. and optionally delete messages for sync on the server.
Associated function
- MessageLogInterface.clearServerHistoryMsgsWithSync Delete message history and message history for sync
Example
- Manage group members
Parameters
- options: { id: string; isDeleteRoaming?: boolean; isLogic?: boolean; done?: any }
  - id: string
    
    Conversation ID
  - Optional isDeleteRoaming?: boolean
    
    Whether to delete messages for sync, default value: false. Added from v8.2.0, if true, the server will not send messages for sync in this conversation next time you sign in. This setting will affect logins on other devices. Proceed with caution.
  - Optional isLogic?: boolean
    
    Whether the conversation is deleted by logic. The default value is false. New feature from V7.9.1, data marked as deleted but the actual data is not immediately removed from the physical storage. The unread and msgReceiptTime of the conversation are reserved. The next time the conversation is created, correct unread count and read timestamps are kept.
  - 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.
Use deleteLocalSession and 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.
Use deleteLocalSession and 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.
Delete conversations with incomplete message history for sync by conversation ID

Parameters
- options: { id: string; done?: any }
  - id: string
    
    Conversation 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

Unpin a conversation The next time a user logs in, the onStickTopSessions callback returns the list of pinned conversations during initialization. all logged-in users of the current account will get notified by the onupdatesessions callback
Associated function
Parameters
- options: { id: string; done: any }
  - id: string
    
    sessionId
    
    For example 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

Get the session in the local database by sessionId

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

getLocalSessions

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

Query the list of conversations in the local database.
- If db is not enabled, this SDK returns a list of sessions maintained in the memory. While it is possible to return the list of conversations, it is not recommended. You must maintain conversation data in your app. For more information, see the sample code
Note: The conversation list is sorted in descending order by updateTime, that is, the most recently conversations are displayed at the top.

Example
- Conversation sorting(db enabled)
Parameters
- options: { lastSessionId?: string; limit?: number; reverse?: boolean; done: any }
  - Optional lastSessionId?: string
    
    The ID of the last conversation on the previous page, you can leave it blank for the first query.
  - Optional limit?: number
    
    limit on the number of queries per page, the default value is 100
  - Optional reverse?: boolean
    
    Query order. The default value is false
    
    value: false. search starts from the earliest conversations.
    
    true: search starts from the conversations with the latest update time
  - done:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: NIMSession[]): void
    - Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      - data: NIMSession[]
      Returns void
Returns void

getLocalSessionsByMsgType

getLocalSessionsByMsgType(options: NIMStrAnyObj): void

deprecated.
Use SessionInterface.getLocalSessions

Parameters
- options: NIMStrAnyObj
Returns void

getSessionsWithMoreRoaming

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

deprecated
Deprecated. Query the conversations with incomplete message history for sync

Parameters
- options: { id: string; done?: any }
  - id: string
    
    Conversation 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

Get the list of pinned conversations

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

Insert a conversation into the local database indexdb
- If the database is not enabled, a session will be inserted in the memory. It is not recommended to use this function without db. You must maintain conversation data in the memory data.
- If the conversation already exists, an error will be returned
- If there is a local history message for this conversation, the lastMsg of the conversation will be updated to the last message.
- The onupdatesysmsgunread callback is triggered after you insert this conversation.
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

Reset the unread count for all conversations.
Notes
- If the initialization parameter NIMGetInstanceOptions.syncSessionUnread = true, this function will synchronize the unread count with the server. Otherwise only the session in memory can be affected..
- The function all triggers the NIMGetInstanceOptions.onupdatesessions callback
Returns void

resetCurrSession

resetCurrSession(sessionId: string): void

Cancels the effect of "setCurrSession". After cancellation, the unread count will change after the conversation receives new messages.
Associated function
- SessionInterface.setCurrSession
Parameters
- sessionId: string
Returns void

resetSessionUnread

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

Reset the unread count for a conversation. To reset the unread count of a superTeamSessionsUnread, use SessionInterface.resetSuperTeamSessionsUnread.
Notes
- If the initialization parameter NIMGetInstanceOptions.syncSessionUnread = true, this function will synchronize the unread count with the server. Otherwise only the session in memory can be affected..
- The function all triggers the NIMGetInstanceOptions.onupdatesessions callback
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>

Reset the unread count for some conversations. To reset the unread count of supergroups, use SessionInterface.resetSuperTeamSessionsUnread
Notes
- If the initialization parameter NIMGetInstanceOptions.syncSessionUnread = true, this function will synchronize the unread count with the server. Otherwise only the session in memory can be affected..
- The function all triggers the NIMGetInstanceOptions.onupdatesessions callback
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>

Reset the unread count for some supergroups
Notes
- If the initialization parameter NIMGetInstanceOptions.syncSessionUnread = true, this function will synchronize the unread count with the server. Otherwise only the session in memory can be affected..
- The function all triggers the NIMGetInstanceOptions.onupdatesessions callback
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

Set "join the current conversation"
Note: This is an easy-to-use composite interface . The logic is: record the current conversation in memory, call resetSessionUnread to clear the unread count when joining the conversation, and use resetSessionUnread to clear the unread count when new messages are received onMsg.
- If it is not suitable for your use case, you can combine the APIs. Caution when the onupdatesessions change triggered by receiving a new message. the change of the unread count of the current conversation is ignored.
Associated function
- SessionInterface.resetCurrSession
Parameters
- sessionId: string
Returns void

updateLocalSession

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

Update conversations in the local database

Parameters
- options: { id: string; localCustom?: string; needNotify?: boolean; done?: any }
  - id: string
    
    Conversation ID
  - Optional localCustom?: string
    
    local custom extension field
  - Optional needNotify?: boolean
    
    whether to trigger onupdatesession or onupdatesessions callback, the default value is 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.
Update the timestamp of incomplete data of messages for sync

Parameters
- options: { msg: NIMMessage; done?: any }
  - msg: NIMMessage
    
    The earliest message in the complete message history for sync. That is, the local message history after this message is complete.
  - 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

Update the pinned conversations (only the extension fields can be updated). all logged-in users of the current account will get notified by the onupdatesessions callback
Associated function
Parameters
- options: { id: string; topCustom?: string; done: any }
  - id: string
    
    sessionId
    
    For example p2p-cs1, team-113879441
  - Optional topCustom?: string
    
    the extension field of pinned conversations.
  - 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

Associated function

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

Associated function

Example

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

Associated function

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