Package com.cumulocity.sdk.client.devicecontrol

Interface DeviceCredentialsApi

All Known Implementing Classes:

DeviceCredentialsApiImpl

public interface DeviceCredentialsApi

Api for device bootstrap

Method Summary

Modifier and Type	Method	Description
void	delete(NewDeviceRequestRepresentation representation)	Remove a device registration.
DeviceCredentialsRepresentation	pollCredentials(String deviceId)	Executes single request to credentials endpoint
DeviceCredentialsRepresentation	pollCredentials(String deviceId, int interval, int timeout)	Schedule polling credentials task, invoking it at the specified execution time and subsequently with the given interval Execution will end after timeout
DeviceCredentialsRepresentation	pollCredentials(String deviceId, PollingStrategy strategy)	Device poll credentials
NewDeviceRequestRepresentation	register(String id)	Register a new device.

Method Detail

register

NewDeviceRequestRepresentation register(String id)

Register a new device.

Parameters:

id - external id of the device to register

Returns:

new device request representation

delete

void delete(NewDeviceRequestRepresentation representation)

Remove a device registration.

Parameters:

representation - representation of new device request to delete

pollCredentials

DeviceCredentialsRepresentation pollCredentials(String deviceId,
                                                int interval,
                                                int timeout)

Schedule polling credentials task, invoking it at the specified execution time and subsequently with the given interval Execution will end after timeout

Parameters:

deviceId - device unique identifier

interval - - how often request is sent in seconds

timeout - - after how many seconds polling process will expire

Returns:

device credentials representation

pollCredentials

DeviceCredentialsRepresentation pollCredentials(String deviceId,
                                                PollingStrategy strategy)

Device poll credentials

Parameters:

deviceId - device unique identifier

strategy - credentials polling strategy

Returns:

device credentials representation

pollCredentials

DeviceCredentialsRepresentation pollCredentials(String deviceId)

Executes single request to credentials endpoint

Parameters:

deviceId - device unique identifier

Returns:

device credentials representation