com.kontakt.sdk.android.http.interfaces

Interface DevicesApiAccessor

All Known Subinterfaces:

IKontaktApiClient

All Known Implementing Classes:

KontaktApiClient

public interface DevicesApiAccessor

The interface Devices api accessor.

Method Summary

Modifier and Type	Method and Description
int	applyCloudConfig(ICloudConfig cloudConfig) Apply cloud config.
void	applyConfig(ICloudConfig cloudConfig, UpdateApiCallback apiCallback) Apply config.
int	applyConfig(IConfig config) Apply config.
void	applyConfig(IConfig config, UpdateApiCallback apiCallback) Apply config.
HttpResult<java.util.List<SecureSingleConfig>>	applySecureConfig(java.util.Collection<SecureSingleConfig> secureConfigApplies) Applies secure config to cloud.
void	applySecureConfig(java.util.Collection<SecureSingleConfig> secureConfigApplies, ResultApiCallback<java.util.List<SecureSingleConfig>> apiCallback) Applies secure config to cloud.
int	assignDevicesToManager(java.util.UUID managerId, java.util.Set<java.util.UUID> beaconIdSet) Assign devices to manager.
void	assignDevicesToManager(java.util.UUID managerId, java.util.Set<java.util.UUID> beaconIdSet, UpdateApiCallback apiCallback) Assign devices to manager.
int	assignDevicesToVenue(java.util.UUID venueId, java.util.Set<java.util.UUID> deviceIdSet) Assign devices to venue.
void	assignDevicesToVenue(java.util.UUID venueId, java.util.Set<java.util.UUID> deviceIdSet, UpdateApiCallback apiUpdateCallback) Assign devices to venue.
HttpResult<IDevice>	getDevice(java.lang.String deviceUniqueId) Gets device.
void	getDevice(java.lang.String deviceUniqueId, ResultApiCallback<IDevice> apiCallback) Gets device.
HttpResult<IDevice>	getDevice(java.lang.String deviceUniqueId, SDKOptional<ETag> eTag) Gets device.
void	getDevice(java.lang.String deviceUniqueId, SDKOptional<ETag> etag, ResultApiCallback<IDevice> apiCallback) Gets device.
HttpResult<IDevice>	getDeviceByNamespaceAndInstanceId(java.lang.String namespace, java.lang.String instanceId) Gets device by namespace and instance id.
void	getDeviceByNamespaceAndInstanceId(java.lang.String namespace, java.lang.String instanceId, ResultApiCallback<IDevice> apiCallback) Gets device by namespace and instance id.
HttpResult<IDevice>	getDeviceByNamespaceAndInstanceId(java.lang.String namespace, java.lang.String instanceId, SDKOptional<ETag> eTag) Gets device by namespace and instance id.
void	getDeviceByNamespaceAndInstanceId(java.lang.String namespace, java.lang.String instanceId, SDKOptional<ETag> eTag, ResultApiCallback<IDevice> apiCallback) Gets device by namespace and instance id.
HttpResult<ICredentials>	getDeviceCredentials(java.lang.String deviceUniqueId, SDKOptional<ETag> eTag) Gets device credentials.
void	getDeviceCredentials(java.lang.String deviceUniqueId, SDKOptional<ETag> etag, ResultApiCallback<ICredentials> apiCallback) Gets device credentials.
HttpResult<java.util.List<IDevice>>	getDevicesByProximity(java.util.UUID proximityUUID, int major, int minor) Gets devices by proximity.
void	getDevicesByProximity(java.util.UUID proximityUUID, int major, int minor, ResultApiCallback<java.util.List<IDevice>> apiCallback) Gets devices by proximity.
HttpResult<java.util.List<IDevice>>	getDevicesByProximity(java.util.UUID proximityUUID, int major, int minor, SDKOptional<ETag> eTag) Gets devices by proximity.
void	getDevicesByProximity(java.util.UUID proximityUUID, int major, int minor, SDKOptional<ETag> eTag, ResultApiCallback<java.util.List<IDevice>> apiCallback) Gets devices by proximity.
HttpResult<java.util.List<IDevice>>	listDevices() List devices.
HttpResult<java.util.List<IDevice>>	listDevices(RequestDescription requestDescription) List devices.
void	listDevices(RequestDescription requestDescription, ResultApiCallback<java.util.List<IDevice>> apiCallback) List devices.
void	listDevices(ResultApiCallback<java.util.List<IDevice>> apiCallback) List devices.
HttpResult<java.util.List<ICredentials>>	listDevicesCredentials(java.util.Collection<java.lang.String> uniqueIds, SDKOptional<ETag> eTag) Provides credentials list for devices unique identifiers.
void	listDevicesCredentials(java.util.Collection<java.lang.String> uniqueIds, SDKOptional<ETag> eTag, ResultApiCallback<java.util.List<ICredentials>> resultApiCallback) Provides credentials list for devices unique identifiers asynchronously.
HttpResult<java.util.List<IDevice>>	listDevicesForManagers(java.util.Set<java.util.UUID> managerIds) List devices for managers.
void	listDevicesForManagers(java.util.Set<java.util.UUID> managerIds, ResultApiCallback<java.util.List<IDevice>> apiCallback) List devices for managers.
HttpResult<java.util.List<IDevice>>	listDevicesForManagers(java.util.Set<java.util.UUID> managerIds, SDKOptional<ETag> eTag) List devices for managers.
void	listDevicesForManagers(java.util.Set<java.util.UUID> managerIds, SDKOptional<ETag> eTag, ResultApiCallback<java.util.List<IDevice>> apiCallback) List devices for managers.
HttpResult<java.util.List<IDevice>>	listUnassignedDevicesForManager(java.util.UUID managerId) List unassigned devices for manager.
HttpResult<java.util.List<IDevice>>	listUnassignedDevicesForManager(java.util.UUID managerId, RequestDescription requestDescription) List unassigned devices for manager.
void	listUnassignedDevicesForManager(java.util.UUID managerId, RequestDescription requestDescription, ResultApiCallback<java.util.List<IDevice>> apiCallback) List unassigned devices for manager.
void	listUnassignedDevicesForManager(java.util.UUID managerId, ResultApiCallback<java.util.List<IDevice>> apiCallback) List unassigned devices for manager.
int	moveDevicesToManager(java.util.Set<java.lang.String> deviceUniqueIds, java.util.UUID receiverId, java.util.UUID receiverCompanyId) Move devices to manager.
void	moveDevicesToManager(java.util.Set<java.lang.String> deviceUniqueIds, java.util.UUID receiverID, java.util.UUID receiverCompanyId, UpdateApiCallback apiUpdateCallback) Move devices to manager.
HttpResult<java.util.List<EddystoneFutureUID>>	resolveEddystone(java.util.Collection<EddystoneUID> eddystoneUids, SDKOptional<ETag> eTag) Resolves shuffled to true eddystone uids (namespace, instance id)
void	resolveEddystone(java.util.Collection<EddystoneUID> eddystoneUids, SDKOptional<ETag> eTag, ResultApiCallback<java.util.List<EddystoneFutureUID>> apiCallback) Resolves shuffled to true eddystone uids (namespace, instance id)
HttpResult<java.util.List<IBeaconFutureId>>	resolveIBeacon(java.util.Collection<BeaconId> beaconIds, SDKOptional<ETag> eTag) Resolves shuffled to true beacon ids (proximity, major, minor)
void	resolveIBeacon(java.util.Collection<BeaconId> beaconIds, SDKOptional<ETag> eTag, ResultApiCallback<java.util.List<IBeaconFutureId>> apiCallback) Resolves shuffled to true beacon ids (proximity, major, minor)
int	updateDevice(DeviceData deviceData) Update device.
void	updateDevice(DeviceData deviceData, UpdateApiCallback callback) Update device.
int	updateDevicePassword(java.lang.String beaconUniqueId, java.lang.String password) Update device password.
void	updateDevicePassword(java.lang.String beaconUniqueId, java.lang.String password, UpdateApiCallback callback) Update device password.

Methods inherited from interface java.io.Closeable

close

Method Detail

getDeviceCredentials

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

Gets device credentials.

Parameters:

deviceUniqueId - the device unique id

eTag - the e tag

Returns:

the device credentials

Throws:

ClientException - the client exception

listDevicesCredentials

HttpResult<java.util.List<ICredentials>> listDevicesCredentials(java.util.Collection<java.lang.String> uniqueIds,
                                                                SDKOptional<ETag> eTag)
                                                         throws ClientException

Provides credentials list for devices unique identifiers.

Parameters:

uniqueIds - the unique ids

eTag - the e tag

Returns:

the devices credentials

Throws:

ClientException - the client exception

listDevicesCredentials

void listDevicesCredentials(java.util.Collection<java.lang.String> uniqueIds,
                            SDKOptional<ETag> eTag,
                            ResultApiCallback<java.util.List<ICredentials>> resultApiCallback)

Provides credentials list for devices unique identifiers asynchronously.

Parameters:

uniqueIds - the unique ids

eTag - the e tag

Throws:

ClientException - the client exception

getDeviceCredentials

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

Gets device credentials.

Parameters:

deviceUniqueId - the device unique id

etag - the etag

apiCallback - the api callback

getDevicesByProximity

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

Gets devices by proximity.

Parameters:

proximityUUID - the proximity uUID

major - the major

minor - the minor

eTag - the e tag

Returns:

the devices by proximity

Throws:

ClientException - the client exception

getDevicesByProximity

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

Gets devices by proximity.

Parameters:

proximityUUID - the proximity uUID

major - the major

minor - the minor

Returns:

the devices by proximity

Throws:

ClientException - the client exception

getDevicesByProximity

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

Gets devices by proximity.

Parameters:

proximityUUID - the proximity uUID

major - the major

minor - the minor

eTag - the e tag

apiCallback - the api callback

getDevicesByProximity

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

Gets devices by proximity.

Parameters:

proximityUUID - the proximity uUID

major - the major

minor - the minor

apiCallback - the api callback

getDeviceByNamespaceAndInstanceId

HttpResult<IDevice> getDeviceByNamespaceAndInstanceId(java.lang.String namespace,
                                                      java.lang.String instanceId,
                                                      SDKOptional<ETag> eTag)
                                               throws ClientException

Gets device by namespace and instance id.

Parameters:

namespace - the namespace

instanceId - the instance id

eTag - the e tag

Returns:

the device by namespace and instance id

Throws:

ClientException - the client exception

getDeviceByNamespaceAndInstanceId

HttpResult<IDevice> getDeviceByNamespaceAndInstanceId(java.lang.String namespace,
                                                      java.lang.String instanceId)
                                               throws ClientException

Gets device by namespace and instance id.

Parameters:

namespace - the namespace

instanceId - the instance id

Returns:

the device by namespace and instance id

Throws:

ClientException - the client exception

getDeviceByNamespaceAndInstanceId

void getDeviceByNamespaceAndInstanceId(java.lang.String namespace,
                                       java.lang.String instanceId,
                                       SDKOptional<ETag> eTag,
                                       ResultApiCallback<IDevice> apiCallback)

Gets device by namespace and instance id.

Parameters:

namespace - the namespace

instanceId - the instance id

eTag - the e tag

apiCallback - the api callback

getDeviceByNamespaceAndInstanceId

void getDeviceByNamespaceAndInstanceId(java.lang.String namespace,
                                       java.lang.String instanceId,
                                       ResultApiCallback<IDevice> apiCallback)

Gets device by namespace and instance id.

Parameters:

namespace - the namespace

instanceId - the instance id

apiCallback - the api callback

getDevice

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

Gets device.

Parameters:

deviceUniqueId - the device unique id

eTag - the e tag

Returns:

the device

Throws:

ClientException - the client exception

getDevice

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

Gets device.

Parameters:

deviceUniqueId - the device unique id

Returns:

the device

Throws:

ClientException - the client exception

getDevice

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

Gets device.

Parameters:

deviceUniqueId - the device unique id

etag - the etag

apiCallback - the api callback

getDevice

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

Gets device.

Parameters:

deviceUniqueId - the device unique id

apiCallback - the api callback

listDevices

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

List devices.

Returns:

the http result

Throws:

ClientException - the client exception

listDevices

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

List devices.

Parameters:

requestDescription - the request description

Returns:

the http result

Throws:

ClientException - the client exception

listDevices

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

List devices.

Parameters:

requestDescription - the request description

apiCallback - the api callback

listDevices

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

List devices.

Parameters:

apiCallback - the api callback

updateDevicePassword

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

Update device password.

Parameters:

beaconUniqueId - the beacon unique id

password - the password

Returns:

the int

Throws:

ClientException - the client exception

updateDevicePassword

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

Update device password.

Parameters:

beaconUniqueId - the beacon unique id

password - the password

callback - the callback

listDevicesForManagers

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

List devices for managers.

Parameters:

managerIds - the manager ids

eTag - the e tag

Returns:

the http result

Throws:

ClientException - the client exception

listDevicesForManagers

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

List devices for managers.

Parameters:

managerIds - the manager ids

Returns:

the http result

Throws:

ClientException - the client exception

listDevicesForManagers

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

List devices for managers.

Parameters:

managerIds - the manager ids

eTag - the e tag

apiCallback - the api callback

listDevicesForManagers

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

List devices for managers.

Parameters:

managerIds - the manager ids

apiCallback - the api callback

updateDevice

int updateDevice(DeviceData deviceData)
          throws ClientException

Update device.

Parameters:

deviceData - the device data

Returns:

the int

Throws:

ClientException - the client exception

updateDevice

void updateDevice(DeviceData deviceData,
                  UpdateApiCallback callback)

Update device.

Parameters:

deviceData - the device data

callback - the callback

moveDevicesToManager

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

Move devices to manager.

Parameters:

deviceUniqueIds - the device 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)

Move devices to manager.

Parameters:

deviceUniqueIds - the device unique ids

receiverID - the receiver iD

receiverCompanyId - the receiver company id

apiUpdateCallback - the api update callback

assignDevicesToVenue

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

Assign devices to venue.

Parameters:

venueId - the venue id

deviceIdSet - the device id set

Returns:

the int

Throws:

ClientException - the client exception

assignDevicesToVenue

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

Assign devices to venue.

Parameters:

venueId - the venue id

deviceIdSet - the device id set

apiUpdateCallback - the api update callback

assignDevicesToManager

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

Assign devices to manager.

Parameters:

managerId - the manager id

beaconIdSet - the beacon id set

Returns:

the int

Throws:

ClientException - the client exception

assignDevicesToManager

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

Assign devices to manager.

Parameters:

managerId - the manager id

beaconIdSet - the beacon id set

apiCallback - the api callback

applyConfig

int applyConfig(IConfig config)
         throws ClientException

Apply config.

Parameters:

config - the config

Returns:

the int

Throws:

ClientException - the client exception

applyConfig

void applyConfig(IConfig config,
                 UpdateApiCallback apiCallback)

Apply config.

Parameters:

config - the config

apiCallback - the api callback

applyCloudConfig

int applyCloudConfig(ICloudConfig cloudConfig)
              throws ClientException

Apply cloud config.

Parameters:

cloudConfig - the cloud config

Returns:

the int

Throws:

ClientException - the client exception

applyConfig

void applyConfig(ICloudConfig cloudConfig,
                 UpdateApiCallback apiCallback)

Apply config.

Parameters:

cloudConfig - the cloud config

apiCallback - the api callback

listUnassignedDevicesForManager

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

List unassigned devices for manager.

Parameters:

managerId - the manager id

requestDescription - the request description

Returns:

the http result

Throws:

ClientException - the client exception

listUnassignedDevicesForManager

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

List unassigned devices for manager.

Parameters:

managerId - the manager id

Returns:

the http result

Throws:

ClientException - the client exception

listUnassignedDevicesForManager

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

List unassigned devices for manager.

Parameters:

managerId - the manager id

requestDescription - the request description

apiCallback - the api callback

listUnassignedDevicesForManager

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

List unassigned devices for manager.

Parameters:

managerId - the manager id

apiCallback - the api callback

resolveIBeacon

void resolveIBeacon(java.util.Collection<BeaconId> beaconIds,
                    SDKOptional<ETag> eTag,
                    ResultApiCallback<java.util.List<IBeaconFutureId>> apiCallback)

Resolves shuffled to true beacon ids (proximity, major, minor)

Parameters:

beaconIds - the beacon ids

eTag - the e tag

apiCallback - the api callback

resolveIBeacon

HttpResult<java.util.List<IBeaconFutureId>> resolveIBeacon(java.util.Collection<BeaconId> beaconIds,
                                                           SDKOptional<ETag> eTag)
                                                    throws ClientException

Resolves shuffled to true beacon ids (proximity, major, minor)

Parameters:

beaconIds - the beacon ids

eTag - the e tag

Returns:

list of resolved beacon ids with future shuffles

Throws:

ClientException

resolveEddystone

void resolveEddystone(java.util.Collection<EddystoneUID> eddystoneUids,
                      SDKOptional<ETag> eTag,
                      ResultApiCallback<java.util.List<EddystoneFutureUID>> apiCallback)

Resolves shuffled to true eddystone uids (namespace, instance id)

Parameters:

eddystoneUids - the eddystone uids

eTag - the e tag

apiCallback - the api callback

resolveEddystone

HttpResult<java.util.List<EddystoneFutureUID>> resolveEddystone(java.util.Collection<EddystoneUID> eddystoneUids,
                                                                SDKOptional<ETag> eTag)
                                                         throws ClientException

Resolves shuffled to true eddystone uids (namespace, instance id)

Parameters:

eddystoneUids - the eddystoen uids

eTag - the e tag

Returns:

list of resolved eddystone uids with future shuffles

Throws:

ClientException

applySecureConfig

HttpResult<java.util.List<SecureSingleConfig>> applySecureConfig(java.util.Collection<SecureSingleConfig> secureConfigApplies)
                                                          throws ClientException

Applies secure config to cloud.

Parameters:

secureConfigApplies - collection with secure configs created from beacon response

Returns:

Collection with next secure configs to apply on device, in most cases it will be empty

Throws:

ClientException

applySecureConfig

void applySecureConfig(java.util.Collection<SecureSingleConfig> secureConfigApplies,
                       ResultApiCallback<java.util.List<SecureSingleConfig>> apiCallback)

Applies secure config to cloud.

Parameters:

secureConfigApplies - collection with secure configs created from beacon response

apiCallback - the api callback with collection with next secure configs to apply on device, in most cases it will be empty