On this page

App Context API for 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 store metadata about your application users and channels, and their membership associations, without running your own databases.

PubNub also triggers events when object data changes: set, update, or removal. Setting the same data again doesn't trigger an event. 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.

1val channel = pubnub.channel("channelName")
2

3channel.publish("This SDK rules!").async { result ->
4    result.onFailure { exception ->
5        // Handle error
6    }.onSuccess { value ->
7        // Handle successful method result
8    }
9}

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:

1pubnub.getAllUUIDMetadata(
  filter: String? = null,
  sort: Collection<PNSortKey<PNKey>> = listOf(),
  page: PNPage? = null,
  limit: Int? = null,
  includeCustom: Boolean = false,
  includeCount: Boolean = false
8).async { result -> }

* required

Parameter	Description
`filter` Type: `String?` Default: `null`	Filter expression. Only matching objects are returned. See filtering.
`sort` Type: `Collection<PNSortKey<PNKey>>` Default: `listOf()`	Sort by `ID`, `NAME`, `UPDATED`, `TYPE`, `STATUS` with asc/desc for sort direction (for example, `PNSortKey.asc(PNKey.STATUS)`).
`page` Type: `PNPage?` Default: `null`	Cursor-based pagination.
`limit` Type: `Int` Default: 100	Number of objects to return. Default/Max: 100.
`includeCustom` Type: `Boolean` Default: `false`	Whether to include the Custom object in the response.
`includeCount` Type: `Boolean` Default: `false`	Whether to include the total count in the paginated response. Default is false.

Sample code

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

Response

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

9data class PNUUIDMetadata(
  val id: String,
  val name: PatchValue<String?>? = null,
  val externalId: PatchValue<String?>? = null,
  val profileUrl: PatchValue<String?>? = null,
  val email: PatchValue<String?>? = null,
  val custom: PatchValue<Map<String, Any?>?>? = null,
  val updated: PatchValue<String>? = null,
  val eTag: PatchValue<String>? = null,
  val type: PatchValue<String?>? = null,
  val status: PatchValue<String?>? = null,
20)
show all 20 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:

1pubnub.getUUIDMetadata(
2    uuid: String? = null,
3    includeCustom: Boolean = false
4).async { result -> }

* required

Parameter	Description
`uuid` Type: `String` Default: `pubnub.configuration.uuid`	Unique UUID Metadata identifier. If not supplied, then UUID from configuration will be used.
`includeCustom` Type: `Boolean` Default: `false`	Whether to include the Custom object in the response.

Sample code

Response

1data class PNUUIDMetadataResult(
2    val status: Int,
3    val data: PNUUIDMetadata?
4)
5

6data class PNUUIDMetadata(
7    val id: String,
8    val name: PatchValue<String?>? = null,
9    val externalId: PatchValue<String?>? = null,
10    val profileUrl: PatchValue<String?>? = null,
11    val email: PatchValue<String?>? = null,
12    val custom: PatchValue<Map<String, Any?>?>? = null,
13    val updated: PatchValue<String>? = null,
14    val eTag: PatchValue<String>? = null,
15    val type: PatchValue<String?>? = null,
16    val status: PatchValue<String?>? = null,
17)
show all 17 lines

Set user metadata

Unsupported partial updates of custom metadata

The value of the custom metadata parameter sent in this method always overwrites the value stored on PubNub servers. If you want to add new custom data to an existing one, you must:

Get the existing metadata and store it locally.
Append the new custom metadata to the existing one.
Set the entire updated custom object.

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:

1pubnub.setUUIDMetadata(
  uuid: String? = null,
  includeCustom: Boolean = false,
  name: String? = null,
  externalId: String? = null,
  profileUrl: String? = null,
  email: String? = null,
  custom: Any? = null,
  type: String?,
  status: String?,
  ifMatchesEtag: String?
12).async { result -> }

* required

Parameter	Description
`uuid` Type: `String` Default: `pubnub.configuration.uuid`	Unique UUID Metadata identifier. If not supplied, then UUID from configuration will be used.
`includeCustom` Type: `Boolean` Default: `false`	Whether to include the custom field in the fetch response.
`name` Type: `String?` Default: `null`	Display name for the user.
`externalId` Type: `String?` Default: `null`	User's identifier in an external system
`profileUrl` Type: `String?` Default: `null`	The URL of the user's profile picture
`email` Type: `String?` Default: `null`	The user's email address.
`type` Type: `String?` Default: `null`	The custom type of the user.
`status` Type: `String?` Default: `null`	The custom type of the user.
`custom` Type: `Any?` Default: `null`	Any object of key-value pairs with supported data types. App Context filtering language doesn’t support filtering by custom properties.
`ifMatchesEtag` Type: String Default: n/a	Use the eTag from an applicable get metadata call to ensure updates only apply if the object hasn’t changed. If the eTags differ, the server returns HTTP 412.

API limits

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

Sample code

Response

1data class PNUUIDMetadataResult(
2    val status: Int,
3    val data: PNUUIDMetadata?
4)
5

6data class PNUUIDMetadata(
7    val id: String,
8    val name: PatchValue<String?>? = null,
9    val externalId: PatchValue<String?>? = null,
10    val profileUrl: PatchValue<String?>? = null,
11    val email: PatchValue<String?>? = null,
12    val custom: PatchValue<Map<String, Any?>?>? = null,
13    val updated: PatchValue<String>? = null,
14    val eTag: PatchValue<String>? = null,
15    val type: PatchValue<String?>? = null,
16    val status: PatchValue<String?>? = null,
17)
show all 17 lines

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:

1pubnub.removeUUIDMetadata(
2    uuid: String? = null
3).async { result -> }

* required

Parameter	Description
`uuid` Type: `String` Default: `pubnub.configuration.uuid`	Unique UUID Metadata identifier. If not supplied, then UUID from configuration will be used.

Sample code

Response

1data 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:

1pubnub.getAllChannelMetadata(
  filter: String? = null,
  sort: Collection<PNSortKey<PNKey>> = listOf(),
  page: PNPage? = null,
  limit: Int? = null,
  includeCustom: Boolean = false,
  includeCount: Boolean = false,
8).async { result -> }

* required

Parameter	Description
`filter` Type: `String?` Default: `null`	Filter expression. Only matching objects are returned. See filtering.
`sort` Type: `Collection<PNSortKey<PNKey>>` Default: `listOf()`	List of properties to sort by. Available options are `PNKey.ID`, `PNKey.NAME`, `PNKey.UPDATED`, `PNKey.TYPE`, `PNKey.STATUS`. Use `PNSortKey.asc` or `PNSortKey.desc` to specify sort direction. For example: `PNSortKey.asc(PNKey.STATUS)` , `PNSortKey.desc(PNKey.TYPE)`
`page` Type: `PNPage?` Default: `null`	The paging object used for pagination.
`limit` Type: `Int` Default: 100	The number of objects to retrieve at a time.
`includeCustom` Type: `Boolean` Default: `false`	Whether to include the `Custom` field in the fetch response.
`includeCount` Type: `Boolean` Default: `false`	Request `IncludeCount` to be included in paginated response. By default, `IncludeCount` is omitted.

Sample code

Response

1data class PNChannelMetadataArrayResult(
2    val status: Int,
3    val data: Collection<PNChannelMetadata>,
4    val totalCount: Int?,
5    val next: PNPage?,
6    val prev: PNPage?
7)
8

9data class PNChannelMetadata(
10    val id: String,
11    val name: PatchValue<String?>? = null,
12    val description: PatchValue<String?>? = null,
13    val custom: PatchValue<Map<String, Any?>?>? = null,
14    val updated: PatchValue<String>? = null,
15    val eTag: PatchValue<String>? = null,
16    val type: PatchValue<String?>? = null,
17    val status: PatchValue<String?>? = null,
18)
show all 18 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:

1pubnub.getChannelMetadata(
2    channel: String,
3    includeCustom: Boolean = false
4).async { result -> }

* required

Parameter	Description
`channel` Type: `String` Default: n/a	Channel name.
`includeCustom` Type: `Boolean` Default: `false`	Whether to include the custom field in the fetch response.

Sample code

Response

1data class PNChannelMetadataResult(
2    val status: Int,
3    val data: PNChannelMetadata?
4)
5

6data class PNChannelMetadata(
7    val id: String,
8    val name: PatchValue<String?>? = null,
9    val description: PatchValue<String?>? = null,
10    val custom: PatchValue<Map<String, Any?>?>? = null,
11    val updated: PatchValue<String>? = null,
12    val eTag: PatchValue<String>? = null,
13    val type: PatchValue<String?>? = null,
14    val status: PatchValue<String?>? = null,
15)

Set channel metadata

Unsupported partial updates of custom metadata

The value of the custom metadata parameter sent in this method always overwrites the value stored on PubNub servers. If you want to add new custom data to an existing one, you must:

Get the existing metadata and store it locally.
Append the new custom metadata to the existing one.
Set the entire updated custom object.

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:

1pubnub.setChannelMetadata(
  channel: String,
  includeCustom: Boolean = false,
  name: String? = null,
  description: String? = null,
  custom: Any? = null
  type: String?,
  status: String?,
  ifMatchesEtag: String?
10).async { result -> }

* required

Parameter	Description
`channel` Type: `String` Default: n/a	Channel name.
`includeCustom` Type: `Boolean` Default: `false`	Whether to include the custom field in the fetch response.
`name` Type: `String?` Default: `null`	Name for the channel.
`description` Type: `String?` Default: `null`	Description of a channel.
`type` Type: `String?` Default: `null`	The custom type of the channel.
`status` Type: `String?` Default: `null`	The custom type of the channel.
`custom` Type: `Any?` Default: `null`	Custom JSON values. Can be strings, numbers, or booleans. Filtering by Custom isn’t supported.
`ifMatchesEtag` Type: String Default: n/a	The entity tag to be used to ensure updates only happen if the object hasn't been modified since it was read. Use the eTag you received from an applicable get metadata method to check against the server entity tag. If the eTags don't match, an HTTP 412 error is thrown.

API limits

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

Sample code

Response

1data class PNChannelMetadataResult(
2    val status: Int,
3    val data: PNChannelMetadata?
4)
5

6data class PNChannelMetadata(
7    val id: String,
8    val name: PatchValue<String?>? = null,
9    val description: PatchValue<String?>? = null,
10    val custom: PatchValue<Map<String, Any?>?>? = null,
11    val updated: PatchValue<String>? = null,
12    val eTag: PatchValue<String>? = null,
13    val type: PatchValue<String?>? = null,
14    val status: PatchValue<String?>? = null,
15)

Other examples

Iteratively update existing metadata

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:

1pubnub.removeChannelMetadata(
2    channel: String
3).async { result -> }

* required

Parameter	Description
`channel` Type: `String` Default: n/a	Channel name.

Sample code

Response

1data 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:

1pubnub.getMemberships(
  userId: String? = null,
  limit: Int? = null,
  page: PNPage? = null,
  filter: String? = null,
  sort: Collection<PNSortKey<PNMembershipKey>> = listOf(),
  include: MembershipInclude = MembershipInclude(),
8).async { result -> }

* required

Parameter	Description
`userId` Type: `String` Default: `pubnub.configuration.userId.value`	Unique User Metadata identifier. If not supplied, then userId from configuration will be used.
`limit` Type: `Int` Default: 100	The number of objects to retrieve at a time.
`page` Type: `PNPage?` Default: `null`	The paging object used for pagination.
`filter` Type: `String?` Default: `null`	Filter expression. Only matching objects are returned. See filtering.
`sort` Type: `Collection<PNSortKey<PNMembershipKey>>` Default: `listOf()`	Sort by `CHANNEL_ID`, `CHANNEL_NAME`, `CHANNEL_UPDATED`, `CHANNEL_STATUS`, `CHANNEL_TYPE`, `UPDATED`, `STATUS`, `TYPE` with asc/desc for sort direction (for example, `PNSortKey.PNAsc(PNMembershipKey.TYPE)`).
`include` Type: `MembershipInclude` Default: `MembershipInclude()`	Object holding the configuration for whether to include additional data in the response.

Sample code

Response

1data class PNChannelMembershipArrayResult(
2    val status: Int,
3    val data: Collection<PNChannelMembership>,
4    val totalCount: Int?,
5    val next: PNPage?,
6    val prev: PNPage?
7)
8

9data class PNChannelMembership(
10    val channel: PNChannelMetadata,
11    val custom: PatchValue<Map<String, Any?>?>? = null,
12    val updated: String,
13    val eTag: String,
14    val status: PatchValue<String?>? = null,
15    val type: PatchValue<String?>? = null
16)
show all 16 lines

Set channel memberships

Set channel memberships for a User.

Method(s)

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

1pubnub.setMemberships(
  channels: List<ChannelMembershipInput>,
  userId: String? = null,
  limit: Int? = null,
  page: PNPage? = null,
  filter: String? = null,
  sort: Collection<PNSortKey<PNMembershipKey>>, = listOf(),
  include: MembershipInclude = MembershipInclude(),
9).async { result -> }

* required

Parameter	Description
`channels` Type: `List<ChannelMembershipInput>` Default: n/a	List of `ChannelMembershipInput` to add to membership with optional custom metadata, like status or type.
`userId` Type: `String` Default: `pubnub.configuration.userId.value`	Unique User Metadata identifier. If not supplied, then userId from configuration will be used.
`limit` Type: `Int` Default: 100	The number of objects to retrieve at a time.
`page` Type: `PNPage?` Default: `null`	The paging object used for pagination.
`filter` Type: `String?` Default: `null`	Filter expression. Only matching objects are returned. See filtering.
`sort` Type: `Collection<PNSortKey<PNMembershipKey>>` Default: `listOf()`	List of properties to sort by. Available options are `PNMembershipKey.CHANNEL_ID`, `PNMembershipKey.CHANNEL_NAME`, `PNMembershipKey.CHANNEL_UPDATED`, `PNMembershipKey.CHANNEL_STATUS`, `PNMembershipKey.CHANNEL_TYPE`, `PNMembershipKey.UPDATED`, `PNMembershipKey.STATUS` and `PNMembershipKey.TYPE`. Use `PNSortKey.PNAsc` or `PNSortKey.PNDesc` to specify sort direction. For example: `PNSortKey.PNAsc(PNMembershipKey.TYPE)` or `PNSortKey.PNDesc(PNMembershipKey.STATUS)`.
`include` Type: `MembershipInclude` Default: `MembershipInclude()`	Object holding the configuration for whether to include additional data in the response.

API limits

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

ChannelMembershipInput

* required

Parameter	Description
`channel` Type: `String`	The channel to add the membership to.
`custom` Type: `CustomObject`	Additional information about the membership.
`type` Type: `String`	The string description of the type of the membership.
`status` Type: `String`	The string description of the status of the membership.

Sample code

Response

1data class PNChannelMembershipArrayResult(
2    val status: Int,
3    val data: Collection<PNChannelMembership>,
4    val totalCount: Int?,
5    val next: PNPage?,
6    val prev: PNPage?
7)
8

9data class PNChannelMembership(
10    val channel: PNChannelMetadata,
11    val custom: PatchValue<Map<String, Any?>?>? = null,
12    val updated: String,
13    val eTag: String,
14    val status: PatchValue<String?>? = null,
15    val type: PatchValue<String?>? = null,
16)
show all 16 lines

Remove channel memberships

Remove channel memberships for a User.

Method(s)

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

1pubnub.removeMemberships(
  channels: List<String>,
  userId: String? = null,
  limit: Int? = null,
  page: PNPage? = null,
  filter: String? = null,
  sort: Collection<PNSortKey<PNMembershipKey>>, = listOf(),
  include: MembershipInclude = MembershipInclude(),
9).async { result -> }

* required

Parameter	Description
`channels` Type: `List<String>` Default: n/a	List of channels to remove from membership.
`userId` Type: `String` Default: `pubnub.configuration.userId.value`	Unique User Metadata identifier. If not supplied, then userId from configuration will be used.
`filter` Type: `String?` Default: `null`	Filter expression. Only matching objects are returned. See filtering.
`sort` Type: `Collection<PNSortKey<PNMembershipKey>>,` Default: `listOf()`	Sort by `CHANNEL_ID`, `CHANNEL_NAME`, `CHANNEL_UPDATED`, `CHANNEL_STATUS`, `CHANNEL_TYPE`, `UPDATED`, `STATUS`, `TYPE` with asc/desc for sort direction (for example, `PNSortKey.PNAsc(PNMembershipKey.TYPE)`).
`page` Type: `PNPage?` Default: `null`	Cursor-based pagination.
`limit` Type: `Int` Default: 100	Number of objects to return. Default/Max: 100.
`include` Type: `MembershipInclude` Default: `MembershipInclude()`	Whether to include additional fields.

Sample code

Response

1data class PNChannelMembershipArrayResult(
2    val status: Int,
3    val data: Collection<PNChannelMembership>,
4    val totalCount: Int?,
5    val next: PNPage?,
6    val prev: PNPage?
7)
8

9data class PNChannelMembership(
10    val channel: PNChannelMetadata,
11    val custom: PatchValue<Map<String, Any?>?>? = null,
12    val updated: String,
13    val eTag: String,
14    val status: PatchValue<String?>? = null,
15    val type: PatchValue<String?>? = null,
16)
show all 16 lines

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:

1pubnub.manageMemberships(
  channelsToSet: List<PNChannelWithCustom>,
  channelsToRemove: List<String>,
  userId: String? = null,
  limit: Int? = null,
  page: PNPage? = null,
  filter: String? = null,
  sort: Collection<PNSortKey<PNMembershipKey>>, = listOf(),
  include: MembershipInclude = MembershipInclude(),
10).async { result -> }

* required

Parameter	Description
`channelsToSet` Type: `List<PNChannelWithCustom>` Default: n/a	List of `PNChannelWithCustom` to add to membership.
`channelsToRemove` Type: `List<String>` Default: n/a	List of channels to remove from membership.
`userId` Type: `String` Default: `pubnub.configuration.userId.value`	Unique User Metadata identifier. If not supplied, then userId from configuration will be used.
`filter` Type: `String?` Default: `null`	Filter expression. Only matching objects are returned. See filtering.
`sort` Type: `Collection<PNSortKey<PNMembershipKey>>,` Default: `listOf()`	List of properties to sort by. Available options are `PNMembershipKey.CHANNEL_ID`, `PNMembershipKey.CHANNEL_NAME`, `PNMembershipKey.CHANNEL_UPDATED`, `PNMembershipKey.CHANNEL_STATUS`, `PNMembershipKey.CHANNEL_TYPE`, `PNMembershipKey.UPDATED`, `PNMembershipKey.STATUS` and `PNMembershipKey.TYPE`. Use `PNSortKey.PNAsc` or `PNSortKey.PNDesc` to specify sort direction. For example: `PNSortKey.PNAsc(PNMembershipKey.TYPE)` or `PNSortKey.PNDesc(PNMembershipKey.STATUS)`.
`page` Type: `PNPage?` Default: `null`	The paging object used for pagination.
`limit` Type: `Int` Default: 100	The number of objects to retrieve at a time.
`include` Type: `MembershipInclude` Default: `MembershipInclude()`	Object holding the configuration for whether to include additional data in the response.

Sample code

Response

1data class PNChannelMembershipArrayResult(
2    val status: Int,
3    val data: Collection<PNChannelMembership>,
4    val totalCount: Int?,
5    val next: PNPage?,
6    val prev: PNPage?
7)
8

9data class PNChannelMembership(
10    val channel: PNChannelMetadata,
11    val custom: PatchValue<Map<String, Any?>?>? = null,
12    val updated: String,
13    val eTag: String,
14    val status: PatchValue<String?>? = null,
15    val type: PatchValue<String?>? = null,
16)
show all 16 lines

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:

1pubnub.getChannelMembers(
  channel: String,
  limit: Int? = null,
  page: PNPage? = null,
  filter: String? = null,
  sort: Collection<PNSortKey<PNMemberKey>> = listOf(),
  include: MemberInclude = MemberInclude(),
8).async { result -> }

* required

Parameter	Description
`channel` Type: `String` Default: n/a	Channel name.
`limit` Type: `Int` Default: 100	The number of objects to retrieve at a time.
`page` Type: `PNPage?` Default: `null`	The paging object used for pagination.
`filter` Type: `String?` Default: `null`	Filter expression. Only matching objects are returned. See filtering.
`sort` Type: `Collection<PNSortKey<PNMemberKey>>` Default: `listOf()`	List of properties to sort by. Available options are `PNMemberKey.UUID_ID`, `PNMemberKey.UUID_NAME`,`PNMemberKey.UUID_UPDATED`, `PNMemberKey.UUID_NAME`,`PNMemberKey.UUID_TYPE`, `PNMemberKey.UPDATED`,`PNMemberKey.STATUS`, `PNMemberKey.TYPE`. Use `PNSortKey.PNAsc` or `PNSortKey.PNDesc` to specify sort direction. For example: `PNSortKey.PNAsc(PNMemberKey.TYPE)` or `PNSortKey.PNDesc(PNMemberKey.STATUS)`.
`include` Type: `MemberInclude` Default: `MemberInclude()`	Object holding the configuration for whether to include additional data in the response.

Sample code

Response

1data class PNMemberArrayResult(
2    val status: Int,
3    val data: Collection<PNMember>,
4    val totalCount: Int?,
5    val next: PNPage.PNNext?,
6    val prev: PNPage.PNPrev?
7)
8

9data class PNMember(
10    val uuid: PNUUIDMetadata?,
11    val custom: Any? = null,
12    val updated: Instant,
13    val eTag: String
14)

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:

1pubnub.setChannelMembers(
  channel: String,
  users: List<PNMember.Partial>,
  limit: Int? = null,
  page: PNPage? = null,
  filter: String? = null,
  sort: Collection<PNSortKey<PNMemberKey>> = listOf(),
  include: MemberInclude = MemberInclude(),
9).async { result, status ->
  if (status.error) {
      // handle error
  } else if (result != null) {
      // handle result
  }
15}

* required

Parameter	Description
`channel` * Type: `String` Default: n/a	Channel name.
`users` Type: `List<PNMember.Partial>` Default: n/a	List of members `PNMember.Partial` to add to channel.
`limit` Type: `Int` Default: 100	The number of objects to retrieve at a time.
`page` Type: `PNPage?` Default: `null`	The paging object used for pagination.
`filter` Type: `String?` Default: `null`	Filter expression. Only matching objects are returned. See filtering.
`sort` Type: `Collection<PNSortKey<PNMemberKey>>` Default: `listOf()`	List of properties to sort by. Available options are `PNMemberKey.UUID_ID`, `PNMemberKey.UUID_NAME`,`PNMemberKey.UUID_UPDATED`, `PNMemberKey.UUID_NAME`,`PNMemberKey.UUID_TYPE`, `PNMemberKey.UPDATED`,`PNMemberKey.STATUS`, `PNMemberKey.TYPE`. Use `PNSortKey.PNAsc` or `PNSortKey.PNDesc` to specify sort direction. For example: `PNSortKey.PNAsc(PNMemberKey.TYPE)` or `PNSortKey.PNDesc(PNMemberKey.STATUS)`.
`include` Type: `MemberInclude` Default: `MemberInclude()`	Object holding the configuration for whether to include additional data in the response.

API limits

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

Sample code

Response

1data class PNMemberArrayResult(
2    val status: Int,
3    val data: Collection<PNMember>,
4    val totalCount: Int?,
5    val next: PNPage.PNNext?,
6    val prev: PNPage.PNPrev?
7)
8

9data class PNMember(
10    val uuid: PNUUIDMetadata,
11    val custom: PatchValue<Map<String, Any?>?>? = null,
12    val updated: String,
13    val eTag: String,
14    val status: PatchValue<String?>?,
15    val type: PatchValue<String?>?,
16)
show all 16 lines

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:

1pubnub.removeChannelMembers(
  userIds: List<String>,
  channel: String,
  limit: Int? = null,
  page: PNPage? = null,
  filter: String? = null,
  sort: Collection<PNSortKey<PNMemberKey>> = listOf(),
  include: MemberInclude = MemberInclude(),
9).async { result -> }

* required

Parameter	Description
`userIds` Type: `List<String>` Default: n/a	List of members userIDs to remove from channel.
`channel` Type: `String` Default: n/a	Channel name.
`limit` Type: `Int` Default: 100	The number of objects to retrieve at a time.
`page` Type: `PNPage?` Default: `null`	The paging object used for pagination.
`filter` Type: `String?` Default: `null`	Filter expression. Only matching objects are returned. See filtering.
`sort` Type: `Collection<PNSortKey<PNMemberKey>>` Default: `listOf()`	List of properties to sort by. Available options are `PNMemberKey.UUID_ID`, `PNMemberKey.UUID_NAME`,`PNMemberKey.UUID_UPDATED`, `PNMemberKey.UUID_NAME`,`PNMemberKey.UUID_TYPE`, `PNMemberKey.UPDATED`,`PNMemberKey.STATUS`, `PNMemberKey.TYPE`. Use `PNSortKey.PNAsc` or `PNSortKey.PNDesc` to specify sort direction. For example: `PNSortKey.PNAsc(PNMemberKey.TYPE)` or `PNSortKey.PNDesc(PNMemberKey.STATUS)`.
`include` Type: `MemberInclude` Default: `MemberInclude()`	Object holding the configuration for whether to include additional data in the response.

Sample code

Response

1data class PNMemberArrayResult(
2    val status: Int,
3    val data: Collection<PNMember>,
4    val totalCount: Int?,
5    val next: PNPage.PNNext?,
6    val prev: PNPage.PNPrev?
7)
8

9data class PNMember(
10    val uuid: PNUUIDMetadata,
11    val custom: PatchValue<Map<String, Any?>?>? = null,
12    val updated: String,
13    val eTag: String,
14    val status: PatchValue<String?>?,
15    val type: PatchValue<String?>?,
16)
show all 16 lines

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:

1pubnub.manageChannelMembers(
  channel: String,
  usersToSet: List<PNMember.Partial>,
  userIdsToRemove: List<String>,
  limit: Int? = null,
  page: PNPage? = null,
  filter: String? = null,
  sort: Collection<PNSortKey<PNMemberKey>> = listOf(),
  include: MemberInclude = MemberInclude(),
10).async { result, status ->
  if (status.error) {
      // Handle error
  } else if (result != null) {
      // Handle successful result
  }
16}
show all 16 lines

* required

Parameter	Description
`channel` Type: `String` Default: n/a	Channel name.
`usersToSet` Type: `List<PNMember.Partial>` Default: n/a	List of members `PNMember.Partial` to add to the channel with optional custom metadata.
`userIdsToRemove` Type: `List<String>` Default: n/a	List of members userIds to remove from the channel.
`limit` Type: `Int?` Default: 100	The number of objects to retrieve at a time.
`page` Type: `PNPage?` Default: `null`	The paging object used for pagination.
`filter` Type: `String?` Default: `null`	Filter expression. Only matching objects are returned. See filtering.
`sort` Type: `Collection<PNSortKey<PNMemberKey>>` Default: `listOf()`	List of properties to sort by. Available options are `PNMemberKey.UUID_ID`, `PNMemberKey.UUID_NAME`,`PNMemberKey.UUID_UPDATED`, `PNMemberKey.UUID_NAME`,`PNMemberKey.UUID_TYPE`, `PNMemberKey.UPDATED`,`PNMemberKey.STATUS`, `PNMemberKey.TYPE`. Use `PNSortKey.PNAsc` or `PNSortKey.PNDesc` to specify sort direction. For example: `PNSortKey.PNAsc(PNMemberKey.TYPE)` or `PNSortKey.PNDesc(PNMemberKey.STATUS)`.
`include` Type: `MemberInclude` Default: `MemberInclude()`	Object holding the configuration for whether to include additional data in the response.

Sample code

Response

1data class PNMemberArrayResult(
2    val status: Int,
3    val data: Collection<PNMember>,
4    val totalCount: Int?,
5    val next: PNPage.PNNext?,
6    val prev: PNPage.PNPrev?
7)
8

9data class PNMember(
10    val uuid: PNUUIDMetadata,
11    val custom: PatchValue<Map<String, Any?>?>? = null,
12    val updated: String,
13    val eTag: String,
14    val status: PatchValue<String?>?,
15    val type: PatchValue<String?>?,
16)
show all 16 lines

Breaking changes in v9.0.0

Request execution

User​

Get metadata for all users​

Method(s)​

Sample code​

Reference code

Response​

Get user metadata​

Method(s)​

Sample code​

Response​

Set user metadata​

Unsupported partial updates of custom metadata

Method(s)​

API limits

Sample code​

Response​

Remove user metadata​

Method(s)​

Sample code​

Response​

Channel​

Get metadata for all channels​

Method(s)​

Sample code​

Response​

Get channel metadata​

Method(s)​

Sample code​

Response​

Set channel metadata​

Unsupported partial updates of custom metadata

Method(s)​

API limits

Sample code​

Response​

Other examples​

Iteratively update existing metadata​

Remove channel metadata​

Method(s)​

Sample code​

Response​

Channel memberships​

Get channel memberships​

Method(s)​

Sample code​

Response​

Set channel memberships​

Method(s)​

API limits

ChannelMembershipInput​

Sample code​

Response​

Remove channel memberships​

Method(s)​

Sample code​

Response​

Manage channel memberships​

Method(s)​

Sample code​

Response​

Channel members​

Get channel members​

Method(s)​

Sample code​

Response​

Set channel members​

Method(s)​

API limits

Sample code​

Response​

Remove channel members​

Method(s)​

Sample code​

Response​

Manage channel members​

Method(s)​

Sample code​

Response​

User

Get metadata for all users

Method(s)

Sample code

Response

Get user metadata

Method(s)

Sample code

Response

Set user metadata

Method(s)

Sample code

Response

Remove user metadata

Method(s)

Sample code

Response

Channel

Get metadata for all channels

Method(s)

Sample code

Response

Get channel metadata

Method(s)

Sample code

Response

Set channel metadata

Method(s)

Sample code

Response

Other examples

Iteratively update existing metadata

Remove channel metadata

Method(s)

Sample code

Response

Channel memberships

Get channel memberships

Method(s)

Sample code

Response

Set channel memberships

Method(s)

ChannelMembershipInput

Sample code

Response

Remove channel memberships

Method(s)

Sample code

Response

Manage channel memberships

Method(s)

Sample code

Response

Channel members

Get channel members

Method(s)

Sample code

Response

Set channel members

Method(s)

Sample code

Response

Remove channel members

Method(s)

Sample code

Response

Manage channel members

Method(s)

Sample code

Response