Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FriendsQuery

A paginated query for listing friends. Create via UserModule.createFriendsQuery.

example
const query = NCEngine.userModule.createFriendsQuery({ pageSize: 50 });
const page = await query.loadNextPage();
if (page.isOk) {
  page.data.forEach((f) => console.log(f.userId, f.remark));
}

Hierarchy

Index

Accessors

Methods

Accessors

isLoading

  • get isLoading(): boolean

  • Whether the query is currently loading data

    Returns boolean

hasNext

  • get hasNext(): boolean

  • Whether there are more pages of data to load

    Returns boolean

Methods

loadNextPage

  • Loads the next page of query results. Returns a busy error if a load operation is already in progress.

    example
    const result = await query.loadNextPage();
    if (result.isOk) {
      console.log('Data:', result.data);
    }

    Returns Promise<NCResult<PageData<FriendInfo>>>

    A promise resolving to the query result