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

Class CreateConfigRequestExecutor

java.lang.Object

com.kontakt.sdk.android.cloud.api.executor.RequestExecutor<Config[]>

com.kontakt.sdk.android.cloud.api.executor.configs.CreateConfigRequestExecutor

public class CreateConfigRequestExecutor
extends RequestExecutor<Config[]>

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

   
   IKontaktCloud kontaktCloud = KontaktCloud.newInstance();
   Config config = new Config.Builder().major(532).minor(111).build();
   kontaktCloud.configs().create(config)
      .forDevices("AxT7", "GVy6", "9KiJ")
      .withType(DeviceType.BEACON)
      .execute();
   
 

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

Constructor Summary

Constructors

Constructor and Description
CreateConfigRequestExecutor(ConfigsService configsService, Config config) Constructs request executor initialized with corresponding service class and new config object.

Method Summary

Modifier and Type	Method and Description
Config[]	execute() Executes created request synchronously.
void	execute(CloudCallback<Config[]> callback) Executes created request asynchronously and invokes callback with the result.
CreateConfigRequestExecutor	forDevices(java.util.List<java.lang.String> uniqueIds) Specifies devices.
CreateConfigRequestExecutor	forDevices(java.lang.String... uniqueIds) Specifies devices.
protected java.util.Map<java.lang.String,java.lang.String>	params() Composes the request's parameters in map.
protected retrofit2.Call<Config[]>	prepareCall() Prepares a request to execute.
CreateConfigRequestExecutor	withType(DeviceType type) Specifies device type.

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateConfigRequestExecutor

public CreateConfigRequestExecutor(ConfigsService configsService,
                                   Config config)

Constructs request executor initialized with corresponding service class and new config object.

Parameters:

configsService - the configs API service.

config - new config.

Method Detail

forDevices

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

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

Parameters:

uniqueIds - the device unique identifiers.

Returns:

this request executor.

forDevices

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

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

Parameters:

uniqueIds - the device unique identifiers.

Returns:

this request executor.

withType

public CreateConfigRequestExecutor withType(DeviceType type)

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

Parameters:

type - the device type.

Returns:

this request executor.

execute

public Config[] execute()
                 throws java.io.IOException,
                        KontaktCloudException

Executes created request synchronously.

Overrides:

execute in class RequestExecutor<Config[]>

Returns:

the response object.

Throws:

java.io.IOException - exception

KontaktCloudException - exception

execute

public void execute(CloudCallback<Config[]> callback)

Executes created request asynchronously and invokes callback with the result.

Overrides:

execute in class RequestExecutor<Config[]>

Parameters:

callback - the callback object.

prepareCall

protected retrofit2.Call<Config[]> prepareCall()

Prepares a request to execute.

Specified by:

prepareCall in class RequestExecutor<Config[]>

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<Config[]>

Returns:

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