com.pubnub.api.endpoints.pubsub

Class Subscribe

java.lang.Object

com.pubnub.api.endpoints.Endpoint<SubscribeEnvelope,SubscribeEnvelope>

com.pubnub.api.endpoints.pubsub.Subscribe

public class Subscribe
extends Endpoint<SubscribeEnvelope,SubscribeEnvelope>

Supports calling of the subscribe endpoints and deconstructs the response to POJO's.

Constructor Summary

Constructors

Constructor and Description
Subscribe(PubNub pubnub, RetrofitManager retrofit) Create a new Subscribe instance endpoint.

Method Summary

Modifier and Type	Method and Description
Subscribe	channelGroups(java.util.List<java.lang.String> channelGroups) List of channel groups that will be called with subscribe.
Subscribe	channels(java.util.List<java.lang.String> channels) List of channels that will be called to subscribe.
protected SubscribeEnvelope	createResponse(retrofit2.Response<SubscribeEnvelope> input)
protected retrofit2.Call<SubscribeEnvelope>	doWork(java.util.Map<java.lang.String,java.lang.String> params)
Subscribe	filterExpression(java.lang.String filterExpression) filterExpression used as part of PubSub V2 specification to filter on message.
protected java.util.List<java.lang.String>	getAffectedChannelGroups()
protected java.util.List<java.lang.String>	getAffectedChannels()
protected PNOperationType	getOperationType()
protected boolean	isAuthRequired()
Subscribe	region(java.lang.String region) region is used as part of PubSub V2 to help the server route traffic to best data center.
Subscribe	state(java.lang.Object state)
Subscribe	timetoken(java.lang.Long timetoken) timetoken to subscribe with 0 for initial subscribe.
protected void	validateParams()

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

async, createBaseParams, encodeParams, getPubnub, getRetrofit, queryParam, retry, silentCancel, sync

Methods inherited from class java.lang.Object

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

Constructor Detail

Subscribe

public Subscribe(PubNub pubnub,
                 RetrofitManager retrofit)

Create a new Subscribe instance endpoint.

Parameters:

pubnub - supplied pubnub instance.

Method Detail

getAffectedChannels

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

Specified by:

getAffectedChannels in class Endpoint<SubscribeEnvelope,SubscribeEnvelope>

getAffectedChannelGroups

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

Specified by:

getAffectedChannelGroups in class Endpoint<SubscribeEnvelope,SubscribeEnvelope>

validateParams

protected void validateParams()
                       throws PubNubException

Specified by:

validateParams in class Endpoint<SubscribeEnvelope,SubscribeEnvelope>

Throws:

PubNubException

doWork

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

Specified by:

doWork in class Endpoint<SubscribeEnvelope,SubscribeEnvelope>

Throws:

PubNubException

createResponse

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

Specified by:

createResponse in class Endpoint<SubscribeEnvelope,SubscribeEnvelope>

Throws:

PubNubException

getOperationType

protected PNOperationType getOperationType()

Specified by:

getOperationType in class Endpoint<SubscribeEnvelope,SubscribeEnvelope>

isAuthRequired

protected boolean isAuthRequired()

Specified by:

isAuthRequired in class Endpoint<SubscribeEnvelope,SubscribeEnvelope>

channels

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

List of channels that will be called to subscribe.

Returns:

this

channelGroups

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

List of channel groups that will be called with subscribe.

Returns:

this

timetoken

public Subscribe timetoken(java.lang.Long timetoken)

timetoken to subscribe with 0 for initial subscribe.

Returns:

this

filterExpression

public Subscribe filterExpression(java.lang.String filterExpression)

filterExpression used as part of PubSub V2 specification to filter on message.

Returns:

this

region

public Subscribe region(java.lang.String region)

region is used as part of PubSub V2 to help the server route traffic to best data center.

Returns:

this

state

public Subscribe state(java.lang.Object state)