Package com.pubnub.api.endpoints

Class History

java.lang.Object

com.pubnub.api.endpoints.Endpoint<com.google.gson.JsonElement,PNHistoryResult>

com.pubnub.api.endpoints.History

All Implemented Interfaces:

RemoteAction<PNHistoryResult>

public class History
extends Endpoint<com.google.gson.JsonElement,PNHistoryResult>

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
History	channel(java.lang.String channel)
History	count(java.lang.Integer count)
protected PNHistoryResult	createResponse(retrofit2.Response<com.google.gson.JsonElement> input)
protected retrofit2.Call<com.google.gson.JsonElement>	doWork(java.util.Map<java.lang.String,java.lang.String> params)
History	end(java.lang.Long end)
protected java.util.List<java.lang.String>	getAffectedChannelGroups()
protected java.util.List<java.lang.String>	getAffectedChannels()
protected PNOperationType	getOperationType()
History	includeMeta(java.lang.Boolean includeMeta)
History	includeTimetoken(java.lang.Boolean includeTimetoken)
protected boolean	isAuthRequired()
History	reverse(java.lang.Boolean reverse)
History	start(java.lang.Long start)
protected void	validateParams()

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

History

public History(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<com.google.gson.JsonElement,PNHistoryResult>

getAffectedChannelGroups

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

Specified by:

getAffectedChannelGroups in class Endpoint<com.google.gson.JsonElement,PNHistoryResult>

validateParams

protected void validateParams()
                       throws PubNubException

Specified by:

validateParams in class Endpoint<com.google.gson.JsonElement,PNHistoryResult>

Throws:

PubNubException

doWork

protected retrofit2.Call<com.google.gson.JsonElement> doWork(java.util.Map<java.lang.String,java.lang.String> params)

Specified by:

doWork in class Endpoint<com.google.gson.JsonElement,PNHistoryResult>

createResponse

protected PNHistoryResult createResponse(retrofit2.Response<com.google.gson.JsonElement> input)
                                  throws PubNubException

Specified by:

createResponse in class Endpoint<com.google.gson.JsonElement,PNHistoryResult>

Throws:

PubNubException

getOperationType

protected PNOperationType getOperationType()

Specified by:

getOperationType in class Endpoint<com.google.gson.JsonElement,PNHistoryResult>

isAuthRequired

protected boolean isAuthRequired()

Specified by:

isAuthRequired in class Endpoint<com.google.gson.JsonElement,PNHistoryResult>

channel

public History channel(java.lang.String channel)

Returns:

this.

start

public History start(java.lang.Long start)

Returns:

this.

end

public History end(java.lang.Long end)

Returns:

this.

reverse

public History reverse(java.lang.Boolean reverse)

Returns:

this.

count

public History count(java.lang.Integer count)

Returns:

this.

includeTimetoken

public History includeTimetoken(java.lang.Boolean includeTimetoken)

Returns:

this.

includeMeta

public History includeMeta(java.lang.Boolean includeMeta)

Returns:

this.