InterfaceGroupChannelListQueryParams

interface GroupChannelListQueryParams {
    channelNameContainsFilter?: string;
    channelUrlsFilter?: string[];
    createdAfter?: number;
    createdBefore?: number;
    customTypesFilter?: string[];
    customTypeStartsWithFilter?: string;
    hiddenChannelFilter?: HiddenChannelFilter;
    includeChatNotification?: boolean;
    includeEmpty?: boolean;
    includeFrozen?: boolean;
    includeMetaData?: boolean;
    limit?: number;
    metadataKey?: string;
    metadataOrderKeyFilter?: string;
    metadataValues?: string[];
    metadataValueStartsWith?: string;
    myMemberStateFilter?: MyMemberStateFilter;
    nicknameContainsFilter?: string;
    nicknameExactMatchFilter?: string;
    nicknameStartsWithFilter?: string;
    order?: GroupChannelListOrder;
    publicChannelFilter?: PublicChannelFilter;
    searchFilter?: GroupChannelSearchFilter;
    superChannelFilter?: SuperChannelFilter;
    unreadChannelFilter?: UnreadChannelFilter;
    userIdsFilter?: GroupChannelUserIdsFilter;
}

Hierarchy

  • BaseListQueryParams
  • default
    • GroupChannelListQueryParams

Properties

channelNameContainsFilter? channelUrlsFilter? createdAfter? createdBefore? customTypesFilter? customTypeStartsWithFilter? hiddenChannelFilter? includeChatNotification? includeEmpty? includeFrozen? includeMetaData? limit? metadataKey? metadataOrderKeyFilter? metadataValues? metadataValueStartsWith? myMemberStateFilter? nicknameContainsFilter? nicknameExactMatchFilter? nicknameStartsWithFilter? order? publicChannelFilter? searchFilter? superChannelFilter? unreadChannelFilter? userIdsFilter?

Properties

OptionalchannelNameContainsFilter

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".

OptionalchannelUrlsFilter

channelUrlsFilter?: string[]

List of channel URL filter. GroupChannel list of exactly matched channel URLs will be returned.

OptionalcreatedAfter

createdAfter?: number

Restricts the search scope to only retrieve group channels which have been created after the specified time, in milliseconds.

OptionalcreatedBefore

createdBefore?: number

Restricts the search scope to only retrieve group channels which have been created before the specified time, in milliseconds.

OptionalcustomTypesFilter

customTypesFilter?: string[]

List of custom type filter. GroupChannel list of exactly matched custom types will be returned.

OptionalcustomTypeStartsWithFilter

customTypeStartsWithFilter?: string

A filter to return channels that start with the specified customType.

OptionalhiddenChannelFilter

hiddenChannelFilter?: HiddenChannelFilter

Hidden channel filter. Refer to HiddenChannelFilter.

OptionalincludeChatNotification

includeChatNotification?: boolean

Whether to include chat notification channels.

OptionalincludeEmpty

includeEmpty?: boolean

Whether to include the channels with no message. (default: true)

OptionalincludeFrozen

includeFrozen?: boolean

Whether to include frozen channels or not. (default: true)

OptionalincludeMetaData

includeMetaData?: boolean

Whether to include channel metadata. (default: true)

Optionallimit

limit?: number

Description

The maximum number of data per queried page.

OptionalmetadataKey

metadataKey?: string

The metadataKey set with either metaDataValues or metaDataValueStartsWith.

OptionalmetadataOrderKeyFilter

metadataOrderKeyFilter?: string

Meta data order key filter. This filter will work only if order is GroupChannelListQueryOrder.METADATA_VALUE_ALPHABETICAL.

OptionalmetadataValues

metadataValues?: string[]

Works exclusively with metaDataValueStartsWith.

OptionalmetadataValueStartsWith

metadataValueStartsWith?: string

Works exclusively with metaDataValues.

OptionalmyMemberStateFilter

myMemberStateFilter?: MyMemberStateFilter

A filter to return channels with the current user state matching to MyMemberStateFilter.

OptionalnicknameContainsFilter

nicknameContainsFilter?: string

Searches for GroupChannels with members whose nicknames contain the specified value. If you pass nickname such as "abc", then the returned channel list will be containing member like "abc". This does not cooperate with other filters.

OptionalnicknameExactMatchFilter

nicknameExactMatchFilter?: string

Searches for GroupChannels with members whose nicknames match the specified value. This does not cooperate with other filters.

OptionalnicknameStartsWithFilter

nicknameStartsWithFilter?: string

Searches for GroupChannels with members whose nicknames starts with the specified value. If you pass nickname such as "abc", then the returned channel list will be containing member like "abc*". This does not cooperate with other filters.

Optionalorder

order?: GroupChannelListOrder

Result order of channels. Refer to GroupChannelListQueryOrder. GroupChannelListQueryOrder.METADATA_VALUE_ALPHABETICAL works only with metaDataOrderKeyFilter.

OptionalpublicChannelFilter

publicChannelFilter?: PublicChannelFilter

Public channel filter. Refer to PublicChannelFilter.

OptionalsearchFilter

searchFilter?: GroupChannelSearchFilter

Search fields. Refer to GroupChannelSearchFilter.

OptionalsuperChannelFilter

superChannelFilter?: SuperChannelFilter

Super channel filter. Refer to SuperChannelFilter.

OptionalunreadChannelFilter

unreadChannelFilter?: UnreadChannelFilter

Unread channel filter. Refer to UnreadChannelFilter.

OptionaluserIdsFilter

userIdsFilter?: GroupChannelUserIdsFilter

User IDs exact filter. Refer to GroupChannelUserIdsFilter

Settings

Member Visibility

On This Page

Properties