com.pubnub.api.endpoints.objects_api.users

Class UpdateUser

java.lang.Object

com.pubnub.api.endpoints.Endpoint<EntityEnvelope<PNUser>,PNUpdateUserResult>

com.pubnub.api.endpoints.objects_api.users.UpdateUser

All Implemented Interfaces:

TokenManagerPropertyProvider, InclusionParamsProvider<UpdateUser,PNUserFields>

public class UpdateUser
extends Endpoint<EntityEnvelope<PNUser>,PNUpdateUserResult>
implements InclusionParamsProvider<UpdateUser,PNUserFields>, TokenManagerPropertyProvider

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected PNUpdateUserResult	createResponse(retrofit2.Response<EntityEnvelope<PNUser>> input)
protected retrofit2.Call<EntityEnvelope<PNUser>>	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()
UpdateUser	includeFields(PNUserFields... params)
protected boolean	isAuthRequired()
UpdateUser	user(PNUser user)
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

UpdateUser

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

Method Detail

getAffectedChannels

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

Specified by:

getAffectedChannels in class Endpoint<EntityEnvelope<PNUser>,PNUpdateUserResult>

getAffectedChannelGroups

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

Specified by:

getAffectedChannelGroups in class Endpoint<EntityEnvelope<PNUser>,PNUpdateUserResult>

validateParams

protected void validateParams()
                       throws PubNubException

Specified by:

validateParams in class Endpoint<EntityEnvelope<PNUser>,PNUpdateUserResult>

Throws:

PubNubException

doWork

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

Specified by:

doWork in class Endpoint<EntityEnvelope<PNUser>,PNUpdateUserResult>

createResponse

protected PNUpdateUserResult createResponse(retrofit2.Response<EntityEnvelope<PNUser>> input)
                                     throws PubNubException

Specified by:

createResponse in class Endpoint<EntityEnvelope<PNUser>,PNUpdateUserResult>

Throws:

PubNubException

getOperationType

protected PNOperationType getOperationType()

Specified by:

getOperationType in class Endpoint<EntityEnvelope<PNUser>,PNUpdateUserResult>

isAuthRequired

protected boolean isAuthRequired()

Specified by:

isAuthRequired in class Endpoint<EntityEnvelope<PNUser>,PNUpdateUserResult>

includeFields

public UpdateUser includeFields(PNUserFields... params)

Specified by:

includeFields in interface InclusionParamsProvider<UpdateUser,PNUserFields>

getTmsProperties

public TokenManagerProperties getTmsProperties()

Specified by:

getTmsProperties in interface TokenManagerPropertyProvider

user

public UpdateUser user(PNUser user)