CustomAction (IBM Watson IoT SDK 0.2.1 API)

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Known Implementing Classes:

ConcreteCustomAction
```
public interface CustomAction
```
This class encapsulates the custom actions.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class CustomAction.Status
Status of the CustomAction when there is a failure,

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getActionId()`
`String`	`getBundleId()`
`String`	`getDeviceId()`
`com.google.gson.JsonObject`	`getPayload()`
`String`	`getReqId()`
`String`	`getTypeId()`
`void`	`setStatus(CustomAction.Status status)` Set the failure status of the current custom action The Custom Action handler must use this method to report the failure status back to IBM Watson IoT Platform whenever there is a failure.
`void`	`setStatus(CustomAction.Status status, String message)` Set the failure status of the current custom action The Custom Action handler must use this method to report the failure status back to IBM Watson IoT Platform whenever there is a failure.

- Method Detail
  - setStatus
```
void setStatus(CustomAction.Status status)
```
    Set the failure status of the current custom action
    The Custom Action handler must use this method to report the failure status back to IBM Watson IoT Platform whenever there is a failure.
    
    Parameters:
    
    status - Failure status of the current custom action
  - setStatus
```
void setStatus(CustomAction.Status status,
               String message)
```
    Set the failure status of the current custom action
    The Custom Action handler must use this method to report the failure status back to IBM Watson IoT Platform whenever there is a failure.
    
    Parameters:
    
    status - Failure status of the current custom action
    
    message - Failure message to be reported
  - getTypeId
```
String getTypeId()
```
  - getDeviceId
```
String getDeviceId()
```
  - getBundleId
```
String getBundleId()
```
  - getPayload
```
com.google.gson.JsonObject getPayload()
```
  - getActionId
```
String getActionId()
```
  - getReqId
```
String getReqId()
```