Package com.pubnub.api.endpoints.pubsub

Class Publish

java.lang.Object

com.pubnub.api.endpoints.Endpoint<java.util.List<java.lang.Object>,PNPublishResult>

com.pubnub.api.endpoints.pubsub.Publish

All Implemented Interfaces:

RemoteAction<PNPublishResult>

public class Publish
extends Endpoint<java.util.List<java.lang.Object>,PNPublishResult>

Constructor Summary

Constructors

Constructor	Description
Publish(PubNub pubnub, PublishSequenceManager providedPublishSequenceManager, TelemetryManager telemetryManager, RetrofitManager retrofit, TokenManager tokenManager)

Method Summary

Modifier and Type	Method	Description
Publish	channel(java.lang.String channel)
protected PNPublishResult	createResponse(retrofit2.Response<java.util.List<java.lang.Object>> input)
protected retrofit2.Call<java.util.List<java.lang.Object>>	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()
Publish	message(java.lang.Object message)
Publish	meta(java.lang.Object meta)
Publish	replicate(java.lang.Boolean replicate)
Publish	shouldStore(java.lang.Boolean shouldStore)
Publish	ttl(java.lang.Integer ttl)
Publish	usePOST(java.lang.Boolean usePOST)
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

Publish

public Publish(PubNub pubnub,
               PublishSequenceManager providedPublishSequenceManager,
               TelemetryManager telemetryManager,
               RetrofitManager retrofit,
               TokenManager tokenManager)

Method Detail

getAffectedChannels

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

Specified by:

getAffectedChannels in class Endpoint<java.util.List<java.lang.Object>,PNPublishResult>

getAffectedChannelGroups

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

Specified by:

getAffectedChannelGroups in class Endpoint<java.util.List<java.lang.Object>,PNPublishResult>

validateParams

protected void validateParams()
                       throws PubNubException

Specified by:

validateParams in class Endpoint<java.util.List<java.lang.Object>,PNPublishResult>

Throws:

PubNubException

doWork

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

Specified by:

doWork in class Endpoint<java.util.List<java.lang.Object>,PNPublishResult>

Throws:

PubNubException

createResponse

protected PNPublishResult createResponse(retrofit2.Response<java.util.List<java.lang.Object>> input)
                                  throws PubNubException

Specified by:

createResponse in class Endpoint<java.util.List<java.lang.Object>,PNPublishResult>

Throws:

PubNubException

getOperationType

protected PNOperationType getOperationType()

Specified by:

getOperationType in class Endpoint<java.util.List<java.lang.Object>,PNPublishResult>

isAuthRequired

protected boolean isAuthRequired()

Specified by:

isAuthRequired in class Endpoint<java.util.List<java.lang.Object>,PNPublishResult>

message

public Publish message(java.lang.Object message)

Returns:

this.

channel

public Publish channel(java.lang.String channel)

Returns:

this.

shouldStore

public Publish shouldStore(java.lang.Boolean shouldStore)

Returns:

this.

usePOST

public Publish usePOST(java.lang.Boolean usePOST)

Returns:

this.

meta

public Publish meta(java.lang.Object meta)

Returns:

this.

replicate

public Publish replicate(java.lang.Boolean replicate)

Returns:

this.

ttl

public Publish ttl(java.lang.Integer ttl)

Returns:

this.