com.kontakt.sdk.android.cloud.api

Class DevicesApi

java.lang.Object

com.kontakt.sdk.android.cloud.api.DevicesApi

public class DevicesApi
extends java.lang.Object

An abstract representation of Devices API endpoint. Provides executors that can be used to handle all device-related requests.

Constructor Summary

Constructors

Constructor and Description
DevicesApi(DevicesService devicesService) Constructs Devices API endpoint initialized with corresponding service class.

Method Summary

Modifier and Type	Method and Description
ApplySecureConfigRequestExecutor	applySecureConfigs(Config... configs) Provides executor that can be used to apply secure configs on devices.
ApplySecureConfigRequestExecutor	applySecureConfigs(java.util.List<Config> configs) Provides executor that can be used to apply secure configs on devices.
AssignDeviceRequestExecutor	assign(java.lang.String... uniqueIds) Provides executor that can be used to assign devices either to venue or to manager.
AssignDeviceRequestExecutor	assign(java.util.UUID... deviceIds) Provides executor that can be used to assign devices either to venue or to manager.
CredentialsListRequestExecutor	credentials(java.util.List<java.lang.String> uniqueIds) Provides executor that can be used to obtain multiple device credentials.
CredentialsRequestExecutor	credentials(java.lang.String uniqueId) Provides executor that can be used to obtain single device credentials.
TelemetryRequestExecutor	decryptTelemetry(java.lang.String eid, java.lang.String etlmFrame) Provides executor that can be used to decrypt encrypted TLM frame
EddystonesRequestExecutor	eddystones() Provides executor that can be used to obtain Eddystone devices.
DevicesRequestExecutor	fetch() Provides executor that can be used to obtain devices.
DevicesFromUrlRequestExecutor	fetchFromUrl(java.lang.String url) Provides executor responsible for loading devices from URL.
IBeaconsRequestExecutor	ibeacons() Provides executor that can be used to obtain iBeacon devices.
MoveDeviceRequestExecutor	move(java.util.List<java.lang.String> uniqueIds) Provides executor that can be used to move devices to another manager or company.
MoveDeviceRequestExecutor	move(java.lang.String... uniqueIds) Provides executor that can be used to move devices to another manager or company.
RegisterDeviceRequestExecutor	register(java.lang.String sourceId) Provides executor that can be used to register the device.
ShareDeviceRequestExecutor	share(java.util.List<java.lang.String> uniqueIds) Provides executor that can be used to share devices with other managers.
ShareDeviceRequestExecutor	share(java.lang.String... uniqueIds) Provides executor that can be used to share devices with other managers.
UnassignDeviceRequestExecutor	unassignFromVenue(java.util.List<java.lang.String> uniqueIds) Provides executor that can be used to unassign devices from venue.
UnassignDeviceRequestExecutor	unassignFromVenue(java.lang.String... uniqueIds) Provides executor that can be used to unassign devices from venue.
UnshareDeviceRequestExecutor	unshare(java.util.List<java.lang.String> uniqueIds) Provides executor that can be used to unshare devices from managers.
UnshareDeviceRequestExecutor	unshare(java.lang.String... uniqueIds) Provides executor that can be used to unshare devices from managers.
UpdateDeviceRequestExecutor	update(java.lang.String uniqueId) Provides executor that can be used to update a device.

Methods inherited from class java.lang.Object

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

Constructor Detail

DevicesApi

public DevicesApi(DevicesService devicesService)

Constructs Devices API endpoint initialized with corresponding service class.

Parameters:

devicesService - the actions API service.

Method Detail

fetch

public DevicesRequestExecutor fetch()

Provides executor that can be used to obtain devices.

Returns:

the request executor.

fetchFromUrl

public DevicesFromUrlRequestExecutor fetchFromUrl(java.lang.String url)

Provides executor responsible for loading devices from URL.

Parameters:

url - the URL.

Returns:

the request executor.

eddystones

public EddystonesRequestExecutor eddystones()

Provides executor that can be used to obtain Eddystone devices.

Returns:

the request executor.

ibeacons

public IBeaconsRequestExecutor ibeacons()

Provides executor that can be used to obtain iBeacon devices.

Returns:

the request executor.

credentials

public CredentialsRequestExecutor credentials(java.lang.String uniqueId)

Provides executor that can be used to obtain single device credentials.

Parameters:

uniqueId - the device's unique identifier.

Returns:

the request executor.

credentials

public CredentialsListRequestExecutor credentials(java.util.List<java.lang.String> uniqueIds)

Provides executor that can be used to obtain multiple device credentials.

Parameters:

uniqueIds - device unique identifiers.

Returns:

the request executor.

decryptTelemetry

public TelemetryRequestExecutor decryptTelemetry(java.lang.String eid,
                                                 java.lang.String etlmFrame)

Provides executor that can be used to decrypt encrypted TLM frame

Parameters:

eid - eddystone EID

etlmFrame - encrypted TLM frame

Returns:

the request executor.

update

public UpdateDeviceRequestExecutor update(java.lang.String uniqueId)

Provides executor that can be used to update a device.

Parameters:

uniqueId - the device's unique identifier.

Returns:

the request executor.

assign

public AssignDeviceRequestExecutor assign(java.util.UUID... deviceIds)

Provides executor that can be used to assign devices either to venue or to manager.

Parameters:

deviceIds - device unique identifiers.

Returns:

the request executor.

assign

public AssignDeviceRequestExecutor assign(java.lang.String... uniqueIds)

Provides executor that can be used to assign devices either to venue or to manager.

Parameters:

uniqueIds - device unique identifiers.

Returns:

the request executor.

unassignFromVenue

public UnassignDeviceRequestExecutor unassignFromVenue(java.lang.String... uniqueIds)

Provides executor that can be used to unassign devices from venue.

Parameters:

uniqueIds - device unique identifiers.

Returns:

the request executor.

unassignFromVenue

public UnassignDeviceRequestExecutor unassignFromVenue(java.util.List<java.lang.String> uniqueIds)

Provides executor that can be used to unassign devices from venue.

Parameters:

uniqueIds - device unique identifiers.

Returns:

the request executor.

move

public MoveDeviceRequestExecutor move(java.lang.String... uniqueIds)

Provides executor that can be used to move devices to another manager or company.

Parameters:

uniqueIds - device unique identifiers.

Returns:

the request executor.

move

public MoveDeviceRequestExecutor move(java.util.List<java.lang.String> uniqueIds)

Provides executor that can be used to move devices to another manager or company.

Parameters:

uniqueIds - device unique identifiers.

Returns:

the request executor.

share

public ShareDeviceRequestExecutor share(java.lang.String... uniqueIds)

Provides executor that can be used to share devices with other managers.

Parameters:

uniqueIds - device unique identifiers.

Returns:

the request executor.

share

public ShareDeviceRequestExecutor share(java.util.List<java.lang.String> uniqueIds)

Provides executor that can be used to share devices with other managers.

Parameters:

uniqueIds - device unique identifiers.

Returns:

the request executor.

unshare

public UnshareDeviceRequestExecutor unshare(java.lang.String... uniqueIds)

Provides executor that can be used to unshare devices from managers.

Parameters:

uniqueIds - device unique identifiers.

Returns:

the request executor.

unshare

public UnshareDeviceRequestExecutor unshare(java.util.List<java.lang.String> uniqueIds)

Provides executor that can be used to unshare devices from managers.

Parameters:

uniqueIds - device unique identifiers.

Returns:

the request executor.

applySecureConfigs

public ApplySecureConfigRequestExecutor applySecureConfigs(Config... configs)

Provides executor that can be used to apply secure configs on devices.

Parameters:

configs - secure configs.

Returns:

the request executor.

applySecureConfigs

public ApplySecureConfigRequestExecutor applySecureConfigs(java.util.List<Config> configs)

Provides executor that can be used to apply secure configs on devices.

Parameters:

configs - secure configs.

Returns:

the request executor.

register

public RegisterDeviceRequestExecutor register(java.lang.String sourceId)

Provides executor that can be used to register the device.

Parameters:

sourceId - device's ID.

Returns:

the request executor.