Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UtilsInterface

Utility function definition

Hierarchy

  • UtilsInterface

Implemented by

Index

Methods

Methods

cutFriends

cutFriendsByAccounts

  • deprecated,

    see the documentation for the merge method:

    Remove accounts from friends

    Parameters

    Returns NIMFriendProfile[]

cutLoginPorts

cutMsgs

cutRelations

cutSessions

cutSysMsgs

cutTeamMembersByAccounts

  • deprecated,

    see the documentation for the merge method:

    Remove members by accounts

    Parameters

    Returns NIMTeamMember[]

cutTeams

findFriend

  • deprecated,

    see the documentation for the merge method:

    Find friends by account.

    Parameters

    Returns null | NIMFriendProfile

findMsg

  • deprecated,

    see the documentation for the merge method:

    Query messages by idClient

    Parameters

    • arr1: NIMMessage[]

      Message array

    • idClient: string

      Message idClient for query

    Returns null | NIMMessage

findRelation

  • deprecated,

    see the documentation for the merge method:

    Find the relationship by account in the relationship array

    Parameters

    • arr1: NIMStrAnyObj[]

      relation array

    • account: string

      account for query relation

    Returns null | NIMStrAnyObj

findSession

  • deprecated,

    see the documentation for the merge method:

    Query conversations by ID

    Parameters

    • arr1: NIMSession[]

      Array of conversations

    • teamId: string

    Returns null | NIMSession

findSysMsg

  • deprecated,

    see the documentation for the merge method:

    Query system notifications by idServer

    Parameters

    • arr1: NIMSystemMessage[]

      Array of system notifications

    • idServer: string

      idServer of a system notification for query

    Returns null | NIMSystemMessage

findTeam

  • deprecated,

    see the documentation for the merge method:

    Query groups by teamId

    Parameters

    • arr1: NIMTeam[]

      group array

    • teamId: string

      group with teamId to be queried

    Returns null | NIMTeam

findTeamMember

  • deprecated,

    see the documentation for the merge method:

    Query a member by ID

    Parameters

    • arr1: NIMTeamMember[]

      array of group members

    • id: string

      member ID to be queries

    Returns null | NIMTeamMember

findUser

  • deprecated,

    see the documentation for the merge method:

    Query user profiles by account

    Parameters

    • arr1: NIMUserNameCard[]

      Array of user profiles

    • account: string

      account to be queried

    Returns null | NIMUserNameCard

mergeFriends

mergeLoginPorts

mergeMsgs

mergeRelations

mergeSessions

mergeSysMsgs

mergeTeams

mergeUsers

searchLocal

  • searchLocal(options: { keyPath?: "session" | "session.lastMsg.type" | "session.id" | "session.scene" | "session.lastMsg.text" | "session.localCustom" | "session.target.account" | "session.target.nick" | "session.target.alias" | "session.target.name" | "user" | "user.account" | "user.nick" | "user.alias"; keyword: string; done?: any }): void
  • deprecated

    Since the database can only provide forward index search. The efficiency is low. It is not recommended

    Search local conversations and friends

    Note: This interface requires database support. If the local database is not enabled, the done callback will return empty

    Parameters

    • options: { keyPath?: "session" | "session.lastMsg.type" | "session.id" | "session.scene" | "session.lastMsg.text" | "session.localCustom" | "session.target.account" | "session.target.nick" | "session.target.alias" | "session.target.name" | "user" | "user.account" | "user.nick" | "user.alias"; keyword: string; done?: any }
      • Optional keyPath?: "session" | "session.lastMsg.type" | "session.id" | "session.scene" | "session.lastMsg.text" | "session.localCustom" | "session.target.account" | "session.target.nick" | "session.target.alias" | "session.target.name" | "user" | "user.account" | "user.nick" | "user.alias"

        Path for search. If unspecified, all fields below will be searched

      • keyword: string

        Keyword for search

      • done?:function

    Returns void