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

grantToken

expect abstract fun grantToken(ttl: Int, meta: CustomObject? = null, authorizedUUID: String? = null, channels: List<ChannelGrant> = emptyList(), channelGroups: List<ChannelGroupGrant> = emptyList(), uuids: List<UUIDGrant> = emptyList()): GrantToken

actual abstract fun grantToken(ttl: Int, meta: Any?, authorizedUUID: String?, channels: List<ChannelGrant>, channelGroups: List<ChannelGroupGrant>, uuids: List<UUIDGrant>): GrantToken

This function generates a grant token for PubNub Access Manager (PAM).

Permissions can be applied to any of the three type of resources:

channels
channel groups
uuid - metadata associated with particular UUID

Each type of resource have different set of permissions. To know what's possible for each of them check ChannelGrant, ChannelGroupGrant and UUIDGrant.

Parameters

ttl

Time in minutes for which granted permissions are valid.

Deprecated

This function is deprecated. Use the new grantToken(ttl, userId, meta, authorizedUUID, channels, channelGroups, uuids)

Replace with

grantToken(ttl, meta, authorizedUUID, channels, channelGroups, uuids)

This function generates a grant token for PubNub Access Manager (PAM).

Permissions can be applied to any of the two type of resources:

spacePermissions
userPermissions

Each type of resource have different set of permissions. To know what's possible for each of them check SpacePermissions and UserPermissions.

Parameters

ttl

Time in minutes for which granted permissions are valid.