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

Class CreateContentActionRequestExecutor

java.lang.Object

com.kontakt.sdk.android.cloud.api.executor.RequestExecutor<Action>

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

public class CreateContentActionRequestExecutor
extends RequestExecutor<Action>

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

   
   IKontaktCloud kontaktCloud = KontaktCloud.newInstance();
   Action contentAction = kontaktCloud.actions().createContentAction()
      .forDevices("AxT7")
      .withProximity(Proximity.NEAR)
      .withMediaFile(new File(fileName))
      .execute();
   
 

Field Summary

Fields

Modifier and Type	Field and Description
protected ActionsService	actionsService
protected Action.Type	actionType
protected Proximity	proximity
protected java.lang.String[]	uniqueIds

Constructor Summary

Constructors

Constructor and Description
CreateContentActionRequestExecutor(ActionsService actionsService) Constructs request executor initialized with corresponding service class.

Method Summary

Modifier and Type	Method and Description
protected void	checkPreconditions() Checks if all pre conditions are satisfied before sending the request.
Action	execute() Executes created request synchronously.
void	execute(CloudCallback<Action> callback) Executes created request asynchronously and invokes callback with the result.
CreateContentActionRequestExecutor	forDevices(java.util.List<java.lang.String> uniqueIds) Specifies associated devices.
CreateContentActionRequestExecutor	forDevices(java.lang.String... uniqueIds) Specifies associated devices.
CreateContentActionRequestExecutor	multipart(boolean isMultipart) Indicates if create action with multipart or not.
protected java.util.Map<java.lang.String,java.lang.String>	params() Composes the request's parameters in map.
protected retrofit2.Call<Action>	prepareCall() Prepares a request to execute.
CreateContentActionRequestExecutor	withMediaFile(java.io.File file) Specifies a media file of newly created action.
CreateContentActionRequestExecutor	withProximity(Proximity proximity) Specifies the proximity of newly created action.

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

uniqueIds

protected java.lang.String[] uniqueIds

actionType

protected Action.Type actionType

proximity

protected Proximity proximity

Constructor Detail

CreateContentActionRequestExecutor

public CreateContentActionRequestExecutor(ActionsService actionsService)

Constructs request executor initialized with corresponding service class.

Parameters:

actionsService - the actions API service.

Method Detail

withMediaFile

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

Specifies a media file of newly created action.

Parameters:

file - the media file.

Returns:

this request executor.

Throws:

java.io.IOException - instance of IOException

multipart

public CreateContentActionRequestExecutor multipart(boolean isMultipart)

Indicates if create action with multipart or not.

Parameters:

isMultipart - true or false

Returns:

this request executor.

forDevices

public CreateContentActionRequestExecutor forDevices(java.lang.String... uniqueIds)

Specifies associated devices. The method invocation is obligatory while using this request executor.

Parameters:

uniqueIds - the device unique identifiers.

Returns:

this request executor.

forDevices

public CreateContentActionRequestExecutor forDevices(java.util.List<java.lang.String> uniqueIds)

Specifies associated devices. The method invocation is obligatory while using this request executor.

Parameters:

uniqueIds - the device unique identifiers.

Returns:

this request executor.

withProximity

public CreateContentActionRequestExecutor withProximity(Proximity proximity)

Specifies the proximity of newly created action.

Parameters:

proximity - the proximity.

Returns:

this request executor.

prepareCall

protected retrofit2.Call<Action> prepareCall()

Prepares a request to execute.

Returns:

the request.

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 Action execute()
               throws java.io.IOException,
                      KontaktCloudException

Executes created request synchronously.

Overrides:

execute in class RequestExecutor<Action>

Returns:

the response object.

Throws:

java.io.IOException - exception

KontaktCloudException - exception

execute

public void execute(CloudCallback<Action> callback)

Executes created request asynchronously and invokes callback with the result.

Overrides:

execute in class RequestExecutor<Action>

Parameters:

callback - the callback object.