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

Class AssignDeviceRequestExecutor

java.lang.Object

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

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

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

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

   
   IKontaktCloud kontaktCloud = KontaktCloud.newInstance();
   kontaktCloud.devices().assign(IDs)
      .toManager(managerId)
      .execute();
   
 

Keep in mind that toManager cannot be used with toVenue and so on. In such a situation an exception will be thrown at runtime.

Constructor Summary

Constructors

Constructor and Description
AssignDeviceRequestExecutor(DevicesService devicesService, java.lang.String... uniqueIds) Constructs request executor initialized with corresponding service class and device unique IDs.
AssignDeviceRequestExecutor(DevicesService devicesService, java.util.UUID... deviceIds) Constructs request executor initialized with corresponding service class and device unique IDs.

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.
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.
AssignDeviceRequestExecutor	toManager(java.util.UUID managerId) Specifies the manager.
AssignDeviceRequestExecutor	toVenue(java.util.UUID venueId) Specifies the venue.

Methods inherited from class java.lang.Object

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

Constructor Detail

AssignDeviceRequestExecutor

public AssignDeviceRequestExecutor(DevicesService devicesService,
                                   java.util.UUID... deviceIds)

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

Parameters:

devicesService - the devices API service.

deviceIds - device unique identifiers.

AssignDeviceRequestExecutor

public AssignDeviceRequestExecutor(DevicesService devicesService,
                                   java.lang.String... uniqueIds)

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

Parameters:

devicesService - the devices API service.

uniqueIds - device unique identifiers.

Method Detail

toVenue

public AssignDeviceRequestExecutor toVenue(java.util.UUID venueId)

Specifies the venue. Cannot be used with toManager simultaneously.

Parameters:

venueId - venue unique identifier.

Returns:

this request executor.

toManager

public AssignDeviceRequestExecutor toManager(java.util.UUID managerId)

Specifies the manager. Cannot be used with toVenue simultaneously.

Parameters:

managerId - manager unique identifier.

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.