pubnub-kotlin-api/com.pubnub.api/PubNub/getAllChannelMetadata

getAllChannelMetadata

expect abstract fun getAllChannelMetadata(limit: Int? = null, page: PNPage? = null, filter: String? = null, sort: Collection<PNSortKey<PNKey>> = listOf(), includeCount: Boolean = false, includeCustom: Boolean = false): GetAllChannelMetadata

actual abstract fun getAllChannelMetadata(limit: Int?, page: PNPage?, filter: String?, sort: Collection<PNSortKey<PNKey>>, includeCount: Boolean, includeCustom: Boolean): GetAllChannelMetadata

Returns a paginated list of Channel Metadata objects, optionally including the custom data object for each.

Parameters

limit

Number of objects to return in the response. Default is 100, which is also the maximum value. Set limit to 0 (zero) and includeCount to true if you want to retrieve only a result count.

page

Use for pagination. - PNNext : Previously-returned cursor bookmark for fetching the next page. - PNPrev : Previously-returned cursor bookmark for fetching the previous page. Ignored if you also supply the start parameter.

filter

Expression used to filter the results. Only objects whose properties satisfy the given expression are returned.

sort

List of properties to sort by. Available options are id, name, and updated. @see PNAsc, PNDesc

includeCount

Request totalCount to be included in paginated response. By default, totalCount is omitted. Default is false.

includeCustom

Include respective additional fields in the response.

actual abstract fun getAllChannelMetadata(limit: Int?, page: PNPage?, filter: String?, sort: Collection<PNSortKey<PNKey>>, includeCount: Boolean, includeCustom: Boolean): GetAllChannelMetadata