Package com.pubnub.api.endpoints.access

Class Grant

java.lang.Object

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

com.pubnub.api.endpoints.access.Grant

All Implemented Interfaces:

RemoteAction<PNAccessManagerGrantResult>

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	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)
Grant	delete(boolean delete)
protected retrofit2.Call<Envelope<AccessManagerGrantPayload>>	doWork(java.util.Map<java.lang.String,java.lang.String> queryParams)
Grant	get(boolean get)
protected java.util.List<java.lang.String>	getAffectedChannelGroups()
protected java.util.List<java.lang.String>	getAffectedChannels()
protected PNOperationType	getOperationType()
protected boolean	isAuthRequired()
Grant	join(boolean join)
Grant	manage(boolean manage)
Grant	read(boolean read)
Grant	ttl(java.lang.Integer ttl)
Grant	update(boolean update)
Grant	uuids(java.util.List<java.lang.String> uuids)
protected void	validateParams()
Grant	write(boolean write)

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

async, createBaseParams, encodeParams, getPubnub, getRetrofit, isError, queryParam, 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,
             TokenManager tokenManager)

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

public Grant read(boolean read)

Returns:

this.

write

public Grant write(boolean write)

Returns:

this.

manage

public Grant manage(boolean manage)

Returns:

this.

delete

public Grant delete(boolean delete)

Returns:

this.

get

public Grant get(boolean get)

Returns:

this.

update

public Grant update(boolean update)

Returns:

this.

join

public Grant join(boolean join)

Returns:

this.

ttl

public Grant ttl(java.lang.Integer ttl)

Returns:

this.

authKeys

public Grant authKeys(java.util.List<java.lang.String> authKeys)

Returns:

this.

channels

public Grant channels(java.util.List<java.lang.String> channels)

Returns:

this.

channelGroups

public Grant channelGroups(java.util.List<java.lang.String> channelGroups)

Returns:

this.

uuids

public Grant uuids(java.util.List<java.lang.String> uuids)

Returns:

this.