interface PublicGroupChannelListQueryParams {
    channelNameContainsFilter?: string;
    channelUrlsFilter?: string[];
    customTypesFilter?: string[];
    customTypeStartsWithFilter?: string;
    includeEmpty?: boolean;
    includeFrozen?: boolean;
    includeMetaData?: boolean;
    limit?: number;
    membershipFilter?: MembershipFilter;
    metadataKey?: string;
    metadataOrderKeyFilter?: string;
    metadataValues?: string[];
    metadataValueStartsWith?: string;
    order?: PublicGroupChannelListOrder;
    superChannelFilter?: SuperChannelFilter;
}

Hierarchy

  • BaseListQueryParams
    • PublicGroupChannelListQueryParams

Properties

channelNameContainsFilter?: string

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[]

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?: string[]

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?: string

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

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

includeFrozen?: boolean

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

includeMetaData?: boolean

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

limit?: number

The maximum number of data per queried page.

membershipFilter?: MembershipFilter

Membership filter.

metadataKey?: string

The metadataKey set with either metaDataValues or metaDataValueStartsWith.

metadataOrderKeyFilter?: string

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?: string[]

Works exclusively with metaDataValueStartsWith.

metadataValueStartsWith?: string

Works exclusively with metaDataValues.

Result order of channels.

superChannelFilter?: SuperChannelFilter

Super channel filter.