com.pubnub.api.endpoints.objects_api.users

Class GetUsers

java.lang.Object

com.pubnub.api.endpoints.Endpoint<EntityArrayEnvelope<PNUser>,PNGetUsersResult>

com.pubnub.api.endpoints.objects_api.users.GetUsers

All Implemented Interfaces:

TokenManagerPropertyProvider, InclusionParamsProvider<GetUsers,PNUserFields>, ListingParamsProvider<GetUsers>

public class GetUsers
extends Endpoint<EntityArrayEnvelope<PNUser>,PNGetUsersResult>
implements InclusionParamsProvider<GetUsers,PNUserFields>, ListingParamsProvider<GetUsers>, TokenManagerPropertyProvider

Constructor Summary

Constructors

Constructor and Description
GetUsers(PubNub pubnubInstance, TelemetryManager telemetry, RetrofitManager retrofitInstance)

Method Summary

Modifier and Type	Method and Description
protected PNGetUsersResult	createResponse(retrofit2.Response<EntityArrayEnvelope<PNUser>> input)
protected retrofit2.Call<EntityArrayEnvelope<PNUser>>	doWork(java.util.Map<java.lang.String,java.lang.String> params)
GetUsers	end(java.lang.String end)
protected java.util.List<java.lang.String>	getAffectedChannelGroups()
protected java.util.List<java.lang.String>	getAffectedChannels()
protected PNOperationType	getOperationType()
TokenManagerProperties	getTmsProperties()
GetUsers	includeFields(PNUserFields... params)
protected boolean	isAuthRequired()
GetUsers	limit(java.lang.Integer limit)
GetUsers	start(java.lang.String start)
protected void	validateParams()
GetUsers	withTotalCount(java.lang.Boolean count)

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

appendInclusionParams, appendLimitParam, 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

GetUsers

public GetUsers(PubNub pubnubInstance,
                TelemetryManager telemetry,
                RetrofitManager retrofitInstance)

Method Detail

getAffectedChannels

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

Specified by:

getAffectedChannels in class Endpoint<EntityArrayEnvelope<PNUser>,PNGetUsersResult>

getAffectedChannelGroups

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

Specified by:

getAffectedChannelGroups in class Endpoint<EntityArrayEnvelope<PNUser>,PNGetUsersResult>

validateParams

protected void validateParams()
                       throws PubNubException

Specified by:

validateParams in class Endpoint<EntityArrayEnvelope<PNUser>,PNGetUsersResult>

Throws:

PubNubException

doWork

protected retrofit2.Call<EntityArrayEnvelope<PNUser>> doWork(java.util.Map<java.lang.String,java.lang.String> params)

Specified by:

doWork in class Endpoint<EntityArrayEnvelope<PNUser>,PNGetUsersResult>

createResponse

protected PNGetUsersResult createResponse(retrofit2.Response<EntityArrayEnvelope<PNUser>> input)
                                   throws PubNubException

Specified by:

createResponse in class Endpoint<EntityArrayEnvelope<PNUser>,PNGetUsersResult>

Throws:

PubNubException

getOperationType

protected PNOperationType getOperationType()

Specified by:

getOperationType in class Endpoint<EntityArrayEnvelope<PNUser>,PNGetUsersResult>

isAuthRequired

protected boolean isAuthRequired()

Specified by:

isAuthRequired in class Endpoint<EntityArrayEnvelope<PNUser>,PNGetUsersResult>

includeFields

public GetUsers includeFields(PNUserFields... params)

Specified by:

includeFields in interface InclusionParamsProvider<GetUsers,PNUserFields>

limit

public GetUsers limit(java.lang.Integer limit)

Specified by:

limit in interface ListingParamsProvider<GetUsers>

start

public GetUsers start(java.lang.String start)

Specified by:

start in interface ListingParamsProvider<GetUsers>

end

public GetUsers end(java.lang.String end)

Specified by:

end in interface ListingParamsProvider<GetUsers>

withTotalCount

public GetUsers withTotalCount(java.lang.Boolean count)

Specified by:

withTotalCount in interface ListingParamsProvider<GetUsers>

getTmsProperties

public TokenManagerProperties getTmsProperties()

Specified by:

getTmsProperties in interface TokenManagerPropertyProvider