Package com.pubnub.api.endpoints.presence

Class Heartbeat

java.lang.Object

com.pubnub.api.endpoints.Endpoint<Envelope<com.google.gson.JsonElement>,java.lang.Boolean>

com.pubnub.api.endpoints.presence.Heartbeat

All Implemented Interfaces:

RemoteAction<java.lang.Boolean>

public class Heartbeat
extends Endpoint<Envelope<com.google.gson.JsonElement>,java.lang.Boolean>

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Heartbeat	channelGroups(java.util.List<java.lang.String> channelGroups)
Heartbeat	channels(java.util.List<java.lang.String> channels)
protected java.lang.Boolean	createResponse(retrofit2.Response<Envelope<com.google.gson.JsonElement>> input)
protected retrofit2.Call<Envelope<com.google.gson.JsonElement>>	doWork(java.util.Map<java.lang.String,java.lang.String> params)
protected java.util.List<java.lang.String>	getAffectedChannelGroups()
protected java.util.List<java.lang.String>	getAffectedChannels()
protected PNOperationType	getOperationType()
protected boolean	isAuthRequired()
Heartbeat	state(java.lang.Object state)
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

Heartbeat

public Heartbeat(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<com.google.gson.JsonElement>,java.lang.Boolean>

getAffectedChannelGroups

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

Specified by:

getAffectedChannelGroups in class Endpoint<Envelope<com.google.gson.JsonElement>,java.lang.Boolean>

validateParams

protected void validateParams()
                       throws PubNubException

Specified by:

validateParams in class Endpoint<Envelope<com.google.gson.JsonElement>,java.lang.Boolean>

Throws:

PubNubException

doWork

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

Specified by:

doWork in class Endpoint<Envelope<com.google.gson.JsonElement>,java.lang.Boolean>

Throws:

PubNubException

createResponse

protected java.lang.Boolean createResponse(retrofit2.Response<Envelope<com.google.gson.JsonElement>> input)
                                    throws PubNubException

Specified by:

createResponse in class Endpoint<Envelope<com.google.gson.JsonElement>,java.lang.Boolean>

Throws:

PubNubException

getOperationType

protected PNOperationType getOperationType()

Specified by:

getOperationType in class Endpoint<Envelope<com.google.gson.JsonElement>,java.lang.Boolean>

isAuthRequired

protected boolean isAuthRequired()

Specified by:

isAuthRequired in class Endpoint<Envelope<com.google.gson.JsonElement>,java.lang.Boolean>

channels

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

Returns:

this.

channelGroups

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

Returns:

this.

state

public Heartbeat state(java.lang.Object state)

Returns:

this.