com.pubnub.api.endpoints

Class Endpoint<Input,Output>

java.lang.Object

com.pubnub.api.endpoints.Endpoint<Input,Output>

Direct Known Subclasses:

AddChannelChannelGroup, AddChannelsToPush, AllChannelsChannelGroup, Audit, DeleteChannelGroup, FetchMessages, GetState, Grant, Heartbeat, HereNow, History, Leave, ListAllChannelGroup, ListPushProvisions, Publish, RemoveAllPushChannelsForDevice, RemoveChannelChannelGroup, RemoveChannelsFromPush, SetState, Subscribe, Time, WhereNow

public abstract class Endpoint<Input,Output>
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Endpoint(PubNub pubnubInstance, retrofit2.Retrofit retrofitInstance)

Method Summary

Methods

Modifier and Type	Method and Description
void	async(PNCallback<Output> callback)
protected java.util.Map<java.lang.String,java.lang.String>	createBaseParams()
protected abstract Output	createResponse(retrofit2.Response<Input> input)
protected abstract retrofit2.Call<Input>	doWork(java.util.Map<java.lang.String,java.lang.String> baseParams)
protected java.util.List<java.lang.String>	getAffectedChannelGroups()
protected java.util.List<java.lang.String>	getAffectedChannels()
protected abstract PNOperationType	getOperationType()
protected PubNub	getPubnub()
protected retrofit2.Retrofit	getRetrofit()
protected abstract boolean	isAuthRequired()
void	retry()
void	silentCancel() cancel the operation but do not alert anybody, useful for restarting the heartbeats and subscribe loops.
Output	sync()
protected abstract void	validateParams()

Methods inherited from class java.lang.Object

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

Constructor Detail

Endpoint

public Endpoint(PubNub pubnubInstance,
        retrofit2.Retrofit retrofitInstance)

Method Detail

sync

public Output sync()
            throws PubNubException

Throws:

PubNubException

async

public void async(PNCallback<Output> callback)

retry

public void retry()

silentCancel

public void silentCancel()

cancel the operation but do not alert anybody, useful for restarting the heartbeats and subscribe loops.

createBaseParams

protected java.util.Map<java.lang.String,java.lang.String> createBaseParams()

getAffectedChannels

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

getAffectedChannelGroups

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

validateParams

protected abstract void validateParams()
                                throws PubNubException

Throws:

PubNubException

doWork

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

Throws:

PubNubException

createResponse

protected abstract Output createResponse(retrofit2.Response<Input> input)
                                  throws PubNubException

Throws:

PubNubException

getOperationType

protected abstract PNOperationType getOperationType()

isAuthRequired

protected abstract boolean isAuthRequired()

getPubnub

@Generated(value="lombok")
protected PubNub getPubnub()

getRetrofit

@Generated(value="lombok")
protected retrofit2.Retrofit getRetrofit()