FriendInterface

Friends APIs

Hierarchy

FriendInterface

Implemented by

Index

Methods

addFriend

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

Add a friend without consent. The recipient will receive a system notification of type = 'addFriend', and the from field is the account ID of the requster, and the field to is the account ID of the recipient
Related functions for system notifications
- NIMGetInstanceOptions.onsysmsg Receive system notifications online
- NIMGetInstanceOptions.onupdatesysmsgunread Update the unread count of system notifications online
Related functions
- NIMGetInstanceOptions.onfriends synchronize the friend list during initialization
- NIMGetInstanceOptions.onsyncfriendaction Synchronize friends across devices.
Example
- User profile and friends data
Parameters
- options: { account: string; ps?: string; done?: any }
  - account: string
    
    The account to be added as a friend
  - Optional ps?: string
    
    Additional message in JSON string.
  - 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

Send a friend request for approval The recipient will receive a system notification of type = 'applyFriend'. The recipient can choose to passFriendApply, or rejectFriendApply
- If the recipient of a friend request FriendInterface.passFriendApply, the requester receives a system notification of type passFriendApply.
- If the recipient of a friend request FriendInterface.rejectFriendApply, the requester receives a system notification of type rejectFriendApply.
Related functions for system notifications
- NIMGetInstanceOptions.onsysmsg Receive system notifications online
- NIMGetInstanceOptions.onupdatesysmsgunread Update the unread count of system notifications online
Related functions
- NIMGetInstanceOptions.onfriends synchronize the friend list during initialization
- NIMGetInstanceOptions.onsyncfriendaction Synchronize friends across devices.
Parameters
- options: { account: string; ps?: string; done?: any }
  - account: string
  - Optional ps?: string
    
    Additional message in JSON string.
  - 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

Delete a friend. The recipient will receive a system message of type = 'deleteFriend'. The from field of this system notification is the account that deletes the friend account and the to field is the ID of the deleted account.
Related functions
- NIMGetInstanceOptions.onsysmsg online users receive the system notification
- NIMGetInstanceOptions.onupdatesysmsgunread online users update the unread count of system notifications
Related functions
- NIMGetInstanceOptions.onfriends synchronize the friend list during initialization
- NIMGetInstanceOptions.onsyncfriendaction Synchronize friends across devices.
Example
- User profile and friends data
Parameters
- options: { account: string; delAlias?: boolean; done?: any }
  - account: string
  - Optional delAlias?: boolean
    
    Whether to delete the alias of a friend account.
  - 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

If you set syncFriends to false when initializing the SDK, the onfriends callback will not be triggered. In this case, this interface can obtain the friend list
Note: Since the upper limit of the number of friends after v8.9.0 becomes 10,000, the remote protocol does not allow the SDK to send 10,000 friends in one go. There are two ways to get all friends at a time:
1. If a database is used, this interface will return all valid friend records in the database with updateTime > options.updateTime
2. If a database is not used, this interface with a timestamp argument will get 3000 records of updateTime > options.timetag from the server. Please handle the pagination logic on your own.
Parameters
- options: { updateTime?: number; done?: any }
  - Optional updateTime?: number
    
    Timestamp, default value: 0. Get 3000 friends in ascending order whose update time is greater than this timestamp.
  - 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

Check if the user is included in the friend list

Note: This interface requires database support. If the local database is not enabled, the done callback will return 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

Accept a friend request. When the function is invoked,
1. The caller gets notified by the onupdatesysmsg callback.
2. The recipient gets notified by onsysmsg and onupdatesysmsgunread callbacks. The type of the onsysmsg message is 'passFriendApply'
Related functions for system notifications
- NIMGetInstanceOptions.onsysmsg Receive system notifications online
- NIMGetInstanceOptions.onupdatesysmsgunread Update the unread count of system notifications online
- NIMGetInstanceOptions.onupdatesysmsg Update the system messages online
Related functions
- NIMGetInstanceOptions.onfriends synchronize the friend list during initialization
- NIMGetInstanceOptions.onsyncfriendaction Synchronize friends across devices.
Example
- User profile and friends data
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

Reject a friend request. When the function is invoked,
1. The caller gets notified by the onupdatesysmsg callback.
2. The recipient gets notified by onsysmsg and onupdatesysmsgunread callbacks. The type of the onsysmsg message is 'rejectFriendApply'
Related functions for system notifications
- NIMGetInstanceOptions.onsysmsg Receive system notifications online
- NIMGetInstanceOptions.onupdatesysmsgunread Update the unread count of system notifications online
- NIMGetInstanceOptions.onupdatesysmsg Update the system messages online
Related functions
- NIMGetInstanceOptions.onfriends synchronize the friend list during initialization
- NIMGetInstanceOptions.onsyncfriendaction Synchronize friends across devices.
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

Update the alias and extension fields for friends. The logged in clients get notified by onsyncfriendaction.
Associated function
- NIMGetInstanceOptions.onsyncfriendaction
Example
- User profile and friends data
Parameters
- options: { account: string; alias?: string; custom?: string; done?: any }
  - account: string
  - Optional alias?: string
    
    Alias
  - Optional custom?: string
    
    Extension field, optional, You can also use JSON string for the field.
  - 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

Related functions for system notifications

Related functions

Example

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

Related functions for system notifications

Related functions

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

Related functions

Related functions

Example

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

isMyFriend

Parameters

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

account: string

done?:function

Parameters

err: null | NIMCommonError | Error | NIMStrAnyObj

data: boolean

Returns void

Returns void

passFriendApply

Related functions for system notifications

Related functions

Example

Parameters

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

account: string

idServer: string

Optional ps?: string

done?:function

Parameters

err: null | NIMCommonError | Error | NIMStrAnyObj

Returns void

Returns void

rejectFriendApply

Related functions for system notifications

Related functions