interface GroupChannelFilterParams {
    channelNameContainsFilter?: string;
    channelUrlsFilter?: string[];
    createdAfter?: number;
    createdBefore?: number;
    customTypesFilter?: string[];
    customTypeStartsWithFilter?: string;
    hiddenChannelFilter?: HiddenChannelFilter;
    includeEmpty?: boolean;
    includeFrozen?: boolean;
    includeMetaData?: boolean;
    myMemberStateFilter?: MyMemberStateFilter;
    nicknameContainsFilter?: string;
    nicknameExactMatchFilter?: string;
    nicknameStartsWithFilter?: string;
    publicChannelFilter?: PublicChannelFilter;
    superChannelFilter?: SuperChannelFilter;
    unreadChannelFilter?: UnreadChannelFilter;
}

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.

createdAfter?: number

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

createdBefore?: number

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

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.

hiddenChannelFilter?: HiddenChannelFilter

Hidden channel filter.

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. (default: true)

myMemberStateFilter?: MyMemberStateFilter

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

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.

nicknameExactMatchFilter?: string

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

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.

publicChannelFilter?: PublicChannelFilter

Public channel filter.

superChannelFilter?: SuperChannelFilter

Super channel filter.

unreadChannelFilter?: UnreadChannelFilter

Unread channel filter.