com.pubnub.api.endpoints.access

Class Grant

java.lang.Object

com.pubnub.api.endpoints.Endpoint<Envelope<AccessManagerGrantPayload>,PNAccessManagerGrantResult>

com.pubnub.api.endpoints.access.Grant

public class Grant
extends Endpoint<Envelope<AccessManagerGrantPayload>,PNAccessManagerGrantResult>

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Grant	authKeys(java.util.List<java.lang.String> authKeys)
Grant	channelGroups(java.util.List<java.lang.String> channelGroups)
Grant	channels(java.util.List<java.lang.String> channels)
protected PNAccessManagerGrantResult	createResponse(retrofit2.Response<Envelope<AccessManagerGrantPayload>> input)
protected retrofit2.Call<Envelope<AccessManagerGrantPayload>>	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()
Grant	manage(boolean manage)
Grant	read(boolean read)
Grant	ttl(java.lang.Integer ttl)
protected void	validateParams()
Grant	write(boolean write)

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

async, createBaseParams, getPubnub, getRetrofit, retry, silentCancel, sync

Methods inherited from class java.lang.Object

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

Constructor Detail

Grant

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

Method Detail

getAffectedChannels

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

Specified by:

getAffectedChannels in class Endpoint<Envelope<AccessManagerGrantPayload>,PNAccessManagerGrantResult>

getAffectedChannelGroups

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

Specified by:

getAffectedChannelGroups in class Endpoint<Envelope<AccessManagerGrantPayload>,PNAccessManagerGrantResult>

validateParams

protected void validateParams()
                       throws PubNubException

Specified by:

validateParams in class Endpoint<Envelope<AccessManagerGrantPayload>,PNAccessManagerGrantResult>

Throws:

PubNubException

doWork

protected retrofit2.Call<Envelope<AccessManagerGrantPayload>> doWork(java.util.Map<java.lang.String,java.lang.String> queryParams)
                                                              throws PubNubException

Specified by:

doWork in class Endpoint<Envelope<AccessManagerGrantPayload>,PNAccessManagerGrantResult>

Throws:

PubNubException

createResponse

protected PNAccessManagerGrantResult createResponse(retrofit2.Response<Envelope<AccessManagerGrantPayload>> input)
                                             throws PubNubException

Specified by:

createResponse in class Endpoint<Envelope<AccessManagerGrantPayload>,PNAccessManagerGrantResult>

Throws:

PubNubException

getOperationType

protected PNOperationType getOperationType()

Specified by:

getOperationType in class Endpoint<Envelope<AccessManagerGrantPayload>,PNAccessManagerGrantResult>

isAuthRequired

protected boolean isAuthRequired()

Specified by:

isAuthRequired in class Endpoint<Envelope<AccessManagerGrantPayload>,PNAccessManagerGrantResult>

read

@Generated(value="lombok")
public Grant read(boolean read)

write

@Generated(value="lombok")
public Grant write(boolean write)

manage

@Generated(value="lombok")
public Grant manage(boolean manage)

ttl

@Generated(value="lombok")
public Grant ttl(java.lang.Integer ttl)

authKeys

@Generated(value="lombok")
public Grant authKeys(java.util.List<java.lang.String> authKeys)

channels

@Generated(value="lombok")
public Grant channels(java.util.List<java.lang.String> channels)

channelGroups

@Generated(value="lombok")
public Grant channelGroups(java.util.List<java.lang.String> channelGroups)