com.pubnub.api.endpoints.objects_api.members

Class GetMembers

java.lang.Object

com.pubnub.api.endpoints.Endpoint<EntityArrayEnvelope<PNMember>,PNGetMembersResult>

com.pubnub.api.endpoints.objects_api.members.GetMembers

All Implemented Interfaces:

TokenManagerPropertyProvider, InclusionParamsProvider<GetMembers,PNMemberFields>, ListingParamsProvider<GetMembers>

public class GetMembers
extends Endpoint<EntityArrayEnvelope<PNMember>,PNGetMembersResult>
implements InclusionParamsProvider<GetMembers,PNMemberFields>, ListingParamsProvider<GetMembers>, TokenManagerPropertyProvider

Get the inclusionParamList of members in a space

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected PNGetMembersResult	createResponse(retrofit2.Response<EntityArrayEnvelope<PNMember>> input)
protected retrofit2.Call<EntityArrayEnvelope<PNMember>>	doWork(java.util.Map<java.lang.String,java.lang.String> params)
GetMembers	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()
GetMembers	includeFields(PNMemberFields... params)
protected boolean	isAuthRequired()
GetMembers	limit(java.lang.Integer limit)
GetMembers	spaceId(java.lang.String spaceId)
GetMembers	start(java.lang.String start)
protected void	validateParams()
GetMembers	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

GetMembers

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

Method Detail

getAffectedChannels

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

Specified by:

getAffectedChannels in class Endpoint<EntityArrayEnvelope<PNMember>,PNGetMembersResult>

getAffectedChannelGroups

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

Specified by:

getAffectedChannelGroups in class Endpoint<EntityArrayEnvelope<PNMember>,PNGetMembersResult>

validateParams

protected void validateParams()
                       throws PubNubException

Specified by:

validateParams in class Endpoint<EntityArrayEnvelope<PNMember>,PNGetMembersResult>

Throws:

PubNubException

doWork

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

Specified by:

doWork in class Endpoint<EntityArrayEnvelope<PNMember>,PNGetMembersResult>

createResponse

protected PNGetMembersResult createResponse(retrofit2.Response<EntityArrayEnvelope<PNMember>> input)

Specified by:

createResponse in class Endpoint<EntityArrayEnvelope<PNMember>,PNGetMembersResult>

getOperationType

protected PNOperationType getOperationType()

Specified by:

getOperationType in class Endpoint<EntityArrayEnvelope<PNMember>,PNGetMembersResult>

isAuthRequired

protected boolean isAuthRequired()

Specified by:

isAuthRequired in class Endpoint<EntityArrayEnvelope<PNMember>,PNGetMembersResult>

includeFields

public GetMembers includeFields(PNMemberFields... params)

Specified by:

includeFields in interface InclusionParamsProvider<GetMembers,PNMemberFields>

limit

public GetMembers limit(java.lang.Integer limit)

Specified by:

limit in interface ListingParamsProvider<GetMembers>

start

public GetMembers start(java.lang.String start)

Specified by:

start in interface ListingParamsProvider<GetMembers>

end

public GetMembers end(java.lang.String end)

Specified by:

end in interface ListingParamsProvider<GetMembers>

withTotalCount

public GetMembers withTotalCount(java.lang.Boolean count)

Specified by:

withTotalCount in interface ListingParamsProvider<GetMembers>

getTmsProperties

public TokenManagerProperties getTmsProperties()

Specified by:

getTmsProperties in interface TokenManagerPropertyProvider

spaceId

public GetMembers spaceId(java.lang.String spaceId)