com.pubnub.api.endpoints.objects_api.memberships

Class ManageMemberships

java.lang.Object

com.pubnub.api.endpoints.Endpoint<EntityArrayEnvelope<PNMembership>,PNManageMembershipsResult>

com.pubnub.api.endpoints.objects_api.memberships.ManageMemberships

All Implemented Interfaces:

TokenManagerPropertyProvider, InclusionParamsProvider<ManageMemberships,PNMembershipFields>, ListingParamsProvider<ManageMemberships>, MembershipChainProvider<ManageMemberships,Membership>

public class ManageMemberships
extends Endpoint<EntityArrayEnvelope<PNMembership>,PNManageMembershipsResult>
implements InclusionParamsProvider<ManageMemberships,PNMembershipFields>, ListingParamsProvider<ManageMemberships>, MembershipChainProvider<ManageMemberships,Membership>, TokenManagerPropertyProvider

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ManageMemberships	add(Membership... list)
protected PNManageMembershipsResult	createResponse(retrofit2.Response<EntityArrayEnvelope<PNMembership>> input)
protected retrofit2.Call<EntityArrayEnvelope<PNMembership>>	doWork(java.util.Map<java.lang.String,java.lang.String> params)
ManageMemberships	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()
ManageMemberships	includeFields(PNMembershipFields... params)
protected boolean	isAuthRequired()
ManageMemberships	limit(java.lang.Integer limit)
ManageMemberships	remove(Membership... list)
ManageMemberships	start(java.lang.String start)
ManageMemberships	update(Membership... list)
ManageMemberships	userId(java.lang.String userId)
protected void	validateParams()
ManageMemberships	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

ManageMemberships

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

Method Detail

getAffectedChannels

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

Specified by:

getAffectedChannels in class Endpoint<EntityArrayEnvelope<PNMembership>,PNManageMembershipsResult>

getAffectedChannelGroups

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

Specified by:

getAffectedChannelGroups in class Endpoint<EntityArrayEnvelope<PNMembership>,PNManageMembershipsResult>

validateParams

protected void validateParams()
                       throws PubNubException

Specified by:

validateParams in class Endpoint<EntityArrayEnvelope<PNMembership>,PNManageMembershipsResult>

Throws:

PubNubException

doWork

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

Specified by:

doWork in class Endpoint<EntityArrayEnvelope<PNMembership>,PNManageMembershipsResult>

createResponse

protected PNManageMembershipsResult createResponse(retrofit2.Response<EntityArrayEnvelope<PNMembership>> input)
                                            throws PubNubException

Specified by:

createResponse in class Endpoint<EntityArrayEnvelope<PNMembership>,PNManageMembershipsResult>

Throws:

PubNubException

getOperationType

protected PNOperationType getOperationType()

Specified by:

getOperationType in class Endpoint<EntityArrayEnvelope<PNMembership>,PNManageMembershipsResult>

isAuthRequired

protected boolean isAuthRequired()

Specified by:

isAuthRequired in class Endpoint<EntityArrayEnvelope<PNMembership>,PNManageMembershipsResult>

includeFields

public ManageMemberships includeFields(PNMembershipFields... params)

Specified by:

includeFields in interface InclusionParamsProvider<ManageMemberships,PNMembershipFields>

add

public ManageMemberships add(Membership... list)

Specified by:

add in interface MembershipChainProvider<ManageMemberships,Membership>

update

public ManageMemberships update(Membership... list)

Specified by:

update in interface MembershipChainProvider<ManageMemberships,Membership>

remove

public ManageMemberships remove(Membership... list)

Specified by:

remove in interface MembershipChainProvider<ManageMemberships,Membership>

limit

public ManageMemberships limit(java.lang.Integer limit)

Specified by:

limit in interface ListingParamsProvider<ManageMemberships>

start

public ManageMemberships start(java.lang.String start)

Specified by:

start in interface ListingParamsProvider<ManageMemberships>

end

public ManageMemberships end(java.lang.String end)

Specified by:

end in interface ListingParamsProvider<ManageMemberships>

withTotalCount

public ManageMemberships withTotalCount(java.lang.Boolean count)

Specified by:

withTotalCount in interface ListingParamsProvider<ManageMemberships>

getTmsProperties

public TokenManagerProperties getTmsProperties()

Specified by:

getTmsProperties in interface TokenManagerPropertyProvider

userId

public ManageMemberships userId(java.lang.String userId)