com.kontakt.sdk.android.cloud.api.executor.actions

Class UpdateContentActionRequestExecutor

java.lang.Object

com.kontakt.sdk.android.cloud.api.executor.RequestExecutor<java.lang.String>

com.kontakt.sdk.android.cloud.api.executor.actions.UpdateContentActionRequestExecutor

public class UpdateContentActionRequestExecutor
extends RequestExecutor<java.lang.String>

Request executor provided by ActionsApi. Use this class if you want to update content actions through fluent API in chained fashion, for example:

   
   IKontaktCloud kontaktCloud = KontaktCloud.newInstance();
   kontaktCloud.actions().updateContentAction(id)
      .withProximity(Proximity.IMMEDIATE)
      .withMediaFile(new File(fileName))
      .execute();
   
 

Field Summary

Fields

Modifier and Type	Field and Description
protected ActionsService	actionsService
protected java.util.UUID	id
protected Proximity	proximity

Constructor Summary

Constructors

Constructor and Description
UpdateContentActionRequestExecutor(ActionsService actionsService, java.util.UUID id) Constructs request executor initialized with corresponding service class and action's id.

Method Summary

Modifier and Type	Method and Description
protected void	checkPreconditions() Checks if all pre conditions are satisfied before sending the request.
java.lang.String	execute() Executes created request synchronously.
void	execute(CloudCallback<java.lang.String> callback) Executes created request asynchronously and invokes callback with the result.
protected java.util.Map<java.lang.String,java.lang.String>	params() Composes the request's parameters in map.
protected retrofit2.Call<java.lang.String>	prepareCall() Prepares a request to execute.
UpdateContentActionRequestExecutor	withMediaFile(java.io.File file) Updates the action's media file.
UpdateContentActionRequestExecutor	withProximity(Proximity proximity) Updates the action's proximity.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

actionsService

protected final ActionsService actionsService

id

protected final java.util.UUID id

proximity

protected Proximity proximity

Constructor Detail

UpdateContentActionRequestExecutor

public UpdateContentActionRequestExecutor(ActionsService actionsService,
                                          java.util.UUID id)

Constructs request executor initialized with corresponding service class and action's id.

Parameters:

actionsService - teh actions API service.

id - the action's unique identifier.

Method Detail

withMediaFile

public UpdateContentActionRequestExecutor withMediaFile(java.io.File file)
                                                 throws java.io.IOException

Updates the action's media file.

Parameters:

file - the media file.

Returns:

this request executor.

Throws:

java.io.IOException - instance of IOException

withProximity

public UpdateContentActionRequestExecutor withProximity(Proximity proximity)

Updates the action's proximity.

Parameters:

proximity - the proximity.

Returns:

this request executor.

checkPreconditions

protected void checkPreconditions()

Checks if all pre conditions are satisfied before sending the request.

params

protected java.util.Map<java.lang.String,java.lang.String> params()

Composes the request's parameters in map.

Returns:

the map of request body parameters that are being used to update data on server.

execute

public java.lang.String execute()
                         throws java.io.IOException,
                                KontaktCloudException

Executes created request synchronously.

Overrides:

execute in class RequestExecutor<java.lang.String>

Returns:

the response object.

Throws:

java.io.IOException - exception

KontaktCloudException - exception

execute

public void execute(CloudCallback<java.lang.String> callback)

Executes created request asynchronously and invokes callback with the result.

Overrides:

execute in class RequestExecutor<java.lang.String>

Parameters:

callback - the callback object.

prepareCall

protected retrofit2.Call<java.lang.String> prepareCall()

Prepares a request to execute.

Specified by:

prepareCall in class RequestExecutor<java.lang.String>

Returns:

the request.