UtilsInterface

工具函数定义

Hierarchy

UtilsInterface

Implemented by

Methods

cutFriends

cutFriends(arr1: NIMFriendProfile[], arr2: NIMFriendProfile | NIMFriendProfile[]): NIMFriendProfile[]

deprecated
废弃，合并方法参见文档：

去除好友

Parameters
- arr1: NIMFriendProfile[]
- arr2: NIMFriendProfile | NIMFriendProfile[]
Returns NIMFriendProfile[]

cutFriendsByAccounts

cutFriendsByAccounts(arr1: NIMFriendProfile[], arr2: string | string[]): NIMFriendProfile[]

deprecated
废弃，合并方法参见文档：

去除accounts对应的好友

Parameters
- arr1: NIMFriendProfile[]
- arr2: string | string[]
Returns NIMFriendProfile[]

cutLoginPorts

cutLoginPorts(arr1: NIMStrAnyObj[], arr2: NIMStrAnyObj | NIMStrAnyObj[]): NIMStrAnyObj[]

deprecated
废弃，合并方法参见文档：

从登录端中去除某些登录短

Parameters
- arr1: NIMStrAnyObj[]
- arr2: NIMStrAnyObj | NIMStrAnyObj[]
Returns NIMStrAnyObj[]

cutMsgs

cutMsgs(arr1: NIMMessage[], arr2: NIMMessage | NIMMessage[]): NIMMessage[]

deprecated
废弃，合并方法参见文档：

去除消息

Parameters
- arr1: NIMMessage[]
- arr2: NIMMessage | NIMMessage[]
Returns NIMMessage[]

cutRelations

cutRelations(arr1: NIMStrAnyObj[], arr2: NIMStrAnyObj | NIMStrAnyObj[]): NIMStrAnyObj[]

deprecated
废弃，合并方法参见文档：

去除关系

Parameters
- arr1: NIMStrAnyObj[]
- arr2: NIMStrAnyObj | NIMStrAnyObj[]
Returns NIMStrAnyObj[]

cutSessions

cutSessions(arr1: NIMSession[], arr2: NIMSession | NIMSession[]): NIMSession[]

deprecated
废弃，合并方法参见文档：

去除会话

Parameters
- arr1: NIMSession[]
- arr2: NIMSession | NIMSession[]
Returns NIMSession[]

cutSysMsgs

cutSysMsgs(arr1: NIMSystemMessage[], arr2: NIMSystemMessage | NIMSystemMessage[]): NIMSystemMessage[]

deprecated
废弃，合并方法参见文档：

去除系统消息

Parameters
- arr1: NIMSystemMessage[]
- arr2: NIMSystemMessage | NIMSystemMessage[]
Returns NIMSystemMessage[]

cutTeamMembersByAccounts

cutTeamMembersByAccounts(arr1: NIMTeamMember[], arr2: string | string[]): NIMTeamMember[]

deprecated
废弃，合并方法参见文档：

去除accounts对应的群成员

Parameters
- arr1: NIMTeamMember[]
- arr2: string | string[]
Returns NIMTeamMember[]

cutTeams

cutTeams(arr1: NIMTeam[], arr2: NIMTeam | NIMTeam[]): NIMTeam[]

deprecated
废弃，合并方法参见文档：

去除群

Parameters
- arr1: NIMTeam[]
- arr2: NIMTeam | NIMTeam[]
Returns NIMTeam[]

findFriend

findFriend(arr1: NIMFriendProfile[], account: string): null | NIMFriendProfile

deprecated
废弃，合并方法参见文档：

在关系数组里面根据 account 找到对应的

Parameters
- arr1: NIMFriendProfile[]
  
  好友数组
- account: string
  
  待查找的 account
Returns null | NIMFriendProfile

findMsg

findMsg(arr1: NIMMessage[], idClient: string): null | NIMMessage

deprecated
废弃，合并方法参见文档：

在消息数组里面根据 idClient 找到对应的

Parameters
- arr1: NIMMessage[]
  
  消息数组
- idClient: string
  
  待查找的 idClient
Returns null | NIMMessage

findRelation

findRelation(arr1: NIMStrAnyObj[], account: string): null | NIMStrAnyObj

deprecated
废弃，合并方法参见文档：

在关系数组里面根据 account 找到对应的关系

Parameters
- arr1: NIMStrAnyObj[]
  
  关系数组
- account: string
  
  待查找的关系的 account
Returns null | NIMStrAnyObj

findSession

findSession(arr1: NIMSession[], teamId: string): null | NIMSession

deprecated
废弃，合并方法参见文档：

在会话数组里面根据 id 找到对应的

Parameters
- arr1: NIMSession[]
  
  会话数组
- teamId: string
Returns null | NIMSession

findSysMsg

findSysMsg(arr1: NIMSystemMessage[], idServer: string): null | NIMSystemMessage

deprecated
废弃，合并方法参见文档：

在消息数组里面根据 idServer 找到对应的

Parameters
- arr1: NIMSystemMessage[]
  
  系统消息数组
- idServer: string
  
  待查找的 idServer
Returns null | NIMSystemMessage

findTeam

findTeam(arr1: NIMTeam[], teamId: string): null | NIMTeam

deprecated
废弃，合并方法参见文档：

在群数组里面根据 teamId 找到对应的

Parameters
- arr1: NIMTeam[]
  
  群数组
- teamId: string
  
  待查找的 teamId
Returns null | NIMTeam

findTeamMember

findTeamMember(arr1: NIMTeamMember[], id: string): null | NIMTeamMember

deprecated
废弃，合并方法参见文档：

在群成员数组里面根据 id 找到对应的

Parameters
- arr1: NIMTeamMember[]
  
  群成员数组
- id: string
  
  待查找的成员的 id
Returns null | NIMTeamMember

findUser

findUser(arr1: NIMUserNameCard[], account: string): null | NIMUserNameCard

deprecated
废弃，合并方法参见文档：

在用户名片数组里面根据 account 找到对应的

Parameters
- arr1: NIMUserNameCard[]
  
  用户名片数组
- account: string
  
  待查找的 account
Returns null | NIMUserNameCard

mergeFriends

mergeFriends(arr1: NIMFriendProfile[], arr2: NIMFriendProfile | NIMFriendProfile[]): NIMFriendProfile[]

deprecated
废弃，合并方法参见文档：

合并好友

Parameters
- arr1: NIMFriendProfile[]
- arr2: NIMFriendProfile | NIMFriendProfile[]
Returns NIMFriendProfile[]

mergeLoginPorts

mergeLoginPorts(arr1: NIMStrAnyObj[], arr2: NIMStrAnyObj | NIMStrAnyObj[]): NIMStrAnyObj[]

deprecated
废弃，合并方法参见文档：

合并登录端

Parameters
- arr1: NIMStrAnyObj[]
- arr2: NIMStrAnyObj | NIMStrAnyObj[]
Returns NIMStrAnyObj[]

mergeMsgs

mergeMsgs(arr1: NIMMessage[], arr2: NIMMessage | NIMMessage[]): NIMMessage[]

deprecated
废弃，合并方法参见文档：

合并消息

Parameters
- arr1: NIMMessage[]
- arr2: NIMMessage | NIMMessage[]
Returns NIMMessage[]

mergeRelations

mergeRelations(arr1: NIMStrAnyObj[], arr2: NIMStrAnyObj | NIMStrAnyObj[]): NIMStrAnyObj[]

deprecated
废弃，合并方法参见文档：

合并关系

Parameters
- arr1: NIMStrAnyObj[]
- arr2: NIMStrAnyObj | NIMStrAnyObj[]
Returns NIMStrAnyObj[]

mergeSessions

mergeSessions(arr1: NIMSession[], arr2: NIMSession | NIMSession[]): NIMSession[]

deprecated
废弃，合并方法参见文档：

合并会话

Parameters
- arr1: NIMSession[]
- arr2: NIMSession | NIMSession[]
Returns NIMSession[]

mergeSysMsgs

mergeSysMsgs(arr1: NIMSystemMessage[], arr2: NIMSystemMessage | NIMSystemMessage[]): NIMSystemMessage[]

deprecated
废弃，合并方法参见文档：

合并系统消息

Parameters
- arr1: NIMSystemMessage[]
- arr2: NIMSystemMessage | NIMSystemMessage[]
Returns NIMSystemMessage[]

mergeTeams

mergeTeams(arr1: NIMTeam[], arr2: NIMTeam | NIMTeam[]): NIMTeam[]

deprecated
废弃，合并方法参见文档：

合并群

Parameters
- arr1: NIMTeam[]
- arr2: NIMTeam | NIMTeam[]
Returns NIMTeam[]

mergeUsers

mergeUsers(arr1: NIMUserNameCard[], arr2: NIMUserNameCard | NIMUserNameCard[]): NIMUserNameCard[]

deprecated
废弃，合并方法参见文档：

合并用户名片

Parameters
- arr1: NIMUserNameCard[]
- arr2: NIMUserNameCard | NIMUserNameCard[]
Returns NIMUserNameCard[]

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
由于数据库只能提供正向索引的方式查找，查找效率低，建议放弃使用

搜索本地会话和本地好友

注：该接口需要数据库支持，若没有开启本地数据库能力，done 回调里只会返回空

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"
    
    搜索路径。若不填写则搜索下面所有的字段
  - keyword: string
    
    搜索关键词
  - done?:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: NIMSearchLocalResult): void
    - Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      - data: NIMSearchLocalResult
      Returns void
Returns void

Hierarchy

Implemented by

Index

Methods

Methods

cutFriends

Parameters

arr1: NIMFriendProfile[]

arr2: NIMFriendProfile | NIMFriendProfile[]

Returns NIMFriendProfile[]

cutFriendsByAccounts

Parameters

arr1: NIMFriendProfile[]

arr2: string | string[]

Returns NIMFriendProfile[]

cutLoginPorts

Parameters

arr1: NIMStrAnyObj[]

arr2: NIMStrAnyObj | NIMStrAnyObj[]

Returns NIMStrAnyObj[]

cutMsgs

Parameters

arr1: NIMMessage[]

arr2: NIMMessage | NIMMessage[]

Returns NIMMessage[]

cutRelations

Parameters

arr1: NIMStrAnyObj[]

arr2: NIMStrAnyObj | NIMStrAnyObj[]

Returns NIMStrAnyObj[]

cutSessions

Parameters

arr1: NIMSession[]

arr2: NIMSession | NIMSession[]

Returns NIMSession[]

cutSysMsgs

Parameters

arr1: NIMSystemMessage[]

arr2: NIMSystemMessage | NIMSystemMessage[]

Returns NIMSystemMessage[]

cutTeamMembersByAccounts

Parameters

arr1: NIMTeamMember[]

arr2: string | string[]

Returns NIMTeamMember[]

cutTeams

Parameters

arr1: NIMTeam[]

arr2: NIMTeam | NIMTeam[]

Returns NIMTeam[]

findFriend

Parameters

arr1: NIMFriendProfile[]

account: string

Returns null | NIMFriendProfile

findMsg

Parameters

arr1: NIMMessage[]

idClient: string

Returns null | NIMMessage

findRelation

Parameters

arr1: NIMStrAnyObj[]

account: string

Returns null | NIMStrAnyObj

findSession

Parameters

arr1: NIMSession[]

teamId: string

Returns null | NIMSession

findSysMsg

Parameters

arr1: NIMSystemMessage[]

idServer: string

Returns null | NIMSystemMessage

findTeam

Parameters

arr1: NIMTeam[]

teamId: string

Returns null | NIMTeam