UserMetadata Entity

As of version 9.0.0, the Kotlin software development kit (SDK) supports entities. Entities are SDK objects that bundle operations for a specific resource type and simplify working with PubNub application programming interfaces (APIs).

Use entities to perform common tasks without manually wiring requests. Some PubNub APIs are exposed via entities. Other operations remain available on the pubnub object.

Create UserMetadata

Use this factory method to return a local UserMetadata entity for a single user metadata object. A UserMetadata entity centralizes operations related to App Context user metadata.

pubnub.userMetadata(userId: String): UserMetadata

* required

Parameter	Description
userId * Type: String	Identifier of the user metadata object to manage.

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.

Available operations

The UserMetadata entity provides operations for PubNub App Context user metadata.

Operation (click for more information)	Description
subscription(subscriptionOptions)	Returns a local user metadata subscription object with optional parameters. You can then subscribe to receive real-time updates for that user metadata.