List all channels

Get a paginated list of all channels with GetChannels(). Custom channel metadata is included by default.

Requires App Context

Enable App Context for your keyset in the Admin Portal.

With Access Manager enabled, uncheck Disallow Get All Channel Metadata in the App Context configuration to retrieve all channel metadata without defining permissions in the authentication token.

To list channels a user belongs to, use GetMemberships() instead.

Method signature

This method takes the following parameters:

1chat.GetChannels(
2    string filter = "",
3    string sort = "",
4    int limit = 0,
5    PNPageObject page = null
6)

Input

* required

Parameter	Description
filter Type: string Default: empty string	Expression used to filter the results. Returns only these memberships whose properties satisfy the given expression. The filter language is defined here.
sort Type: string Default: empty string	Key-value pair of a property to sort by, and a sort direction. Available options are id, name, and updated. Use asc or desc to specify the sorting direction, or specify null to take the default sorting direction (ascending). For example: {name: "asc"}. By default, the items are sorted by the last updated date.
limit Type: int Default: 0	Number of objects to return in response.
page Type: PNPageObject Default: null	Object used for pagination to define which previous or next result page you want to fetch.

Output

Type	Description
Task<ChannelsResponseWrapper>	An awaitable Task with the object containing the filtered, sorted, and paginated list of channels.

Sample code

Fetch all existing channel IDs.

1

Other examples

Pagination

Get the number of 25 channels and then specify that you want to fetch the results from the next page using a string previously returned from the PubNub server.

1