A class representing query to retrieve public GroupChannel list.

Hierarchy

  • default
    • PublicGroupChannelListQuery

Properties

channelNameContainsFilter: null | string = null

A channel name filter. GroupChannel list containing the passed channel name will be returned. If you pass name such as "abc", then the returned channel list will be containing name like "abc". It will return null if channel name filter hasn't been set before.

channelUrlsFilter: null | string[] = null

List of channel URL filter. It will return null if channel URL filter hasn't been set before. GroupChannel list containing only and exactly the passed GroupChannel URLs will be returned.

customTypesFilter: null | string[] = null

List of custom type filter. GroupChannel list containing only and exactly the passed custom types will be returned. It will return null if custom types filter hasn't been set before.

customTypeStartsWithFilter: null | string = null

A filter to return channels that start with the specified custom type. It will return null if custom type starts with filter hasn't been set before.

includeEmpty: boolean = false

Checks whether query result includes empty channels (channels without messages). (default: false)

includeFrozen: boolean = true

Checks whether query result includes frozen channels. (default: true)

includeMetaData: boolean = true

Whether to include channel metadata on fetch. (default: true)

limit: number = DEFAULT_LIST_QUERY_LIMIT

The maximum number of data per queried page.

membershipFilter: MembershipFilter = MembershipFilter.ALL

Membership filter.

metadataKey: null | string = null

The metadataKey set with either metaDataValues or metaDataValueStartsWith.

metadataOrderKeyFilter: null | string = null

Meta data order key filter. It will return null if meta data order key filter hasn't been set before. This filter will work only if order is GroupChannelListQueryOrder.METADATA_VALUE_ALPHABETICAL

metadataValues: null | string[] = null

Works exclusively with metaDataValueStartsWith.

metadataValueStartsWith: null | string = null

Works exclusively with metaDataValues.

order: PublicGroupChannelListOrder = PublicGroupChannelListOrder.CHRONOLOGICAL

Result order of channels.

superChannelFilter: SuperChannelFilter = SuperChannelFilter.ALL

Super channel filter.

Accessors

  • get hasNext(): boolean
  • Returns boolean

    Whether there is a next page.

  • get isLoading(): boolean
  • Returns boolean

    Whether the current query is in communication progress with server.

Methods

  • Returns Promise<GroupChannel[]>

    Gets the list of public GroupChannels. If this method is repeatedly called after each next is finished, it retrieves the following pages of the GroupChannel list. If there is no more pages to be read, an empty list (not null). is returned.