App Context API for PubNub Kotlin SDK

Breaking changes in v9.0.0

PubNub Kotlin SDK version 9.0.0 unifies the codebases for Kotlin and Java SDKs, introduces a new way of instantiating the PubNub client, and changes asynchronous API callbacks and emitted status events. These changes can impact applications built with previous versions (< 9.0.0 ) of the Kotlin SDK.

For more details about what has changed, refer to Java/Kotlin SDK migration guide.

This page describes App Context (formerly Objects v2). To upgrade from Objects v1, refer to the migration guide.

App Context provides easy-to-use, serverless storage for user and channel data you need to build innovative, reliable, scalable applications. Use App Context to easily store metadata about your application users and channels, and their membership associations, without the need to stand up your own databases.

PubNub also triggers events when object data is set or removed from the database. Clients can receive these events in real time and update their front-end application accordingly.

Request execution

Most PubNub Kotlin SDK method invocations return an Endpoint object, which allows you to decide whether to perform the operation synchronously or asynchronously.

You must invoke the .sync() or .async() method on the Endpoint to execute the request, or the operation will not be performed.

val channel = pubnub.channel("channelName")

channel.publish("This SDK rules!").async { result ->
    result.onFailure { exception ->
        // Handle error
    }.onSuccess { value ->
        // Handle successful method result
    }
}

User​

Get Metadata for All Users​

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

Method(s)​

To Get All UUID Metadata you can use the following method(s) in the Kotlin SDK:

pubnub.getAllUUIDMetadata(
    filter: String? = null,
    sort: Collection<PNSortKey> = listOf(),
    page: PNPage? = null,
    limit: Int? = null,
    includeCustom: Boolean = false,
    includeCount: Boolean = false
).async { result -> }
ParameterTypeRequiredDefaultDescription
filterString?OptionalnullExpression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here.
sortList<PNSortKey>OptionallistOf()List of properties to sort by. Available options are id, name, and updated. Use asc or desc to specify sort direction. For example: {name: 'asc'}
pagePNPage?OptionalnullThe paging object used for pagination.
limitIntOptional100The number of objects to retrieve at a time.
includeCustomBooleanOptionalfalseWhether to include the Custom field in the fetch response.
includeCountBooleanOptionalfalseRequest IncludeCount to be included in paginated response. By default, IncludeCount is omitted.

Basic Usage​

pubnub.getAllUUIDMetadata()
        .async { result ->
            result.onFailure { exception ->
                // Handle error
            }.onSuccess { value ->
                // Handle successful method result
            }
        }

Response​

data class PNUUIDMetadataArrayResult(
    val status: Int,
    val data: Collection<PNUUIDMetadata>,
    val totalCount: Int?,
    val next: PNPage?,
    val prev: PNPage?
)

data class PNUUIDMetadata(
    val id: String,
    val name: String? = null,
    val externalId: String?,
    val profileUrl: String?,
    val email: String?,
    val custom: Any?,
show all 18 lines

Get User Metadata​

Returns metadata for the specified UUID, optionally including the custom data object for each.

Method(s)​

To Get UUID Metadata you can use the following method(s) in the Kotlin SDK:

pubnub.getUUIDMetadata(
    uuid: String? = null,
    includeCustom: Boolean = false
).async { result -> }
ParameterTypeRequiredDefaultDescription
uuidStringOptionalpubnub.configuration.uuidUnique UUID Metadata identifier.
If not supplied, then UUID from configuration will be used.
includeCustomBooleanOptionalfalseWhether to include the custom field in the fetch response.

Basic Usage​

pubnub.getUUIDMetadata()
        .async { result ->
            result.onFailure { exception ->
                // Handle error
            }.onSuccess { value ->
                // Handle successful method result
            }
        }

Response​

data class PNUUIDMetadataResult(
    val status: Int,
    val data: PNUUIDMetadata?
)

data class PNUUIDMetadata(
    val id: String,
    val name: String? = null,
    val externalId: String?,
    val profileUrl: String?,
    val email: String?,
    val custom: Any?,
    val updated: Instant?,
    val eTag: String?
)

Set User Metadata​

Set metadata for a UUID in the database, optionally including the custom data object for each.

Method(s)​

To Set UUID Metadata you can use the following method(s) in the Kotlin SDK:

pubnub.setUUIDMetadata(
    uuid: String? = null,
    includeCustom: Boolean = false,
    name: String? = null,
    externalId: String? = null,
    profileUrl: String? = null,
    email: String? = null,
    custom: Any? = null,
).async { result -> }
ParameterTypeRequiredDefaultDescription
uuidStringOptionalpubnub.configuration.uuidUnique UUID Metadata identifier.
If not supplied, then UUID from configuration will be used.
includeCustomBooleanOptionalfalseWhether to include the custom field in the fetch response.
nameString?OptionalnullDisplay name for the user.
externalIdString?OptionalnullUser's identifier in an external system
profileUrlString?OptionalnullThe URL of the user's profile picture
emailString?OptionalnullThe user's email address.
customAny?OptionalnullAny object of key-value pairs with supported data types. App Context filtering language doesn’t support filtering by custom properties.
API limits

To learn about the maximum length of parameters used to set user metadata, refer to REST API docs.

Basic Usage​

pubnub.setUUIDMetadata()
        .async { result ->
            result.onFailure { exception ->
                // Handle error
            }.onSuccess { value ->
                // Handle successful method result
            }
        }

Response​

data class PNUUIDMetadataResult(
    val status: Int,
    val data: PNUUIDMetadata?
)

data class PNUUIDMetadata(
    val id: String,
    val name: String? = null,
    val externalId: String?,
    val profileUrl: String?,
    val email: String?,
    val custom: Any?,
    val updated: Instant?,
    val eTag: String?
)

Remove User Metadata​

Removes the metadata from a specified UUID.

Method(s)​

To Remove UUID Metadata you can use the following method(s) in the Kotlin SDK:

pubnub.removeUUIDMetadata(
    uuid: String? = null
).async { result -> }
ParameterTypeRequiredDefaultDescription
uuidStringOptionalpubnub.configuration.uuidUnique UUID Metadata identifier.
If not supplied, then UUID from configuration will be used.

Basic Usage​

pubnub.removeUUIDMetadata()
        .async { result ->
            result.onFailure { exception ->
                // Handle error
            }.onSuccess { value ->
                // Handle successful method result
            }
        }

Response​

data class PNRemoveMetadataResult(private val status: Int)

Channel​

Get Metadata for All Channels​

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

Method(s)​

To Get All Channel Metadata you can use the following method(s) in the Kotlin SDK:

pubnub.getAllChannelMetadata(
    filter: String? = null,
    sort: Collection<PNSortKey> = listOf(),
    page: PNPage? = null,
    limit: Int? = null,
    includeCustom: Boolean = false,
    includeCount: Boolean = false,
).async { result -> }
ParameterTypeRequiredDefaultDescription
filterString?OptionalnullExpression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here.
sortList<PNSortKey>OptionallistOf()List of properties to sort by. Available options are id, name, and updated. Use asc or desc to specify sort direction. For example: {name: 'asc'}
pagePNPage?OptionalnullThe paging object used for pagination.
limitIntOptional100The number of objects to retrieve at a time.
includeCustomBooleanOptionalfalseWhether to include the Custom field in the fetch response.
includeCountBooleanOptionalfalseRequest IncludeCount to be included in paginated response. By default, IncludeCount is omitted.

Basic Usage​

pubnub.getAllChannelMetadata()
        .async { result ->
            result.onFailure { exception ->
                // Handle error
            }.onSuccess { value ->
                // Handle successful method result
            }
        }

Response​

data class PNChannelMetadataArrayResult(
    val status: Int,
    val data: Collection<PNChannelMetadata>,
    val totalCount: Int?,
    val next: PNPage?,
    val prev: PNPage?
)

data class PNChannelMetadata(
    val id: String,
    val name: String?,
    val description: String?,
    val custom: Any?,
    val updated: Instant?,
    val eTag: String?
show all 16 lines

Get Channel Metadata​

Returns metadata for the specified Channel, optionally including the custom data object for each.

Method(s)​

To Get Channel Metadata you can use the following method(s) in the Kotlin SDK:

pubnub.getChannelMetadata(
    channel: String,
    includeCustom: Boolean = false
).async { result -> }
ParameterTypeRequiredDefaultDescription
channelStringyesChannel name.
includeCustomBooleanOptionalfalseWhether to include the custom field in the fetch response.

Basic Usage​

pubnub.getChannelMetadata(channel = "myChannel")
        .async { result ->
            result.onFailure { exception ->
                // Handle error
            }.onSuccess { value ->
                // Handle successful method result
            }
        }

Response​

data class PNChannelMetadataResult(
    val status: Int,
    val data: PNChannelMetadata?
)

data class PNChannelMetadata(
    val id: String,
    val name: String?,
    val description: String?,
    val custom: Any?,
    val updated: Instant?,
    val eTag: String?
)

Set Channel Metadata​

Set metadata for a Channel in the database, optionally including the custom data object for each.

Method(s)​

To Set Channel Metadata you can use the following method(s) in the Kotlin SDK:

pubnub.setChannelMetadata(
    channel: String,
    includeCustom: Boolean = false,
    name: String? = null,
    description: String? = null,
    custom: Any? = null
).async { result -> }
ParameterTypeRequiredDefaultDescription
channelStringyesChannel name.
includeCustomBooleanOptionalfalseWhether to include the custom field in the fetch response.
nameString?OptionalnullName for the channel.
descriptionString?OptionalnullDescription of a channel.
customAny?OptionalnullAny object of key-value pairs with supported data types. App Context filtering language doesn’t support filtering by custom properties.
API limits

To learn about the maximum length of parameters used to set channel metadata, refer to REST API docs.

Basic Usage​

pubnub.setChannelMetadata(channel = "myChannel")
        .async { result ->
            result.onFailure { exception ->
                // Handle error
            }.onSuccess { value ->
                // Handle successful method result
            }
        }

Response​

data class PNChannelMetadataResult(
    val status: Int,
    val data: PNChannelMetadata?
)

data class PNChannelMetadata(
    val id: String,
    val name: String?,
    val description: String?,
    val custom: Any?,
    val updated: Instant?,
    val eTag: String?
)

Remove Channel Metadata​

Removes the metadata from a specified channel.

Method(s)​

To Remove Channel Metadata you can use the following method(s) in the Kotlin SDK:

pubnub.removeChannelMetadata(
    channel: String
).async { result -> }
ParameterTypeRequiredDefaultDescription
channelStringyesChannel name.

Basic Usage​

pubnub.removeChannelMetadata(channel = "myChannel")
        .async { result ->
            result.onFailure { exception ->
                // Handle error
            }.onSuccess { value ->
                // Handle successful method result
            }
        }

Response​

data class PNRemoveMetadataResult(private val status: Int)

Channel Memberships​

Get Channel Memberships​

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

Method(s)​

To Get Channel Memberships you can use the following method(s) in the Kotlin SDK:

pubnub.getMemberships(
    uuid: String? = null,
    filter: String? = null,
    sort: Collection<PNSortKey> = listOf(),
    page: PNPage? = null,
    limit: Int? = null,
    includeCustom: Boolean = false,
    includeCount: Boolean = false,
    includeChannelDetails: PNChannelDetailsLevel? = null
).async { result -> }
ParameterTypeRequiredDefaultDescription
uuidStringOptionalpubnub.configuration.uuidUnique UUID Metadata identifier.
If not supplied, then UUID from configuration will be used.
filterString?OptionalnullExpression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here.
sortList<PNSortKey>OptionallistOf()List of properties to sort by. Available options are id, name, and updated. Use asc or desc to specify sort direction. For example: {name: 'asc'}
pagePNPage?OptionalnullThe paging object used for pagination.
limitIntOptional100The number of objects to retrieve at a time.
includeCustomBooleanOptionalfalseWhether to include the Custom field in the fetch response.
includeCountBooleanOptionalfalseRequest IncludeCount to be included in paginated response. By default, IncludeCount is omitted.
includeChannelDetailsPNChannelDetailsLevel?OptionalnullThe level of channel details to return in the membership. Possible values are: PNChannelDetailsLevel.CHANNEL which include basic channel information and PNChannelDetailsLevel.CHANNEL_WITH_CUSTOM which includes additionally custom field

Basic Usage​

pubnub.getMemberships()
        .async { result ->
            result.onFailure { exception ->
                // Handle error
            }.onSuccess { value ->
                // Handle successful method result
            }
        }

Response​

data class PNChannelMembershipArrayResult(
    val status: Int,
    val data: Collection<PNChannelMembership>,
    val totalCount: Int?,
    val next: PNPage?,
    val prev: PNPage?
)

data class PNChannelMembership(
    val channel: PNChannelMetadata?,
    val custom: Any?,
    val updated: Instant,
    val eTag: String
)

Set Channel Memberships​

Set channel memberships for a UUID.

Method(s)​

To Set Channel Memberships you can use the following method(s) in the Kotlin SDK:

pubnub.setMemberships(
    channels: List<PNChannelWithCustom>,
    uuid: String? = null,
    filter: String? = null,
    sort: Collection<PNSortKey> = listOf(),
    page: PNPage? = null,
    limit: Int? = null,
    includeCount: Boolean = false,
    includeCustom: Boolean = false,
    includeChannelDetails: PNChannelDetailsLevel? = null
).async { result -> }
ParameterTypeRequiredDefaultDescription
channelsList<PNChannelWithCustom>yesList of PNChannelWithCustom to add to membership with optional custom metadata.
uuidStringOptionalpubnub.configuration.uuidUnique UUID Metadata identifier.
If not supplied, then UUID from configuration will be used.
filterString?OptionalnullExpression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here.
sortList<PNSortKey>OptionallistOf()List of properties to sort by. Available options are id, name, and updated. Use asc or desc to specify sort direction. For example: {name: 'asc'}
pagePNPage?OptionalnullThe paging object used for pagination.
limitIntOptional100The number of objects to retrieve at a time.
includeCountBooleanOptionalfalseRequest IncludeCount to be included in paginated response. By default, IncludeCount is omitted.
includeCustomBooleanOptionalfalseWhether to include the Custom field in the fetch response.
includeChannelDetailsPNChannelDetailsLevel?OptionalnullThe level of channel details to return in the membership. Possible values are: PNChannelDetailsLevel.CHANNEL which include basic channel information and PNChannelDetailsLevel.CHANNEL_WITH_CUSTOM which additionally includes the custom field.
API limits

To learn about the maximum length of parameters used to set channel membership metadata, refer to REST API docs.

Basic Usage​

pubnub.setMemberships(listOf(PNChannelWithCustom(channel = "myChannel")))
        .async { result ->
            result.onFailure { exception ->
                // Handle error
            }.onSuccess { value ->
                // Handle successful method result
            }
        }

Response​

data class PNChannelMembershipArrayResult(
    val status: Int,
    val data: Collection<PNChannelMembership>,
    val totalCount: Int?,
    val next: PNPage?,
    val prev: PNPage?
)

data class PNChannelMembership(
    val channel: PNChannelMetadata?,
    val custom: Any?,
    val updated: Instant,
    val eTag: String
)

Remove Channel Memberships​

Remove channel memberships for a UUID.

Method(s)​

To Remove Channel Memberships you can use the following method(s) in the Kotlin SDK:

pubnub.removeMemberships(
    channels: List<String>,
    uuid: String? = null,
    filter: String? = null,
    sort: Collection<PNSortKey> = listOf(),
    page: PNPage? = null,
    limit: Int? = null,
    includeCount: Boolean = false,
    includeCustom: Boolean = false,
    includeChannelDetails: PNChannelDetailsLevel? = null
).async { result -> }
ParameterTypeRequiredDefaultDescription
channelsList<String>yesList of channels to remove from membership.
uuidStringOptionalpubnub.configuration.uuidUnique UUID Metadata identifier.
If not supplied, then UUID from configuration will be used.
filterString?OptionalnullExpression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here.
sortList<PNSortKey>OptionallistOf()List of properties to sort by. Available options are id, name, and updated. Use asc or desc to specify sort direction. For example: {name: 'asc'}
pagePNPage?OptionalnullThe paging object used for pagination.
limitIntOptional100The number of objects to retrieve at a time.
includeCountBooleanOptionalfalseRequest IncludeCount to be included in paginated response. By default, IncludeCount is omitted.
includeCustomBooleanOptionalfalseWhether to include the Custom field in the fetch response.
includeChannelDetailsPNChannelDetailsLevel?OptionalnullThe level of channel details to return in the membership. Possible values are: PNChannelDetailsLevel.CHANNEL which include basic channel information and PNChannelDetailsLevel.CHANNEL_WITH_CUSTOM which includes additionally custom field

Basic Usage​

pubnub.removeMemberships(listOf("myChannel"))
        .async { result ->
            result.onFailure { exception ->
                // Handle error
            }.onSuccess { value ->
                // Handle successful method result
            }
        }

Response​

data class PNChannelMembershipArrayResult(
    val status: Int,
    val data: Collection<PNChannelMembership>,
    val totalCount: Int?,
    val next: PNPage?,
    val prev: PNPage?
)

data class PNChannelMembership(
    val channel: PNChannelMetadata?,
    val custom: Any?,
    val updated: Instant,
    val eTag: String
)

Manage Channel Memberships​

Manage a user's channel memberships.

Method(s)​

To Manage Memberships you can use the following method(s) in the Kotlin SDK:

pubnub.manageMemberships(
    channelsToSet: List<PNChannelWithCustom>,
    channelsToRemove: List<String>,
    uuid: String? = null,
    filter: String? = null,
    sort: Collection<PNSortKey> = listOf(),
    page: PNPage? = null,
    limit: Int? = null,
    includeCustom: Boolean = false,
    includeCount: Boolean = false,
    includeChannelDetails: PNChannelDetailsLevel? = null
).async { result -> }
ParameterTypeRequiredDefaultDescription
channelsToSetList<PNChannelWithCustom>yesList of PNChannelWithCustom to add to membership.
channelsToRemoveList<String>yesList of channels to remove from membership.
uuidStringOptionalpubnub.configuration.uuidUnique UUID Metadata identifier.
If not supplied, then UUID from configuration will be used.
filterString?OptionalnullExpression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here.
sortList<PNSortKey>OptionallistOf()List of properties to sort by. Available options are id, name, and updated. Use asc or desc to specify sort direction. For example: {name: 'asc'}
pagePNPage?OptionalnullThe paging object used for pagination.
limitIntOptional100The number of objects to retrieve at a time.
includeCustomBooleanOptionalfalseWhether to include the Custom field in the fetch response.
includeCountBooleanOptionalfalseRequest IncludeCount to be included in paginated response. By default, IncludeCount is omitted.
includeChannelDetailsPNChannelDetailsLevel?OptionalnullThe level of channel details to return in the membership. Possible values are: PNChannelDetailsLevel.CHANNEL which include basic channel information and PNChannelDetailsLevel.CHANNEL_WITH_CUSTOM which includes additionally custom field.

Basic Usage​

pubnub.manageMemberships(
    channelsToSet = listOf(PNChannelWithCustom(channel = "myChannelToSet")),
    channelsToRemove = listOf("myChannelToRemove")
).async { result ->
    result.onFailure { exception ->
        // Handle error
    }.onSuccess { value ->
        // Handle successful method result
    }
}

Response​

data class PNChannelMembershipArrayResult(
    val status: Int,
    val data: Collection<PNChannelMembership>,
    val totalCount: Int?,
    val next: PNPage?,
    val prev: PNPage?
)

data class PNChannelMembership(
    val channel: PNChannelMetadata?,
    val custom: Any?,
    val updated: Instant,
    val eTag: String
)

Channel Members​

Get Channel Members​

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.

Method(s)​

To Get Channel Members you can use the following method(s) in the Kotlin SDK:

pubnub.getChannelMembers(
    channel: String,
    filter: String? = null,
    sort: Collection<PNSortKey> = listOf(),
    page: PNPage? = null,
    limit: Int? = null,
    includeCustom: Boolean = false,
    includeCount: Boolean = false,
    includeUUIDDetails: PNUUIDDetailsLevel? = null
).async { result -> }
ParameterTypeRequiredDefaultDescription
channelStringyesChannel name.
filterString?OptionalnullExpression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here.
sortList<PNSortKey>OptionallistOf()List of properties to sort by. Available options are id, name, and updated. Use asc or desc to specify sort direction. For example: {name: 'asc'}
pagePNPage?OptionalnullThe paging object used for pagination.
limitIntOptional100The number of objects to retrieve at a time.
includeCustomBooleanOptionalfalseWhether to include the Custom field in the fetch response.
includeCountBooleanOptionalfalseRequest IncludeCount to be included in paginated response. By default, IncludeCount is omitted.
includeUUIDDetailsPNUUIDDetailsLevel?OptionalnullThe level of UUID details to return. Possible values are: PNUUIDDetailsLevel.UUID which include basic UUID information and PNUUIDDetailsLevel.UUID_WITH_CUSTOM which includes additionally custom field.

Basic Usage​

pubnub.getChannelMembers()
        .async { result ->
            result.onFailure { exception ->
                // Handle error
            }.onSuccess { value ->
                // Handle successful method result
            }
        }

Response​

data class PNMemberArrayResult(
    val status: Int,
    val data: Collection<PNMember>,
    val totalCount: Int?,
    val next: PNPage.PNNext?,
    val prev: PNPage.PNPrev?
)

data class PNMember(
    val uuid: PNUUIDMetadata?,
    val custom: Any? = null,
    val updated: Instant,
    val eTag: String
)

Set Channel Members​

This method sets members in a channel.

Method(s)​

To Set Channel Members you can use the following method(s) in the Kotlin SDK:

pubnub.setChannelMembers(
    uuids: List<PNMember.Partial>,
    channel: String,
    filter: String? = null,
    sort: Collection<PNSortKey> = listOf(),
    page: PNPage? = null,
    limit: Int? = null,
    includeCustom: Boolean = false,
    includeCount: Boolean = false,
    includeUUIDDetails: PNUUIDDetailsLevel? = null
).async { result, status ->
    if (status.error) {
        // handle error
    } else if (result != null) {
        // handle result
show all 17 lines
ParameterTypeRequiredDefaultDescription
uuidsList<PNMember.Partial>yesList of members PNMember.Partial to add to channel.
channelStringyesChannel name.
filterString?OptionalnullExpression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here.
sortList<PNSortKey>OptionallistOf()List of properties to sort by. Available options are id, name, and updated. Use asc or desc to specify sort direction. For example: {name: 'asc'}
pagePNPage?OptionalnullThe paging object used for pagination.
limitIntOptional100The number of objects to retrieve at a time.
includeCustomBooleanOptionalfalseWhether to include the Custom field in the fetch response.
includeCountBooleanOptionalfalseRequest IncludeCount to be included in paginated response. By default, IncludeCount is omitted.
includeUUIDDetailsPNUUIDDetailsLevel?OptionalnullThe level of UUID details to return. Possible values are: PNUUIDDetailsLevel.UUID which include basic UUID information and PNUUIDDetailsLevel.UUID_WITH_CUSTOM which additionally includes the custom field.
API limits

To learn about the maximum length of parameters used to set channel members metadata, refer to REST API docs.

Basic Usage​

pubnub.setChannelMembers(
    channel = "myChannel", 
    uuids = listOf(
        PNMember.Partial(uuid = "myUuid", custom = mapOf("custom" to "customValue"), status = "status")
    )
).async { result, status ->
    if (status.error) {
        // Handle error
    } else if (result != null) {
        // Handle successful method result
    }
}

Response​

data class PNMemberArrayResult(
    val status: Int,
    val data: Collection<PNMember>,
    val totalCount: Int?,
    val next: PNPage.PNNext?,
    val prev: PNPage.PNPrev?
)

data class PNMember(
    val uuid: PNUUIDMetadata?,
    val custom: Any? = null,
    val updated: Instant,
    val eTag: String
)

Remove Channel Members​

Remove members from a Channel.

Method(s)​

To Remove Channel Members you can use the following method(s) in the Kotlin SDK:

pubnub.removeChannelMembers(
    uuids: List<String>,
    channel: String,
    filter: String? = null,
    sort: Collection<PNSortKey> = listOf(),
    page: PNPage? = null,
    limit: Int? = null,
    includeCustom: Boolean = false,
    includeCount: Boolean = false,
    includeUUIDDetails: PNUUIDDetailsLevel? = null
).async { result -> }
ParameterTypeRequiredDefaultDescription
uuidsList<String>yesList of members UUIDs to remove from channel.
channelStringyesChannel name.
filterString?OptionalnullExpression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here.
sortList<PNSortKey>OptionallistOf()List of properties to sort by. Available options are id, name, and updated. Use asc or desc to specify sort direction. For example: {name: 'asc'}
pagePNPage?OptionalnullThe paging object used for pagination.
limitIntOptional100The number of objects to retrieve at a time.
includeCustomBooleanOptionalfalseWhether to include the Custom field in the fetch response.
includeCountBooleanOptionalfalseRequest IncludeCount to be included in paginated response. By default, IncludeCount is omitted.
includeUUIDDetailsPNUUIDDetailsLevel?OptionalnullThe level of UUID details to return. Possible values are: PNUUIDDetailsLevel.UUID which include basic UUID information and PNUUIDDetailsLevel.UUID_WITH_CUSTOM which includes additionally custom field.

Basic Usage​

pubnub.removeChannelMembers(channel = "myChannel", uuids = listOf("myUuid"))
        .async { result ->
            result.onFailure { exception ->
                // Handle error
            }.onSuccess { value ->
                // Handle successful method result
            }
        }

Response​

data class PNMemberArrayResult(
    val status: Int,
    val data: Collection<PNMember>,
    val totalCount: Int?,
    val next: PNPage.PNNext?,
    val prev: PNPage.PNPrev?
)

data class PNMember(
    val uuid: PNUUIDMetadata?,
    val custom: Any? = null,
    val updated: Instant,
    val eTag: String
)

Manage Channel Members​

Set and Remove channel memberships for a user.

Method(s)​

To Manage Channel Members you can use the following method(s) in the Kotlin SDK:

pubnub.manageChannelMembers(
    uuidsToSet: List<PNMember.Partial>,
    uuidsToRemove: List<String>,
    channel: String,
    filter: String? = null,
    sort: Collection<PNSortKey> = listOf(),
    page: PNPage? = null,
    limit: Int? = null,
    includeCustom: Boolean = false,
    includeCount: Boolean = false,
    includeUUIDDetails: PNUUIDDetailsLevel? = null
).async { result, status ->
    if (status.error) {
        // Handle error
    } else if (result != null) {
show all 18 lines
ParameterTypeRequiredDefaultDescription
uuidsToSetList<PNMember.Partial>yesList of members PNMember.Partial to add to the channel with optional custom metadata.
uuidsToRemoveList<String>yesList of members UUIDs to remove from the channel.
channelStringyesChannel name.
filterString?OptionalnullExpression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here.
sortList<PNSortKey>OptionallistOf()List of properties to sort by. Available options are id, name, and updated. Use asc or desc to specify sort direction. For example: {name: 'asc'}
pagePNPage?OptionalnullThe paging object used for pagination.
limitInt?Optional100The number of objects to retrieve at a time.
includeCustomBooleanOptionalfalseWhether to include the Custom field in the fetch response.
includeCountBooleanOptionalfalseRequest IncludeCount to be included in the paginated response. By default, IncludeCount is omitted.
includeUUIDDetailsPNUUIDDetailsLevel?OptionalnullThe level of UUID details to return. Possible values are: PNUUIDDetailsLevel.UUID which includes basic UUID information, and PNUUIDDetailsLevel.UUID_WITH_CUSTOM which additionally includes the custom field.

Basic Usage​

pubnub.setChannelMembers(
    channel = "myChannel",
    uuidsToSet = listOf(
        PNMember.Partial(uuid = "myUuidToSet", custom = mapOf("custom" to "customValue"), status = "status")
    ),
    uuidsToRemove = listOf("myUuidToRemove")
).async { result, status ->
    if (status.error) {
        // Handle error
    } else if (result != null) {
        result.channels.values.forEach { channelData ->
            println("---")
            println("Channel: ${channelData.channelName}")
            println("Occupancy: ${channelData.occupancy}")
            println("Occupants:")
show all 21 lines

Response​

data class PNMemberArrayResult(
    val status: Int,
    val data: Collection<PNMember>,
    val totalCount: Int?,
    val next: PNPage.PNNext?,
    val prev: PNPage.PNPrev?
)

data class PNMember(
    val uuid: PNUUIDMetadata?,
    val custom: Any? = null,
    val updated: Instant,
    val eTag: String
)
Last updated on
On this page