Package com.pubnub.api.endpoints

Class FetchMessages

java.lang.Object

com.pubnub.api.endpoints.Endpoint<FetchMessagesEnvelope,PNFetchMessagesResult>

com.pubnub.api.endpoints.FetchMessages

All Implemented Interfaces:

RemoteAction<PNFetchMessagesResult>

public class FetchMessages
extends Endpoint<FetchMessagesEnvelope,PNFetchMessagesResult>

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
FetchMessages	channels(java.util.List<java.lang.String> channels)
protected PNFetchMessagesResult	createResponse(retrofit2.Response<FetchMessagesEnvelope> input)
protected retrofit2.Call<FetchMessagesEnvelope>	doWork(java.util.Map<java.lang.String,java.lang.String> params)
FetchMessages	end(java.lang.Long end)
protected java.util.List<java.lang.String>	getAffectedChannelGroups()
protected java.util.List<java.lang.String>	getAffectedChannels()
protected PNOperationType	getOperationType()
FetchMessages	includeMessageActions(java.lang.Boolean includeMessageActions)
FetchMessages	includeMessageType(boolean includeMessageType)
FetchMessages	includeMeta(java.lang.Boolean includeMeta)
FetchMessages	includeUUID(boolean includeUUID)
protected boolean	isAuthRequired()
FetchMessages	maximumPerChannel(java.lang.Integer maximumPerChannel)
FetchMessages	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

FetchMessages

public FetchMessages(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<FetchMessagesEnvelope,PNFetchMessagesResult>

getAffectedChannelGroups

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

Specified by:

getAffectedChannelGroups in class Endpoint<FetchMessagesEnvelope,PNFetchMessagesResult>

validateParams

protected void validateParams()
                       throws PubNubException

Specified by:

validateParams in class Endpoint<FetchMessagesEnvelope,PNFetchMessagesResult>

Throws:

PubNubException

doWork

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

Specified by:

doWork in class Endpoint<FetchMessagesEnvelope,PNFetchMessagesResult>

Throws:

PubNubException

createResponse

protected PNFetchMessagesResult createResponse(retrofit2.Response<FetchMessagesEnvelope> input)
                                        throws PubNubException

Specified by:

createResponse in class Endpoint<FetchMessagesEnvelope,PNFetchMessagesResult>

Throws:

PubNubException

getOperationType

protected PNOperationType getOperationType()

Specified by:

getOperationType in class Endpoint<FetchMessagesEnvelope,PNFetchMessagesResult>

isAuthRequired

protected boolean isAuthRequired()

Specified by:

isAuthRequired in class Endpoint<FetchMessagesEnvelope,PNFetchMessagesResult>

channels

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

Returns:

this.

maximumPerChannel

public FetchMessages maximumPerChannel(java.lang.Integer maximumPerChannel)

Returns:

this.

start

public FetchMessages start(java.lang.Long start)

Returns:

this.

end

public FetchMessages end(java.lang.Long end)

Returns:

this.

includeMeta

public FetchMessages includeMeta(java.lang.Boolean includeMeta)

Returns:

this.

includeMessageActions

public FetchMessages includeMessageActions(java.lang.Boolean includeMessageActions)

Returns:

this.

includeMessageType

public FetchMessages includeMessageType(boolean includeMessageType)

Returns:

this.

includeUUID

public FetchMessages includeUUID(boolean includeUUID)

Returns:

this.