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

getChannelMembers

expect abstract fun getChannelMembers(channel: String, limit: Int? = null, page: PNPage? = null, filter: String? = null, sort: Collection<PNSortKey<PNMemberKey>> = listOf(), include: MemberInclude = MemberInclude()): GetChannelMembers

expect abstract fun getChannelMembers(channel: String, limit: Int? = null, page: PNPage? = null, filter: String? = null, sort: Collection<PNSortKey<PNMemberKey>> = listOf(), includeCount: Boolean = false, includeCustom: Boolean = false, includeUUIDDetails: PNUUIDDetailsLevel? = null, includeType: Boolean = false): GetChannelMembers

actual abstract fun getChannelMembers(channel: String, limit: Int?, page: PNPage?, filter: String?, sort: Collection<PNSortKey<PNMemberKey>>, include: MemberInclude): GetChannelMembers

The method returns a list of members in a channel. The list will include user metadata for members that have additional metadata stored in the database.

Parameters

channel

Channel name

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

include

Request specific elements to be available in response. Use com.pubnub.api.models.consumer.objects.member.MemberInclude to easily create the desired configuration.

actual abstract fun ~~getChannelMembers~~(channel: String, limit: Int?, page: PNPage?, filter: String?, sort: Collection<PNSortKey<PNMemberKey>>, includeCount: Boolean, includeCustom: Boolean, includeUUIDDetails: PNUUIDDetailsLevel?, includeType: Boolean): GetChannelMembers

Deprecated

This function is deprecated. Use the new getChannelMembers(channel, limit, page, filter, sort, MembershipInclude(...))

Replace with

getChannelMembers(channel, limit, page, filter, sort, com.pubnub.api.models.consumer.objects.member.MemberInclude(includeTotalCount = includeCount, includeCustom = includeCustom, includeUser = true, includeUserCustom = true, includeUserType = includeUUIDType)

The method returns a list of members in a channel. The list will include user metadata for members that have additional metadata stored in the database.

Parameters

channel

Channel name

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

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.

includeUUIDDetails

Include custom fields for UUIDs metadata.

actual abstract fun getChannelMembers(channel: String, limit: Int?, page: PNPage?, filter: String?, sort: Collection<PNSortKey<PNMemberKey>>, include: MemberInclude): GetChannelMembers

actual abstract fun getChannelMembers(channel: String, limit: Int?, page: PNPage?, filter: String?, sort: Collection<PNSortKey<PNMemberKey>>, includeCount: Boolean, includeCustom: Boolean, includeUUIDDetails: PNUUIDDetailsLevel?, includeType: Boolean): GetChannelMembers