com.pubnub.api.endpoints.objects_api.memberships

Class GetMemberships

java.lang.Object

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

com.pubnub.api.endpoints.objects_api.memberships.GetMemberships

All Implemented Interfaces:

TokenManagerPropertyProvider, InclusionParamsProvider<GetMemberships,PNMembershipFields>, ListingParamsProvider<GetMemberships>

public class GetMemberships
extends Endpoint<EntityArrayEnvelope<PNMembership>,PNGetMembershipsResult>
implements InclusionParamsProvider<GetMemberships,PNMembershipFields>, ListingParamsProvider<GetMemberships>, TokenManagerPropertyProvider

Get a user's inclusionParamList of space membership

Constructor Summary

Constructors

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

Method Summary

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

GetMemberships

public GetMemberships(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>,PNGetMembershipsResult>

getAffectedChannelGroups

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

Specified by:

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

validateParams

protected void validateParams()
                       throws PubNubException

Specified by:

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

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

createResponse

protected PNGetMembershipsResult createResponse(retrofit2.Response<EntityArrayEnvelope<PNMembership>> input)

Specified by:

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

getOperationType

protected PNOperationType getOperationType()

Specified by:

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

isAuthRequired

protected boolean isAuthRequired()

Specified by:

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

includeFields

public GetMemberships includeFields(PNMembershipFields... params)

Specified by:

includeFields in interface InclusionParamsProvider<GetMemberships,PNMembershipFields>

limit

public GetMemberships limit(java.lang.Integer limit)

Specified by:

limit in interface ListingParamsProvider<GetMemberships>

start

public GetMemberships start(java.lang.String start)

Specified by:

start in interface ListingParamsProvider<GetMemberships>

end

public GetMemberships end(java.lang.String end)

Specified by:

end in interface ListingParamsProvider<GetMemberships>

withTotalCount

public GetMemberships withTotalCount(java.lang.Boolean count)

Specified by:

withTotalCount in interface ListingParamsProvider<GetMemberships>

getTmsProperties

public TokenManagerProperties getTmsProperties()

Specified by:

getTmsProperties in interface TokenManagerPropertyProvider

userId

public GetMemberships userId(java.lang.String userId)