AlertManagement Class Reference
| Inherits from | DefaultConfiguration : NSObject |
|---|---|
| Declared in | AlertManagement.h |
– getListOfAlerts
Get a list of all alerts for the specified account.
- (CloudResponse *)getListOfAlertsReturn 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
AlertManagement.h
– getInfoOnAlert:
Get specific alert details connected with the account.
- (CloudResponse *)getInfoOnAlert:(NSString *)alertIdParameters
alertId |
the identifier for the alert to retrieve details. |
|---|
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
AlertManagement.h
– resetAlert:
Change the alert status to “Closed”. Alert won’t be active any more.
- (CloudResponse *)resetAlert:(NSString *)alertIdParameters
alertId |
the identifier for the alert to reset. |
|---|
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
AlertManagement.h
– updateAlertStatus:WithStatus:
Change the status of the alert.
- (CloudResponse *)updateAlertStatus:(NSString *)alertId WithStatus:(NSString *)statusParameters
alertId |
the identifier for the alert to change the status on. |
|---|---|
status |
the status to change to. The value should be one of the following values: [‘New’, ‘Open’, ‘Closed’]. |
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
AlertManagement.h
– addCommentsToTheAlert:OnUser:AtTime:WithComment:
Add a comment to the alert.
- (CloudResponse *)addCommentsToTheAlert:(NSString *)alertId OnUser:(NSString *)user AtTime:(long)timeStamp WithComment:(NSString *)commentParameters
alertId |
the identifier for the alert that the comment will be attached to. |
|---|---|
user |
the user that made the comment. |
timeStamp |
the timestamp when the comment was made. |
comment |
the comment text. |
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. @throws JSONException
Declared In
AlertManagement.h