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

Class UpdateDeviceRequestExecutor

java.lang.Object

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

com.kontakt.sdk.android.cloud.api.executor.devices.UpdateDeviceRequestExecutor

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

Request executor provided by DevicesApi. Use this class if you want to update devices through fluent API in chained fashion. Example of use:

   
   IKontaktCloud kontaktCloud = KontaktCloud.newInstance();
   // define updated device object
   kontaktCloud.devices().update(ID)
      .with(updatedDevice)
      .execute();
   
 

Keep in mind that device must be specified so invocation of with method is mandatory. Otherwise an exception will be thrown.

Constructor Summary

Constructors

Constructor and Description
UpdateDeviceRequestExecutor(DevicesService devicesService, java.lang.String uniqueId) Constructs request executor initialized with corresponding service class and device unique ID.

Method Summary

Modifier and Type	Method and Description
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.
UpdateDeviceRequestExecutor	force(boolean force) Ignore this parameter if updating device with firmware 4.0 or higher. Normally the update request for devices with firmware lower than 4.0 will be revoked if there is a pending config available. Setting force to true will overcome this restriction, update device and remove pending config.
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.
UpdateDeviceRequestExecutor	with(Device device) Specifies device data to update.

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateDeviceRequestExecutor

public UpdateDeviceRequestExecutor(DevicesService devicesService,
                                   java.lang.String uniqueId)

Constructs request executor initialized with corresponding service class and device unique ID.

Parameters:

devicesService - the devices API service.

uniqueId - device unique identifier.

Method Detail

with

public UpdateDeviceRequestExecutor with(Device device)

Specifies device data to update. The method invocation is obligatory while using this request executor.

Parameters:

device - updated device data.

Returns:

this request executor.

force

public UpdateDeviceRequestExecutor force(boolean force)

Ignore this parameter if updating device with firmware 4.0 or higher.

Normally the update request for devices with firmware lower than 4.0 will be revoked if there is a pending config available.
Setting force to true will overcome this restriction, update device and remove pending config.

Parameters:

force - true or false

Returns:

this request executor.

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.

params

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

Composes the request's parameters in map.

Specified by:

params in class RequestExecutor<java.lang.String>

Returns:

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