searchChannels
Search for channels based on various criteria.
This method allows you to search for channels based on parameters such as name, topic, categories, subscription status, and sorting options. The search can be refined using different filters and the results can be paginated.
Return
A RainbowResult containing a list of Channel objects matching the search criteria. In case of failure, it contains error details.
Parameters
The name of the channel to search for (optional). Can be used to search by exact or partial name.
The topic of the channel to search for (optional).
A list of categories to search within (optional). Only channels that match at least one of these categories will be returned.
A list of categories to exclude from the search (optional). Channels matching any of these categories will be excluded.
A Boolean indicating whether to filter by subscribed channels (optional). If null, includes both subscribed and non-subscribed channels.
The maximum number of channels to return (default value is 100).
The offset for pagination, allowing you to specify the position of the first channel to retrieve (default value is 0).
The field by which the channels will be sorted (default value is "name"). Allowed values: "name", "topic", "users_count", "subscribers_count".
The order in which the results should be sorted. Can be ascending (SORT_ASCENDING
) or descending (SORT_DESCENDING
).