Class PublicGroupChannelListQuery

Description

A class representing query to retrieve public GroupChannel list.

Hierarchy

  • default
    • PublicGroupChannelListQuery

Properties

channelNameContainsFilter channelUrlsFilter customTypeStartsWithFilter customTypesFilter includeEmpty includeFrozen includeMetaData limit membershipFilter metadataKey metadataOrderKeyFilter metadataValueStartsWith metadataValues order superChannelFilter

Accessors

hasNext isLoading

Methods

next

Properties

Readonly channelNameContainsFilter

channelNameContainsFilter: null | string = null

Description

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.

Readonly channelUrlsFilter

channelUrlsFilter: null | string[] = null

Description

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.

Readonly customTypeStartsWithFilter

customTypeStartsWithFilter: null | string = null

Description

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.

Readonly customTypesFilter

customTypesFilter: null | string[] = null

Description

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.

Readonly includeEmpty

includeEmpty: boolean = false

Description

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

Readonly includeFrozen

includeFrozen: boolean = true

Description

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

Readonly includeMetaData

includeMetaData: boolean = true

Description

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

Readonly limit

limit: number = DEFAULT_LIST_QUERY_LIMIT

Description

The maximum number of data per queried page.

Readonly membershipFilter

membershipFilter: MembershipFilter = MembershipFilter.ALL

Description

Membership filter.

Readonly metadataKey

metadataKey: null | string = null

Description

The metadataKey set with either metaDataValues or metaDataValueStartsWith.

Readonly metadataOrderKeyFilter

metadataOrderKeyFilter: null | string = null

Description

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

Readonly metadataValueStartsWith

metadataValueStartsWith: null | string = null

Description

Works exclusively with metaDataValues.

Readonly metadataValues

metadataValues: null | string[] = null

Description

Works exclusively with metaDataValueStartsWith.

Readonly order

order: PublicGroupChannelListOrder = PublicGroupChannelListOrder.CHRONOLOGICAL

Description

Result order of channels.

Readonly superChannelFilter

superChannelFilter: SuperChannelFilter = SuperChannelFilter.ALL

Description

Super channel filter.

Accessors

hasNext

  • get hasNext(): boolean

  • Returns boolean

    Description

    Whether there is a next page.

isLoading

  • get isLoading(): boolean

  • Returns boolean

    Description

    Whether the current query is in communication progress with server.

Methods

next

  • Returns Promise<GroupChannel[]>

    Description

    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.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc