RuleManagement Class Reference
| Inherits from | DefaultConfiguration : NSObject |
|---|---|
| Declared in | RuleManagement.h |
– getListOfRules
Get a list of all rules for the specified account.
- (CloudResponse *)getListOfRulesReturn 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
RuleManagement.h
– getInformationOnRule:
Get specific rule details for the account
- (CloudResponse *)getInformationOnRule:(NSString *)ruleIdParameters
ruleId |
the identifier for the rule to retrieve info 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
RuleManagement.h
– deleteADraftRule:
Delete a specific draft rule for account.
- (CloudResponse *)deleteADraftRule:(NSString *)ruleIdParameters
ruleId |
the identifier for the rule to delete. |
|---|
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
RuleManagement.h
– updateStatusOfRule:WithStatus:
Update the status of the rule. Cannot be used for changing the status of draft rule. Status value should be one of the following: [“Active”, “Archived”, “On-hold”]
- (CloudResponse *)updateStatusOfRule:(NSString *)ruleId WithStatus:(NSString *)statusParameters
ruleId |
the identifier for the rule to have the status updated. |
|---|---|
status |
value should be one of the following: [“Active”, “Archived”, “On-hold”] |
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
RuleManagement.h
– createRuleAsDraftUsing:
Create a rule with a status - “Draft” for the specified account.
- (CloudResponse *)createRuleAsDraftUsing:(NSString *)ruleNameParameters
ruleName |
the name of the rule to create a draft |
|---|
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
RuleManagement.h
– createRule:
Create a rule.
- (CloudResponse *)createRule:(Rule *)ruleObjParameters
ruleObj |
the information needed to create a new rule 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
RuleManagement.h
– updateARule:OnRule:
Update the rule.
- (CloudResponse *)updateARule:(Rule *)updateRuleObj OnRule:(NSString *)ruleIdParameters
updateRuleObj |
the information that is used to update the rule with. |
|---|---|
ruleId |
the identifier for the rule to be updated. |
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
RuleManagement.h