SDKsuni-app

Get the friend list

Page through the current user’s friend list with the uni-app / uni-app x SDK.

Parameters

Parameter	Type	Required	Description
`offset`	`number`	Yes	Pagination offset. Pass `0` for the first page.
`count`	`number`	Yes	Number of friends to request.
`filterBlack`	`boolean`	No	Whether to exclude blacklisted users from the results.

import { getFriendListPage } from '@/uni_modules/unix-openim-sdk'

const result = await getFriendListPage({
  offset: 0,
  count: 50,
  filterBlack: true,
})

After the Promise succeeds, result?.friends is the current page of OpenIMFriendUserItem[]. Increase offset by the requested item count to load the next page. Reset pagination after a friend is added or removed. The native API returns OpenIMFriendListResult | null directly; there is no { data } wrapper.

Friend profile fields

OpenIMFriendUserItem describes the current account's relationship with one friend:

Field	Type	Description
`userID`	`string`	The friend's user ID and the stable identifier in the friend list.
`nickname`	`string`	The friend's account-level nickname.
`faceURL`	`string`	The friend's account-level avatar URL.
`remark`	`string`	A remark the current account assigned to this friend.
`isPinned`	`boolean`	Whether the friend is pinned in the contacts list.
`ownerUserID`	`string`	The user ID that owns this friendship, normally the current account.
`operatorUserID`	`string`	The user ID that created or updated the relationship.
`addSource`	`number`	Value describing the source through which the friendship was added.
`createTime`	`number`	Time when the friendship was created.
`ex`	`string`	Friendship extension string.
`attachedInfo`	`string`	SDK attachment data. Parse it only according to a confirmed application contract.

nickname and faceURL are snapshots of the account profile. remark, isPinned, ex, and attachedInfo belong to the friendship. Do not overwrite a non-friend's OpenIMPublicUserItem with an OpenIMFriendUserItem, and do not write a friend remark back to the account nickname.

Synchronize friend changes

This page owns the complete listeners for onFriendAdded, onFriendInfoChanged, and onFriendDeleted. The query establishes a snapshot; events merge incremental changes by userID.

import {
  off,
  onFriendAdded,
  onFriendDeleted,
  onFriendInfoChanged,
  type OpenIMSDKEventSubscription,
} from '@/uni_modules/unix-openim-sdk'

const friendSubscriptions : Array<OpenIMSDKEventSubscription> = [
  onFriendAdded((friend) => mergeFriend(friend.userID, friend)),
  onFriendInfoChanged((friend) => mergeFriend(friend.userID, friend)),
  onFriendDeleted((friend) => removeFriend(friend.userID)),
]

function removeFriendListeners() {
  friendSubscriptions.forEach((subscription) => off(subscription))
}

Call removeFriendListeners() when signing out, switching accounts, or destroying the contacts state layer.

Was this page helpful?