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

Class ScheduleFirmwareUpdateRequestExecutor

java.lang.Object

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

com.kontakt.sdk.android.cloud.api.executor.firmwares.ScheduleFirmwareUpdateRequestExecutor

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

Request executor provided by FirmwaresApi. Use this class if you want to schedule firmware update through fluent API in chained fashion, for example:

   
   IKontaktCloud kontaktCloud = KontaktCloud.newInstance();
   kontaktCloud.firmwares().scheduleUpdate()
      .forDevices("4DgT", "8JkU")
      .withVersion("4.0")
      .execute();
   
 

Keep in mind that devices and version must be specified so invocations of forDevices and withVersion methods are mandatory. Otherwise an exception will be thrown.

Constructor Summary

Constructors

Constructor and Description
ScheduleFirmwareUpdateRequestExecutor(FirmwaresService firmwaresService) Constructs request executor initialized with corresponding service class.

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.
ScheduleFirmwareUpdateRequestExecutor	forDevices(java.util.List<java.lang.String> deviceUniqueIds) Specifies devices.
ScheduleFirmwareUpdateRequestExecutor	forDevices(java.lang.String... deviceUniqueIds) Specifies devices.
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.
ScheduleFirmwareUpdateRequestExecutor	withVersion(java.lang.String name) Specifies the version name.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScheduleFirmwareUpdateRequestExecutor

public ScheduleFirmwareUpdateRequestExecutor(FirmwaresService firmwaresService)

Constructs request executor initialized with corresponding service class.

Parameters:

firmwaresService - the firmwares API service.

Method Detail

forDevices

public ScheduleFirmwareUpdateRequestExecutor forDevices(java.lang.String... deviceUniqueIds)

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

Parameters:

deviceUniqueIds - the device unique identifiers.

Returns:

this request executor.

forDevices

public ScheduleFirmwareUpdateRequestExecutor forDevices(java.util.List<java.lang.String> deviceUniqueIds)

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

Parameters:

deviceUniqueIds - the device unique identifiers.

Returns:

this request executor.

withVersion

public ScheduleFirmwareUpdateRequestExecutor withVersion(java.lang.String name)

Specifies the version name. The method invocation is obligatory while using this request executor.

Parameters:

name - the version name.

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.