com.pubnub.api.endpoints.objects_api.spaces

Class GetSpace

java.lang.Object

com.pubnub.api.endpoints.Endpoint<EntityEnvelope<PNSpace>,PNGetSpaceResult>

com.pubnub.api.endpoints.objects_api.spaces.GetSpace

All Implemented Interfaces:

TokenManagerPropertyProvider, InclusionParamsProvider<GetSpace,PNSpaceFields>

public class GetSpace
extends Endpoint<EntityEnvelope<PNSpace>,PNGetSpaceResult>
implements InclusionParamsProvider<GetSpace,PNSpaceFields>, TokenManagerPropertyProvider

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected PNGetSpaceResult	createResponse(retrofit2.Response<EntityEnvelope<PNSpace>> input)
protected retrofit2.Call<EntityEnvelope<PNSpace>>	doWork(java.util.Map<java.lang.String,java.lang.String> params)
protected java.util.List<java.lang.String>	getAffectedChannelGroups()
protected java.util.List<java.lang.String>	getAffectedChannels()
protected PNOperationType	getOperationType()
TokenManagerProperties	getTmsProperties()
GetSpace	includeFields(PNSpaceFields... params)
protected boolean	isAuthRequired()
GetSpace	spaceId(java.lang.String spaceId)
protected void	validateParams()

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

GetSpace

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

Method Detail

getAffectedChannels

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

Specified by:

getAffectedChannels in class Endpoint<EntityEnvelope<PNSpace>,PNGetSpaceResult>

getAffectedChannelGroups

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

Specified by:

getAffectedChannelGroups in class Endpoint<EntityEnvelope<PNSpace>,PNGetSpaceResult>

validateParams

protected void validateParams()
                       throws PubNubException

Specified by:

validateParams in class Endpoint<EntityEnvelope<PNSpace>,PNGetSpaceResult>

Throws:

PubNubException

doWork

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

Specified by:

doWork in class Endpoint<EntityEnvelope<PNSpace>,PNGetSpaceResult>

createResponse

protected PNGetSpaceResult createResponse(retrofit2.Response<EntityEnvelope<PNSpace>> input)
                                   throws PubNubException

Specified by:

createResponse in class Endpoint<EntityEnvelope<PNSpace>,PNGetSpaceResult>

Throws:

PubNubException

getOperationType

protected PNOperationType getOperationType()

Specified by:

getOperationType in class Endpoint<EntityEnvelope<PNSpace>,PNGetSpaceResult>

isAuthRequired

protected boolean isAuthRequired()

Specified by:

isAuthRequired in class Endpoint<EntityEnvelope<PNSpace>,PNGetSpaceResult>

includeFields

public GetSpace includeFields(PNSpaceFields... params)

Specified by:

includeFields in interface InclusionParamsProvider<GetSpace,PNSpaceFields>

getTmsProperties

public TokenManagerProperties getTmsProperties()

Specified by:

getTmsProperties in interface TokenManagerPropertyProvider

spaceId

public GetSpace spaceId(java.lang.String spaceId)