FriendInterface

好友相关 API

Hierarchy

FriendInterface

Implemented by

Index

Methods

addFriend

addFriend(options: { account: string; ps?: string; done?: any }): void

直接添加好友，无需对方同意。接收方会收到 type = 'addFriend' 的系统消息，此系统通知 from 字段为申请方账号，to 字段为接收方的账号
系统消息关联函数
- NIMGetInstanceOptions.onsysmsg 在线接收系统消息
- NIMGetInstanceOptions.onupdatesysmsgunread 在线时系统消息未读数更新
好友关系关联函数
- NIMGetInstanceOptions.onfriends 初始化阶段同步好友关系
- NIMGetInstanceOptions.onsyncfriendaction 多端登录设备接收到好友事件
示例场景
- 用户资料与好友关系
Parameters
- options: { account: string; ps?: string; done?: any }
  - account: string
    
    要直接加为好友的账号
  - Optional ps?: string
    
    附言, 推荐开发者传入 JSON 格式化字符串。
  - done?:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj): void
    - Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      Returns void
Returns void

applyFriend

applyFriend(options: { account: string; ps?: string; done?: any }): void

申请加为好友，需要对方同意。接收方会收到 type = ‘applyFriend' 的系统通知。接收方可以选择 passFriendApply，或者 rejectFriendApply
- 如果被申请方FriendInterface.passFriendApply，则申请方收到 passFriendApply 系统通知
- 如果被申请方FriendInterface.rejectFriendApply，则申请方收到 rejectFriendApply 系统通知
系统消息关联函数
- NIMGetInstanceOptions.onsysmsg 在线接收系统消息
- NIMGetInstanceOptions.onupdatesysmsgunread 在线时系统消息未读数更新
好友关系关联函数
- NIMGetInstanceOptions.onfriends 初始化阶段同步好友关系
- NIMGetInstanceOptions.onsyncfriendaction 多端登录设备接收到好友事件
Parameters
- options: { account: string; ps?: string; done?: any }
  - account: string
  - Optional ps?: string
    
    附言, 推荐开发者传入 JSON 格式化字符串。
  - done?:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj): void
    - Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      Returns void
Returns void

deleteFriend

deleteFriend(options: { account: string; delAlias?: boolean; done?: any }): void

删除好友。接收方会收到 type = 'deleteFriend' 的系统消息。此系统通知的from字段的值为删除方的帐号, to字段的值为被删除方的账号。
系统消息关联函数
- NIMGetInstanceOptions.onsysmsg 在线接收系统消息
- NIMGetInstanceOptions.onupdatesysmsgunread 在线时系统消息未读数更新
好友关系关联函数
- NIMGetInstanceOptions.onfriends 初始化阶段同步好友关系
- NIMGetInstanceOptions.onsyncfriendaction 多端登录设备接收到好友事件
示例场景
- 用户资料与好友关系
Parameters
- options: { account: string; delAlias?: boolean; done?: any }
  - account: string
  - Optional delAlias?: boolean
    
    是否要删除好友的备注
  - done?:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj): void
    - Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      Returns void
Returns void

getFriends

getFriends(options: { updateTime?: number; done?: any }): void

如果开发者在初始化SDK的时候设置了syncFriends为false, 那么就收不到onfriends回调, 可以调用此接口来获取好友列表
注：由于 v8.9.0 之后好友数量上限变为 10000，远端协议不允许一口气下发 10000 个。想要一口气获取有两种手段：
1. 如果开发者使用数据库，那么此接口将会返回所有数据库中有效的，且 updateTime > options.updateTime 的好友记录
2. 如果开发者不使用数据库，那么使用此接口，传入时间戳，将会从服务器获取 updateTime > options.timetag 的 3000 条记录，分页逻辑请自行处理。
Parameters
- options: { updateTime?: number; done?: any }
  - Optional updateTime?: number
    
    时间戳，默认 0。获取更新时间大于此时间戳的升序 3000 条好友。
  - done?:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: NIMFriendProfile[]): void
    - Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      - data: NIMFriendProfile[]
      Returns void
Returns void

getFriendsFromDB

getFriendsFromDB(options: { accountIds?: string[]; done?: any }): void

从数据库中批量获取好友信息, 不限个数

注: indexDB 数据库专用接口.

Parameters
- options: { accountIds?: string[]; done?: any }
  - Optional accountIds?: string[]
    
    账号 id 列表. 不传则忽略这个过滤条件
  - done?:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: NIMFriendProfile[]): void
    - Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      - data: NIMFriendProfile[]
      Returns void
Returns void

isMyFriend

isMyFriend(options: { account: string; done?: any }): void

是否为我的好友

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

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

passFriendApply

passFriendApply(options: { account: string; idServer: string; ps?: string; done?: any }): void

通过好友申请。调用该函数后：
1. 调用者收到 onupdatesysmsg 回调函数
2. 接收者收到 onsysmsg、onupdatesysmsgunread 函数。onsysmsg 消息类型为 'passFriendApply'
系统消息关联函数
- NIMGetInstanceOptions.onsysmsg 在线接收系统消息
- NIMGetInstanceOptions.onupdatesysmsgunread 在线时系统消息未读数更新
- NIMGetInstanceOptions.onupdatesysmsg 在线时系统消息状态更新
好友关系关联函数
- NIMGetInstanceOptions.onfriends 初始化阶段同步好友关系
- NIMGetInstanceOptions.onsyncfriendaction 多端登录设备接收到好友事件
示例场景
- 用户资料与好友关系
Parameters
- options: { account: string; idServer: string; ps?: string; done?: any }
  - account: string
  - idServer: string
  - Optional ps?: string
  - done?:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj): void
    - Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      Returns void
Returns void

rejectFriendApply

rejectFriendApply(options: { account: string; idServer: string; ps: string; done?: any }): void

拒绝好友申请。调用该函数后：
1. 调用者收到 onupdatesysmsg 回调函数
2. 接收者收到 onsysmsg、onupdatesysmsgunread 函数。onsysmsg 消息类型为 'rejectFriendApply'
系统消息关联函数
- NIMGetInstanceOptions.onsysmsg 在线接收系统消息
- NIMGetInstanceOptions.onupdatesysmsgunread 在线时系统消息未读数更新
- NIMGetInstanceOptions.onupdatesysmsg 在线时系统消息状态更新
好友关系关联函数
- NIMGetInstanceOptions.onfriends 初始化阶段同步好友关系
- NIMGetInstanceOptions.onsyncfriendaction 多端登录设备接收到好友事件
Parameters
- options: { account: string; idServer: string; ps: string; done?: any }
  - account: string
  - idServer: string
  - ps: string
  - done?:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj): void
    - Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      Returns void
Returns void

updateFriend

updateFriend(options: { account: string; alias?: string; custom?: string; done?: any }): void

更新好友的备注和扩展字段。多端登录设备会收到 onsyncfriendaction 回调
关联函数
- NIMGetInstanceOptions.onsyncfriendaction
示例场景
- 用户资料与好友关系
Parameters
- options: { account: string; alias?: string; custom?: string; done?: any }
  - account: string
  - Optional alias?: string
    
    备注
  - Optional custom?: string
    
    扩展字段, 选填, 开发者也可以使用JSON格式的字符串来扩展此内容
  - done?:function
    - done(err: null | NIMCommonError | Error | NIMStrAnyObj): void
    - Parameters
      - err: null | NIMCommonError | Error | NIMStrAnyObj
      Returns void
Returns void

Hierarchy

Implemented by

Index

Methods

Methods

addFriend

系统消息关联函数

好友关系关联函数

示例场景

Parameters

options: { account: string; ps?: string; done?: any }

account: string

Optional ps?: string

done?:function

Parameters

err: null | NIMCommonError | Error | NIMStrAnyObj

Returns void

Returns void

applyFriend

系统消息关联函数

好友关系关联函数

Parameters

options: { account: string; ps?: string; done?: any }

account: string

Optional ps?: string

done?:function

Parameters

err: null | NIMCommonError | Error | NIMStrAnyObj

Returns void

Returns void

deleteFriend

系统消息关联函数

好友关系关联函数

示例场景

Parameters

options: { account: string; delAlias?: boolean; done?: any }

account: string

Optional delAlias?: boolean

done?:function

Parameters

err: null | NIMCommonError | Error | NIMStrAnyObj

Returns void

Returns void

getFriends

Parameters

options: { updateTime?: number; done?: any }

Optional updateTime?: number

done?:function

Parameters

err: null | NIMCommonError | Error | NIMStrAnyObj

data: NIMFriendProfile[]

Returns void

Returns void

getFriendsFromDB

Parameters

options: { accountIds?: string[]; done?: any }

Optional accountIds?: string[]

done?:function

Parameters

err: null | NIMCommonError | Error | NIMStrAnyObj

data: NIMFriendProfile[]

Returns void

Returns void

isMyFriend

Parameters

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

account: string

done?:function

Parameters

err: null | NIMCommonError | Error | NIMStrAnyObj

data: boolean

Returns void

Returns void

passFriendApply

系统消息关联函数

好友关系关联函数

示例场景

Parameters

options: { account: string; idServer: string; ps?: string; done?: any }

account: string