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

getMemberships

expect abstract fun getMemberships(userId: String? = null, limit: Int? = null, page: PNPage? = null, filter: String? = null, sort: Collection<PNSortKey<PNMembershipKey>> = listOf(), include: MembershipInclude = MembershipInclude()): GetMemberships

expect abstract fun getMemberships(uuid: String? = null, limit: Int? = null, page: PNPage? = null, filter: String? = null, sort: Collection<PNSortKey<PNMembershipKey>> = listOf(), includeCount: Boolean = false, includeCustom: Boolean = false, includeChannelDetails: PNChannelDetailsLevel? = null, includeType: Boolean = false): GetMemberships

actual abstract fun getMemberships(userId: String?, limit: Int?, page: PNPage?, filter: String?, sort: Collection<PNSortKey<PNMembershipKey>>, include: MembershipInclude): GetMemberships

The method returns a list of channel memberships for a user. This method doesn't return a user's subscriptions.

Parameters

userId

Unique user identifier. If not supplied then current user’s id is used.

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.membership.MembershipInclude to easily create the desired configuration.

actual abstract fun ~~getMemberships~~(uuid: String?, limit: Int?, page: PNPage?, filter: String?, sort: Collection<PNSortKey<PNMembershipKey>>, includeCount: Boolean, includeCustom: Boolean, includeChannelDetails: PNChannelDetailsLevel?, includeType: Boolean): GetMemberships

Deprecated

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

Replace with

getMemberships(userId, limit, page, filter, sort, com.pubnub.api.models.consumer.objects.membership.MembershipInclude(includeTotalCount = includeCount, includeCustom = includeCustom, includeChannel = true, includeChannelCustom = true, includeType = includeType))

The method returns a list of channel memberships for a user. This method doesn't return a user's subscriptions.

Parameters

uuid

Unique user identifier. If not supplied then current user’s uuid is used.

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.

includeChannelDetails

Include custom fields for channels metadata.

actual abstract fun getMemberships(userId: String?, limit: Int?, page: PNPage?, filter: String?, sort: Collection<PNSortKey<PNMembershipKey>>, include: MembershipInclude): GetMemberships

actual abstract fun getMemberships(uuid: String?, limit: Int?, page: PNPage?, filter: String?, sort: Collection<PNSortKey<PNMembershipKey>>, includeCount: Boolean, includeCustom: Boolean, includeChannelDetails: PNChannelDetailsLevel?, includeType: Boolean): GetMemberships