DeviceManagament Class Reference
| Inherits from | DefaultConfiguration : NSObject |
|---|---|
| Declared in | DeviceManagament.h |
– getDeviceList
Get a list of all devices for the specified account, with minimal data for each device.
- (CloudResponse *)getDeviceListReturn Value
For async model, return CloudResponse which wraps true if the request of REST call is valid; otherwise false. The actual result from the REST call is return asynchronously as part HttpResponseDelegatee of DefaultConfiguration. For synch model, return CloudResponse which wraps HTTP return code and response.
Declared In
DeviceManagament.h
– createNewDevice:
Create a new device with the device info.
- (CloudResponse *)createNewDevice:(Device *)deviceCreateObjParameters
deviceCreateObj |
the device info to create a new device with. |
|---|
Return Value
For async model, return CloudResponse which wraps true if the request of REST call is valid; otherwise false. The actual result from the REST call is return asynchronously as part HttpResponseDelegatee of DefaultConfiguration. For synch model, return CloudResponse which wraps HTTP return code and response.
Declared In
DeviceManagament.h
– updateADevice:
Update a single device. The device ID (deviceId) cannot be updated as it is the key. If the device id does not exist, an error will be returned. The device id that is used will be the current device that is cached usually after a create new device.
- (CloudResponse *)updateADevice:(Device *)deviceUpdationObjParameters
deviceUpdationObj |
the device info to update the device with. |
|---|
Return Value
For async model, return CloudResponse which wraps true if the request of REST call is valid; otherwise false. The actual result from the REST call is return asynchronously as part HttpResponseDelegatee of DefaultConfiguration. For synch model, return CloudResponse which wraps HTTP return code and response.
Declared In
DeviceManagament.h
– getMyDeviceInfo
Get full detail for newly created device for the specified account. The device id that is used will be the current device that is cached usually after a create new device.
- (CloudResponse *)getMyDeviceInfoReturn Value
For async model, return CloudResponse which wraps true if the request of REST call is valid; otherwise false. The actual result from the REST call is return asynchronously as part HttpResponseDelegatee of DefaultConfiguration. For synch model, return CloudResponse which wraps HTTP return code and response.
Declared In
DeviceManagament.h
– getInfoOnDevice:
Get full detail for specific device for the specified account.
- (CloudResponse *)getInfoOnDevice:(NSString *)deviceIdParameters
deviceId |
the identifier for the device to get details for. |
|---|
Return Value
For async model, return CloudResponse which wraps true if the request of REST call is valid; otherwise false. The actual result from the REST call is return asynchronously as part HttpResponseDelegatee of DefaultConfiguration. For synch model, return CloudResponse which wraps HTTP return code and response.
Declared In
DeviceManagament.h
– getAllTags
Get a list of all tags from devices for the specified account.
- (CloudResponse *)getAllTagsReturn Value
For async model, return CloudResponse which wraps true if the request of REST call is valid; otherwise false. The actual result from the REST call is return asynchronously as part HttpResponseDelegatee of DefaultConfiguration. For synch model, return CloudResponse which wraps HTTP return code and response.
Declared In
DeviceManagament.h
– getAllAttributes
Get a list of all devices’s attribute for the specified account.
- (CloudResponse *)getAllAttributesReturn Value
For async model, return CloudResponse which wraps true if the request of REST call is valid; otherwise false. The actual result from the REST call is return asynchronously as part HttpResponseDelegatee of DefaultConfiguration. For synch model, return CloudResponse which wraps HTTP return code and response.
Declared In
DeviceManagament.h
– activateADevice:
Activates a specific device for the specified account.
- (CloudResponse *)activateADevice:(NSString *)activationCodeParameters
activationCode |
the activation code to be used for activating the device. |
|---|
Return Value
For async model, return CloudResponse which wraps true if the request of REST call is valid; otherwise false. The actual result from the REST call is return asynchronously as part HttpResponseDelegatee of DefaultConfiguration. For synch model, return CloudResponse which wraps HTTP return code and response.
Declared In
DeviceManagament.h
– addComponentToDevice:WithType:
Add component to an specific device. A component represents either a time series or an actuator. The type must already existing in the Component Type catalog.
- (CloudResponse *)addComponentToDevice:(NSString *)componentName WithType:(NSString *)componentTypeParameters
componentName |
the name that identifies the component. |
|---|---|
componentType |
the type of the component |
Return Value
For async model, return CloudResponse which wraps true if the request of REST call is valid; otherwise false. The actual result from the REST call is return asynchronously as part HttpResponseDelegatee of DefaultConfiguration. For synch model, return CloudResponse which wraps HTTP return code and response.
Declared In
DeviceManagament.h
– deleteAComponent:
Delete a specific component for a specific device. All data will be unavailable. The device id that is used will be the current device that is cached usually after a create new device.
- (CloudResponse *)deleteAComponent:(NSString *)componentNameParameters
componentName |
the name that identifies the component. |
|---|
Return Value
For async model, return CloudResponse which wraps true if the request of REST call is valid; otherwise false. The actual result from the REST call is return asynchronously as part HttpResponseDelegatee of DefaultConfiguration. For synch model, return CloudResponse which wraps HTTP return code and response.
Declared In
DeviceManagament.h
– deleteADevice:
Delete a specific device for this account. All data from all time series associated with the device will be deleted.
- (CloudResponse *)deleteADevice:(NSString *)deviceIdParameters
deviceId |
the identifier for the device that will be deleted. |
|---|
Return Value
For async model, return CloudResponse which wraps true if the request of REST call is valid; otherwise false. The actual result from the REST call is return asynchronously as part HttpResponseDelegatee of DefaultConfiguration. For synch model, return CloudResponse which wraps HTTP return code and response.
Declared In
DeviceManagament.h