Package com.pubnub.api.endpoints.objects_api

Class ObjectApiEndpoint<INPUT,OUTPUT>

java.lang.Object

com.pubnub.api.endpoints.Endpoint<INPUT,OUTPUT>

com.pubnub.api.endpoints.objects_api.ObjectApiEndpoint<INPUT,OUTPUT>

All Implemented Interfaces:

RemoteAction<OUTPUT>

Direct Known Subclasses:

ChannelEnpoint, GetAllChannelsMetadata, GetAllUUIDMetadata, UUIDEndpoint

public abstract class ObjectApiEndpoint<INPUT,OUTPUT>
extends Endpoint<INPUT,OUTPUT>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ObjectApiEndpoint(PubNub pubnubInstance, TelemetryManager telemetry, RetrofitManager retrofitInstance, CompositeParameterEnricher compositeParameterEnricher, TokenManager tokenManager)

Method Summary

Modifier and Type	Method	Description
protected retrofit2.Call<INPUT>	doWork(java.util.Map<java.lang.String,java.lang.String> baseParams)
protected abstract retrofit2.Call<INPUT>	executeCommand(java.util.Map<java.lang.String,java.lang.String> effectiveParams)
protected java.util.List<java.lang.String>	getAffectedChannelGroups()
protected java.util.List<java.lang.String>	getAffectedChannels()
protected CompositeParameterEnricher	getCompositeParameterEnricher()
protected boolean	isAuthRequired()
protected void	validateParams()

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

async, createBaseParams, createResponse, encodeParams, getOperationType, 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

ObjectApiEndpoint

protected ObjectApiEndpoint(PubNub pubnubInstance,
                            TelemetryManager telemetry,
                            RetrofitManager retrofitInstance,
                            CompositeParameterEnricher compositeParameterEnricher,
                            TokenManager tokenManager)

Method Detail

validateParams

protected void validateParams()
                       throws PubNubException

Specified by:

validateParams in class Endpoint<INPUT,OUTPUT>

Throws:

PubNubException

getAffectedChannels

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

Specified by:

getAffectedChannels in class Endpoint<INPUT,OUTPUT>

getAffectedChannelGroups

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

Specified by:

getAffectedChannelGroups in class Endpoint<INPUT,OUTPUT>

isAuthRequired

protected boolean isAuthRequired()

Specified by:

isAuthRequired in class Endpoint<INPUT,OUTPUT>

doWork

protected retrofit2.Call<INPUT> doWork(java.util.Map<java.lang.String,java.lang.String> baseParams)
                                throws PubNubException

Specified by:

doWork in class Endpoint<INPUT,OUTPUT>

Throws:

PubNubException

executeCommand

protected abstract retrofit2.Call<INPUT> executeCommand(java.util.Map<java.lang.String,java.lang.String> effectiveParams)
                                                 throws PubNubException

Throws:

PubNubException

getCompositeParameterEnricher

protected CompositeParameterEnricher getCompositeParameterEnricher()