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

Class ShareDeviceRequestExecutor

java.lang.Object

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

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

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

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

   
   IKontaktCloud kontaktCloud = KontaktCloud.newInstance();
   kontaktCloud.devices().share(IDs)
      .toManagers(managerEmails)
      .withAccess(Access.VIEWER)
      .expirationDate(date)
      .execute();
   
 

Keep in mind that managers and access must be specified so invocations of toManagers and withAccess methods are mandatory. Moreover, the Access.OWNER and Access.SUPERVISOR values are prohibited as an input parameters of withAccess method. All conditions must be fulfilled, otherwise an exception will be thrown at runtime.

Constructor Summary

Constructors

Constructor and Description
ShareDeviceRequestExecutor(DevicesService devicesService, java.util.List<java.lang.String> uniqueIds) Constructs request executor initialized with corresponding service class and device unique IDs.
ShareDeviceRequestExecutor(DevicesService devicesService, java.lang.String... uniqueIds) 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.
ShareDeviceRequestExecutor	expirationDate(long expirationDate) Specifies an expiration date.
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.
ShareDeviceRequestExecutor	toManagers(java.util.List<java.lang.String> managerEmails) Specifies managers.
ShareDeviceRequestExecutor	toManagers(java.lang.String... managerEmails) Specifies managers.
ShareDeviceRequestExecutor	withAccess(Access access) Specifies an access.
ShareDeviceRequestExecutor	withMetaData(boolean withMetaData) Indicates if we want to share devices with metadata or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

ShareDeviceRequestExecutor

public ShareDeviceRequestExecutor(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.

ShareDeviceRequestExecutor

public ShareDeviceRequestExecutor(DevicesService devicesService,
                                  java.util.List<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

toManagers

public ShareDeviceRequestExecutor toManagers(java.lang.String... managerEmails)

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

Parameters:

managerEmails - managers email addresses.

Returns:

this request executor.

toManagers

public ShareDeviceRequestExecutor toManagers(java.util.List<java.lang.String> managerEmails)

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

Parameters:

managerEmails - managers email addresses.

Returns:

this request executor.

withAccess

public ShareDeviceRequestExecutor withAccess(Access access)

Specifies an access. Cannot be neither OWNER nor SUPERVISOR.

Parameters:

access - the access.

Returns:

this request executor.

expirationDate

public ShareDeviceRequestExecutor expirationDate(long expirationDate)

Specifies an expiration date.

Parameters:

expirationDate - the expiration date in millis.

Returns:

this request executor.

withMetaData

public ShareDeviceRequestExecutor withMetaData(boolean withMetaData)

Indicates if we want to share devices with metadata or not.

Parameters:

withMetaData - 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.