com.pubnub.api.endpoints.access

Class GrantToken

java.lang.Object

com.pubnub.api.endpoints.Endpoint<com.google.gson.JsonObject,PNGrantTokenResult>

com.pubnub.api.endpoints.access.GrantToken

public class GrantToken
extends Endpoint<com.google.gson.JsonObject,PNGrantTokenResult>

Constructor Summary

Constructors

Constructor and Description
GrantToken(PubNub pubnub, TelemetryManager telemetryManager, RetrofitManager retrofit)

Method Summary

Modifier and Type	Method and Description
protected PNGrantTokenResult	createResponse(retrofit2.Response<com.google.gson.JsonObject> input)
protected retrofit2.Call<com.google.gson.JsonObject>	doWork(java.util.Map<java.lang.String,java.lang.String> queryParams)
protected java.util.List<java.lang.String>	getAffectedChannelGroups()
protected java.util.List<java.lang.String>	getAffectedChannels()
protected PNOperationType	getOperationType()
protected boolean	isAuthRequired()
GrantToken	meta(java.lang.Object meta)
GrantToken	spaces(Space... spaces)
GrantToken	ttl(java.lang.Integer ttl)
GrantToken	users(User... users)
protected void	validateParams()

Methods inherited from class com.pubnub.api.endpoints.Endpoint

appendInclusionParams, appendLimitParam, async, createBaseParams, encodeParams, getPubnub, getRetrofit, queryParam, retry, silentCancel, sync

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GrantToken

public GrantToken(PubNub pubnub,
                  TelemetryManager telemetryManager,
                  RetrofitManager retrofit)

Method Detail

getAffectedChannels

protected java.util.List<java.lang.String> getAffectedChannels()

Specified by:

getAffectedChannels in class Endpoint<com.google.gson.JsonObject,PNGrantTokenResult>

getAffectedChannelGroups

protected java.util.List<java.lang.String> getAffectedChannelGroups()

Specified by:

getAffectedChannelGroups in class Endpoint<com.google.gson.JsonObject,PNGrantTokenResult>

validateParams

protected void validateParams()
                       throws PubNubException

Specified by:

validateParams in class Endpoint<com.google.gson.JsonObject,PNGrantTokenResult>

Throws:

PubNubException

doWork

protected retrofit2.Call<com.google.gson.JsonObject> doWork(java.util.Map<java.lang.String,java.lang.String> queryParams)
                                                     throws PubNubException

Specified by:

doWork in class Endpoint<com.google.gson.JsonObject,PNGrantTokenResult>

Throws:

PubNubException

createResponse

protected PNGrantTokenResult createResponse(retrofit2.Response<com.google.gson.JsonObject> input)
                                     throws PubNubException

Specified by:

createResponse in class Endpoint<com.google.gson.JsonObject,PNGrantTokenResult>

Throws:

PubNubException

getOperationType

protected PNOperationType getOperationType()

Specified by:

getOperationType in class Endpoint<com.google.gson.JsonObject,PNGrantTokenResult>

isAuthRequired

protected boolean isAuthRequired()

Specified by:

isAuthRequired in class Endpoint<com.google.gson.JsonObject,PNGrantTokenResult>

users

public GrantToken users(User... users)

spaces

public GrantToken spaces(Space... spaces)

ttl

public GrantToken ttl(java.lang.Integer ttl)

meta

public GrantToken meta(java.lang.Object meta)