com.kontakt.sdk.android.http.interfaces

Interface DevicesApiAccessor

All Known Subinterfaces:

IKontaktApiClient

All Known Implementing Classes:

KontaktApiClient

public interface DevicesApiAccessor

Devices API accessor provides interface describing interaction with API and Devices management.

Method Summary

Modifier and Type	Method and Description
int	applyCloudConfig(ICloudConfig cloudConfig) Apply cloud confg.
void	applyConfig(ICloudConfig cloudConfig, UpdateApiCallback apiCallback)
int	applyConfig(IConfig config) Applies config.
void	applyConfig(IConfig config, UpdateApiCallback apiCallback)
int	assignBeaconsToManager(java.util.UUID managerId, java.util.Set<java.util.UUID> beaconIdSet) Assign beacons to manager.
void	assignBeaconsToManager(java.util.UUID managerId, java.util.Set<java.util.UUID> beaconIdSet, UpdateApiCallback apiCallback)
int	assignDevicesToVenue(java.util.UUID venueId, java.util.Set<java.util.UUID> deviceIdSet) Assign beacons to venue.
void	assignDevicesToVenue(java.util.UUID venueId, java.util.Set<java.util.UUID> deviceIdSet, UpdateApiCallback apiUpdateCallback)
HttpResult<java.util.List<IAction>>	getActionsForDevice(java.util.UUID proximityUUID, int major, int minor) Requests actions for beacon by proximity values.
void	getActionsForDevice(java.util.UUID proximityUUID, int major, int minor, ResultApiCallback<java.util.List<IAction>> resultApiCallback)
HttpResult<java.util.List<IAction>>	getActionsForDeviceWithProximity(java.util.UUID proximityUUID, int major, int minor, Proximity proximity) Requests actions for beacon by its proximity from android device.
void	getActionsForDeviceWithProximity(java.util.UUID proximityUUID, int major, int minor, Proximity proximity, ResultApiCallback<java.util.List<IAction>> resultApiCallback)
HttpResult<IDevice>	getDevice(java.lang.String deviceUniqueId)
void	getDevice(java.lang.String deviceUniqueId, ResultApiCallback<IDevice> apiCallback)
HttpResult<IDevice>	getDevice(java.lang.String deviceUniqueId, SDKOptional<ETag> eTag) Requests beacon by unique Id sending ETag in newHeader additionally.
void	getDevice(java.lang.String deviceUniqueId, SDKOptional<ETag> etag, ResultApiCallback<IDevice> apiCallback)
HttpResult<IDevice>	getDeviceByProximity(java.util.UUID proximityUUID, int major, int minor)
void	getDeviceByProximity(java.util.UUID proximityUUID, int major, int minor, ResultApiCallback<IDevice> apiCallback)
HttpResult<IDevice>	getDeviceByProximity(java.util.UUID proximityUUID, int major, int minor, SDKOptional<ETag> eTag) Requests beacon by proximity sending ETag in newHeader additionally.
void	getDeviceByProximity(java.util.UUID proximityUUID, int major, int minor, SDKOptional<ETag> eTag, ResultApiCallback<IDevice> apiCallback)
HttpResult<IDevice.Credentials>	getDeviceCredentials(java.lang.String deviceUniqueId, SDKOptional<ETag> eTag)
void	getDeviceCredentials(java.lang.String deviceUniqueId, SDKOptional<ETag> etag, ResultApiCallback<IDevice.Credentials> apiCallback)
HttpResult<java.util.List<IDevice>>	listDevices()
HttpResult<java.util.List<IDevice>>	listDevices(RequestDescription requestDescription) Provides the list of devices.
void	listDevices(RequestDescription requestDescription, ResultApiCallback<java.util.List<IDevice>> apiCallback)
void	listDevices(ResultApiCallback<java.util.List<IDevice>> apiCallback)
HttpResult<java.util.List<IDevice>>	listDevicesForManagers(java.util.Set<java.util.UUID> managerIds)
void	listDevicesForManagers(java.util.Set<java.util.UUID> managerIds, ResultApiCallback<java.util.List<IDevice>> apiCallback)
HttpResult<java.util.List<IDevice>>	listDevicesForManagers(java.util.Set<java.util.UUID> managerIds, SDKOptional<ETag> eTag) Requests beacons for managers by provided manager Ids.
void	listDevicesForManagers(java.util.Set<java.util.UUID> managerIds, SDKOptional<ETag> eTag, ResultApiCallback<java.util.List<IDevice>> apiCallback)
HttpResult<java.util.List<IDevice>>	listUnassignedDevicesForManager(java.util.UUID managerId)
HttpResult<java.util.List<IDevice>>	listUnassignedDevicesForManager(java.util.UUID managerId, RequestDescription requestDescription) Lists unassigned devices for manager for given manager Id.
void	listUnassignedDevicesForManager(java.util.UUID managerId, RequestDescription requestDescription, ResultApiCallback<java.util.List<IDevice>> apiCallback)
void	listUnassignedDevicesForManager(java.util.UUID managerId, ResultApiCallback<java.util.List<IDevice>> apiCallback)
int	moveDevicesToManager(java.util.Set<java.lang.String> deviceUniqueIds, java.util.UUID receiverId, java.util.UUID receiverCompanyId) Moves beacons to Manager with Id and Company Id.
void	moveDevicesToManager(java.util.Set<java.lang.String> deviceUniqueIds, java.util.UUID receiverID, java.util.UUID receiverCompanyId, UpdateApiCallback apiUpdateCallback)
int	updateBeaconPassword(java.lang.String beaconUniqueId, java.lang.String password) Updates Beacon password by Beacon unique Id.
void	updateBeaconPassword(java.lang.String beaconUniqueId, java.lang.String password, UpdateApiCallback callback)
int	updateDevice(DeviceData deviceData) Updates device.
void	updateDevice(DeviceData deviceData, UpdateApiCallback callback)

Methods inherited from interface java.io.Closeable

close

Method Detail

getDeviceCredentials

HttpResult<IDevice.Credentials> getDeviceCredentials(java.lang.String deviceUniqueId,
                                                     SDKOptional<ETag> eTag)
                                              throws ClientException

Throws:

ClientException

getDeviceCredentials

void getDeviceCredentials(java.lang.String deviceUniqueId,
                          SDKOptional<ETag> etag,
                          ResultApiCallback<IDevice.Credentials> apiCallback)

getDeviceByProximity

HttpResult<IDevice> getDeviceByProximity(java.util.UUID proximityUUID,
                                         int major,
                                         int minor,
                                         SDKOptional<ETag> eTag)
                                  throws ClientException

Requests beacon by proximity sending ETag in newHeader additionally. If the ETag's value matches the latest one the code 304 (NOT MODIFIED) is returned.

Parameters:

proximityUUID - the proximity uUID

major - the major

minor - the minor

eTag - the eTag

Returns:

the beacon by proximity

Throws:

ClientException - the client exception

getDeviceByProximity

HttpResult<IDevice> getDeviceByProximity(java.util.UUID proximityUUID,
                                         int major,
                                         int minor)
                                  throws ClientException

Throws:

ClientException

getDeviceByProximity

void getDeviceByProximity(java.util.UUID proximityUUID,
                          int major,
                          int minor,
                          SDKOptional<ETag> eTag,
                          ResultApiCallback<IDevice> apiCallback)

getDeviceByProximity

void getDeviceByProximity(java.util.UUID proximityUUID,
                          int major,
                          int minor,
                          ResultApiCallback<IDevice> apiCallback)

getDevice

HttpResult<IDevice> getDevice(java.lang.String deviceUniqueId,
                              SDKOptional<ETag> eTag)
                       throws ClientException

Requests beacon by unique Id sending ETag in newHeader additionally. If the ETag's value matches the latest one the code 304 (NOT MODIFIED) is returned.

Parameters:

deviceUniqueId - the beacon unique id

eTag - the e tag

Returns:

the beacon

Throws:

ClientException - the client exception

getDevice

HttpResult<IDevice> getDevice(java.lang.String deviceUniqueId)
                       throws ClientException

Throws:

ClientException

getDevice

void getDevice(java.lang.String deviceUniqueId,
               SDKOptional<ETag> etag,
               ResultApiCallback<IDevice> apiCallback)

getDevice

void getDevice(java.lang.String deviceUniqueId,
               ResultApiCallback<IDevice> apiCallback)

listDevices

HttpResult<java.util.List<IDevice>> listDevices(RequestDescription requestDescription)
                                         throws ClientException

Provides the list of devices. According to request description the response:

• may contain sorted list items
• may contain empty body for conditional requests with ETag value included in headers
• may contain list items in ascending or descending order
• may contain ranged list items by specifying start index and offset

Parameters:

requestDescription - the request description

Returns:

the devices

Throws:

ClientException - the client exception

listDevices

HttpResult<java.util.List<IDevice>> listDevices()
                                         throws ClientException

Throws:

ClientException

listDevices

void listDevices(RequestDescription requestDescription,
                 ResultApiCallback<java.util.List<IDevice>> apiCallback)

listDevices

void listDevices(ResultApiCallback<java.util.List<IDevice>> apiCallback)

updateBeaconPassword

int updateBeaconPassword(java.lang.String beaconUniqueId,
                         java.lang.String password)
                  throws ClientException

Updates Beacon password by Beacon unique Id.

Parameters:

beaconUniqueId - the beacon unique id

password - the password

Returns:

the int

Throws:

ClientException - is thrown if unexpected error has occured

updateBeaconPassword

void updateBeaconPassword(java.lang.String beaconUniqueId,
                          java.lang.String password,
                          UpdateApiCallback callback)

listDevicesForManagers

HttpResult<java.util.List<IDevice>> listDevicesForManagers(java.util.Set<java.util.UUID> managerIds,
                                                           SDKOptional<ETag> eTag)
                                                    throws ClientException

Requests beacons for managers by provided manager Ids. If the ETag's value matches the latest one the code 304 (NOT MODIFIED) is returned.

Parameters:

managerIds - the manager ids

eTag - the e tag

Returns:

the devices for managers

Throws:

ClientException - the client exception

listDevicesForManagers

HttpResult<java.util.List<IDevice>> listDevicesForManagers(java.util.Set<java.util.UUID> managerIds)
                                                    throws ClientException

Throws:

ClientException

listDevicesForManagers

void listDevicesForManagers(java.util.Set<java.util.UUID> managerIds,
                            SDKOptional<ETag> eTag,
                            ResultApiCallback<java.util.List<IDevice>> apiCallback)

listDevicesForManagers

void listDevicesForManagers(java.util.Set<java.util.UUID> managerIds,
                            ResultApiCallback<java.util.List<IDevice>> apiCallback)

updateDevice

int updateDevice(DeviceData deviceData)
          throws ClientException

Updates device. Required parameter: device unique Id. The optional parameters are: Proxmity UUID, major, minor, password, txPower interval, alias. If any of the optional values is null, it will not be updated.

Parameters:

deviceData - the device update data

Returns:

the int

Throws:

ClientException - is thrown if unexpected error has occured

updateDevice

void updateDevice(DeviceData deviceData,
                  UpdateApiCallback callback)

moveDevicesToManager

int moveDevicesToManager(java.util.Set<java.lang.String> deviceUniqueIds,
                         java.util.UUID receiverId,
                         java.util.UUID receiverCompanyId)
                  throws ClientException

Moves beacons to Manager with Id and Company Id.

Parameters:

deviceUniqueIds - the beacon unique ids

receiverId - the receiver id

receiverCompanyId - the receiver company id

Returns:

the int

Throws:

ClientException - the client exception

moveDevicesToManager

void moveDevicesToManager(java.util.Set<java.lang.String> deviceUniqueIds,
                          java.util.UUID receiverID,
                          java.util.UUID receiverCompanyId,
                          UpdateApiCallback apiUpdateCallback)

assignDevicesToVenue

int assignDevicesToVenue(java.util.UUID venueId,
                         java.util.Set<java.util.UUID> deviceIdSet)
                  throws ClientException

Assign beacons to venue.

Parameters:

venueId - the venue id

deviceIdSet - the beacon id set

Returns:

the Http Status value. Successful assign returns Http Status: 200.

Throws:

ClientException - is thrown if unexpected error has occured

assignDevicesToVenue

void assignDevicesToVenue(java.util.UUID venueId,
                          java.util.Set<java.util.UUID> deviceIdSet,
                          UpdateApiCallback apiUpdateCallback)

assignBeaconsToManager

int assignBeaconsToManager(java.util.UUID managerId,
                           java.util.Set<java.util.UUID> beaconIdSet)
                    throws ClientException

Assign beacons to manager.

Parameters:

managerId - the manager id

beaconIdSet - the beacon id set

Returns:

the Http Status. Successful assign returns Http Status: 200.

Throws:

ClientException - is thrown if unexpected error has occured

assignBeaconsToManager

void assignBeaconsToManager(java.util.UUID managerId,
                            java.util.Set<java.util.UUID> beaconIdSet,
                            UpdateApiCallback apiCallback)

applyConfig

int applyConfig(IConfig config)
         throws ClientException

Applies config. Successful config application causes erasing it. This method should be used once the Config is created and to be applied to the device.

Parameters:

config - the config

Returns:

the Http Status. Successful Config application returns Http Status: 200.

Throws:

ClientException - is thrown if unexpected error has occured

applyConfig

void applyConfig(IConfig config,
                 UpdateApiCallback apiCallback)

applyCloudConfig

int applyCloudConfig(ICloudConfig cloudConfig)
              throws ClientException

Apply cloud confg.

Parameters:

cloudConfig - the cloud config

Returns:

the Http Status. Successful CloudConfig application retuns Http Status: 200.

Throws:

ClientException - the client exception

applyConfig

void applyConfig(ICloudConfig cloudConfig,
                 UpdateApiCallback apiCallback)

getActionsForDevice

HttpResult<java.util.List<IAction>> getActionsForDevice(java.util.UUID proximityUUID,
                                                        int major,
                                                        int minor)
                                                 throws ClientException

Requests actions for beacon by proximity values.

Parameters:

proximityUUID - the beacon proximity UUID value

major - the major value

minor - the minor value

Returns:

the actions for beacon

Throws:

ClientException - is thrown if unexpected error has occured

getActionsForDevice

void getActionsForDevice(java.util.UUID proximityUUID,
                         int major,
                         int minor,
                         ResultApiCallback<java.util.List<IAction>> resultApiCallback)

getActionsForDeviceWithProximity

HttpResult<java.util.List<IAction>> getActionsForDeviceWithProximity(java.util.UUID proximityUUID,
                                                                     int major,
                                                                     int minor,
                                                                     Proximity proximity)
                                                              throws ClientException

Requests actions for beacon by its proximity from android device.

Parameters:

proximityUUID - the proximity uUID

major - the major

minor - the minor

proximity - the proximity

Returns:

the action for beacon

Throws:

ClientException - is thrown if unexpected error has occured

getActionsForDeviceWithProximity

void getActionsForDeviceWithProximity(java.util.UUID proximityUUID,
                                      int major,
                                      int minor,
                                      Proximity proximity,
                                      ResultApiCallback<java.util.List<IAction>> resultApiCallback)

listUnassignedDevicesForManager

HttpResult<java.util.List<IDevice>> listUnassignedDevicesForManager(java.util.UUID managerId,
                                                                    RequestDescription requestDescription)
                                                             throws ClientException

Lists unassigned devices for manager for given manager Id.

Parameters:

managerId - the manager id

requestDescription - the request description

Returns:

the http result with contents

Throws:

ClientException - the client exception

listUnassignedDevicesForManager

HttpResult<java.util.List<IDevice>> listUnassignedDevicesForManager(java.util.UUID managerId)
                                                             throws ClientException

Throws:

ClientException

listUnassignedDevicesForManager

void listUnassignedDevicesForManager(java.util.UUID managerId,
                                     RequestDescription requestDescription,
                                     ResultApiCallback<java.util.List<IDevice>> apiCallback)

listUnassignedDevicesForManager

void listUnassignedDevicesForManager(java.util.UUID managerId,
                                     ResultApiCallback<java.util.List<IDevice>> apiCallback)