Rule Configurations

RuleConfigurations

RuleConfigurations Objects

class RuleConfigurations()

This is a base object that contains all you can do about RulesConfigurations.

constructor

function constructor()

Constructor

Arguments:

• Reference InternalOpenGateAPI - to the API object.

create

function create() -> 'Promise'

Create a new Rule

Returns:

• Promise

delete

function delete() -> 'Promise'

Deletes the selected RuleConfiguration

Returns:

• Promise

update

function update() -> 'Promise'

Udpate a Rule

Returns:

• Promise

updateParameters

function updateParameters(newParameters: *) -> 'Promise'

Udpate a Rule

Arguments:

• newParameters *

Returns:

• Promise

withActions

function withActions(actions: object) -> '_RuleCondition'

Allows the modification of the actions

Arguments:

• actions object

Returns:

• _RuleCondition

withActionsDelay

function withActionsDelay(actionsDelay: number) -> 'RulesConfigurations'

Set the actions delay attribute

Arguments:

• actionsDelay number

Returns:

• RulesConfigurations

withActive

function withActive(active: boolean) -> 'RulesConfigurations'

Set the active attribute

Arguments:

• active boolean

Returns:

• RulesConfigurations

withChannel

function withChannel(channel: string) -> 'RulesConfigurations'

Set the channel attribute

Arguments:

• channel string - required field

Returns:

• RulesConfigurations

withCondition

function withCondition(conditionFilter: string) -> '_RuleCondition'

Allows the modification of a condition

Arguments:

• conditionFilter string

Returns:

• _RuleCondition

withDescription

function withDescription(description: string) -> 'RulesConfigurations'

Set the description attribute

Arguments:

• description string

Returns:

• RulesConfigurations

withIdentifier

function withIdentifier(identifier: string) -> 'RulesConfigurations'

Set the identifier attribute

Arguments:

• identifier string - required field

Returns:

• RulesConfigurations

withJavascript

function withJavascript(javascript: string) -> 'RulesConfigurations'

Set the javascript attribute

Arguments:

• javascript string

Returns:

• RulesConfigurations

withMode

function withMode(mode: string) -> 'RulesConfigurations'

Set the mode attribute

Arguments:

• mode string

Returns:

• RulesConfigurations

withName

function withName(name: string) -> 'RulesConfigurations'

Set the name attribute

Arguments:

• name string - required field

Returns:

• RulesConfigurations

withOrganization

function withOrganization(organization: string) -> 'RulesConfigurations'

Set the organization attribute

Arguments:

• organization string - required field

Returns:

• RulesConfigurations

withParameters

function withParameters(parameters: array) -> '_RuleCondition'

Allows the modification of the actions

Arguments:

• parameters array

Returns:

• _RuleCondition

withType

function withType(type: string) -> 'RulesConfigurations'

Set the type attribute

Arguments:

• type string

Returns:

• RulesConfigurations