Package com.pubnub.api.endpoints

Class DeleteMessages

java.lang.Object

com.pubnub.api.endpoints.Endpoint<DeleteMessagesEnvelope,PNDeleteMessagesResult>

com.pubnub.api.endpoints.DeleteMessages

All Implemented Interfaces:

RemoteAction<PNDeleteMessagesResult>

public class DeleteMessages
extends Endpoint<DeleteMessagesEnvelope,PNDeleteMessagesResult>

Constructor Summary

Constructors

Constructor	Description
DeleteMessages(PubNub pubnubInstance, TelemetryManager telemetryManager, RetrofitManager retrofitInstance, TokenManager tokenManager)

Method Summary

Modifier and Type	Method	Description
DeleteMessages	channels(java.util.List<java.lang.String> channels)
protected PNDeleteMessagesResult	createResponse(retrofit2.Response<DeleteMessagesEnvelope> input)
protected retrofit2.Call<DeleteMessagesEnvelope>	doWork(java.util.Map<java.lang.String,java.lang.String> params)
DeleteMessages	end(java.lang.Long end)
protected java.util.List<java.lang.String>	getAffectedChannelGroups()
protected java.util.List<java.lang.String>	getAffectedChannels()
protected PNOperationType	getOperationType()
protected boolean	isAuthRequired()
DeleteMessages	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

DeleteMessages

public DeleteMessages(PubNub pubnubInstance,
                      TelemetryManager telemetryManager,
                      RetrofitManager retrofitInstance,
                      TokenManager tokenManager)

Method Detail

getAffectedChannels

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

Specified by:

getAffectedChannels in class Endpoint<DeleteMessagesEnvelope,PNDeleteMessagesResult>

getAffectedChannelGroups

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

Specified by:

getAffectedChannelGroups in class Endpoint<DeleteMessagesEnvelope,PNDeleteMessagesResult>

validateParams

protected void validateParams()
                       throws PubNubException

Specified by:

validateParams in class Endpoint<DeleteMessagesEnvelope,PNDeleteMessagesResult>

Throws:

PubNubException

doWork

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

Specified by:

doWork in class Endpoint<DeleteMessagesEnvelope,PNDeleteMessagesResult>

Throws:

PubNubException

createResponse

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

Specified by:

createResponse in class Endpoint<DeleteMessagesEnvelope,PNDeleteMessagesResult>

Throws:

PubNubException

getOperationType

protected PNOperationType getOperationType()

Specified by:

getOperationType in class Endpoint<DeleteMessagesEnvelope,PNDeleteMessagesResult>

isAuthRequired

protected boolean isAuthRequired()

Specified by:

isAuthRequired in class Endpoint<DeleteMessagesEnvelope,PNDeleteMessagesResult>

channels

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

Returns:

this.

start

public DeleteMessages start(java.lang.Long start)

Returns:

this.

end

public DeleteMessages end(java.lang.Long end)

Returns:

this.