Hierarchy

  • BaseListQueryParams
    • PublicGroupChannelListQueryParams

Properties

channelNameContainsFilter?: string

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.

channelUrlsFilter?: string[]

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.

customTypeStartsWithFilter?: string

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.

customTypesFilter?: string[]

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.

includeEmpty?: boolean

Description

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

includeFrozen?: boolean

Description

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

includeMetaData?: boolean

Description

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

limit?: number

Description

The maximum number of data per queried page.

membershipFilter?: MembershipFilter

Description

Membership filter.

metadataKey?: string

Description

The metadataKey set with either metaDataValues or metaDataValueStartsWith.

metadataOrderKeyFilter?: string

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

metadataValueStartsWith?: string

Description

Works exclusively with metaDataValues.

metadataValues?: string[]

Description

Works exclusively with metaDataValueStartsWith.

Description

Result order of channels.

superChannelFilter?: SuperChannelFilter

Description

Super channel filter.

Generated using TypeDoc