Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SubscribeQuery

A paginated query for listing subscribed user status information. Create via UserModule.createSubscribeQuery.

example
const query = NCEngine.userModule.createSubscribeQuery({
  subscribeType: SubscribeType.ONLINE_STATUS,
  pageSize: 20,
});
const result = await query.loadNextPage();

Hierarchy

Index

Accessors

Methods

Accessors

isLoading

  • get isLoading(): boolean

  • Whether the query is currently loading data

    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<SubscriptionStatusInfo>>>

    A promise resolving to the query result