com.pubnub.api.endpoints.objects_api.members

Class ManageMembers

java.lang.Object

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

com.pubnub.api.endpoints.objects_api.members.ManageMembers

All Implemented Interfaces:

TokenManagerPropertyProvider, InclusionParamsProvider<ManageMembers,PNMemberFields>, ListingParamsProvider<ManageMembers>, MembershipChainProvider<ManageMembers,Member>

public class ManageMembers
extends Endpoint<EntityArrayEnvelope<PNMember>,PNManageMembersResult>
implements InclusionParamsProvider<ManageMembers,PNMemberFields>, ListingParamsProvider<ManageMembers>, MembershipChainProvider<ManageMembers,Member>, TokenManagerPropertyProvider

Constructor Summary

Constructors

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

Method Summary

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

ManageMembers

public ManageMembers(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>,PNManageMembersResult>

getAffectedChannelGroups

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

Specified by:

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

validateParams

protected void validateParams()
                       throws PubNubException

Specified by:

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

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>,PNManageMembersResult>

createResponse

protected PNManageMembersResult createResponse(retrofit2.Response<EntityArrayEnvelope<PNMember>> input)
                                        throws PubNubException

Specified by:

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

Throws:

PubNubException

getOperationType

protected PNOperationType getOperationType()

Specified by:

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

isAuthRequired

protected boolean isAuthRequired()

Specified by:

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

includeFields

public ManageMembers includeFields(PNMemberFields... params)

Specified by:

includeFields in interface InclusionParamsProvider<ManageMembers,PNMemberFields>

limit

public ManageMembers limit(java.lang.Integer limit)

Specified by:

limit in interface ListingParamsProvider<ManageMembers>

start

public ManageMembers start(java.lang.String start)

Specified by:

start in interface ListingParamsProvider<ManageMembers>

end

public ManageMembers end(java.lang.String end)

Specified by:

end in interface ListingParamsProvider<ManageMembers>

withTotalCount

public ManageMembers withTotalCount(java.lang.Boolean count)

Specified by:

withTotalCount in interface ListingParamsProvider<ManageMembers>

add

public ManageMembers add(Member... list)

Specified by:

add in interface MembershipChainProvider<ManageMembers,Member>

update

public ManageMembers update(Member... list)

Specified by:

update in interface MembershipChainProvider<ManageMembers,Member>

remove

public ManageMembers remove(Member... list)

Specified by:

remove in interface MembershipChainProvider<ManageMembers,Member>

getTmsProperties

public TokenManagerProperties getTmsProperties()

Specified by:

getTmsProperties in interface TokenManagerPropertyProvider

spaceId

public ManageMembers spaceId(java.lang.String spaceId)