This is a base object that contains everything you can do with RulesConfigurations.

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
ogapi InternalOpenGateAPI ❌ Reference to the API object.

create()

Create a new Rule

Retorna

Tip

Tipo: Promise

delete()

Deletes the selected RuleConfiguration

Retorna

Tip

Tipo: Promise

update()

Update a Rule

Retorna

Tip

Tipo: Promise

updateParameters(newParameters)

Update a Rule's parameters

Retorna

Tip

Tipo: Promise

withActions(actions)

Allows the modification of the actions

Parámetros

Nombre Tipo Opcional Descripción
actions object ❌

Retorna

Tip

Tipo: _RuleCondition

withActionsDelay(actionsDelay)

Set the actions delay attribute

Parámetros

Nombre Tipo Opcional Descripción
actionsDelay number ❌

Retorna

Tip

Tipo: RulesConfigurations

withActive(active)

Set the active attribute

Parámetros

Nombre Tipo Opcional Descripción
active boolean ❌

Retorna

Tip

Tipo: RulesConfigurations

withChannel(channel)

Set the channel attribute

Parámetros

Nombre Tipo Opcional Descripción
channel string ❌ required field

Retorna

Tip

Tipo: RulesConfigurations

withCondition(conditionFilter)

Allows the modification of a condition

Parámetros

Nombre Tipo Opcional Descripción
conditionFilter string ❌

Retorna

Tip

Tipo: _RuleCondition

withDescription(description)

Set the description attribute

Parámetros

Nombre Tipo Opcional Descripción
description string ❌

Retorna

Tip

Tipo: RulesConfigurations

withIdentifier(identifier)

Set the identifier attribute

Parámetros

Nombre Tipo Opcional Descripción
identifier string ❌ required field

Retorna

Tip

Tipo: RulesConfigurations

withJavascript(javascript)

Set the javascript attribute

Parámetros

Nombre Tipo Opcional Descripción
javascript string ❌

Retorna

Tip

Tipo: RulesConfigurations

withMode(mode)

Set the mode attribute

Parámetros

Nombre Tipo Opcional Descripción
mode string ❌

Retorna

Tip

Tipo: RulesConfigurations

withName(name)

Set the name attribute

Parámetros

Nombre Tipo Opcional Descripción
name string ❌ required field

Retorna

Tip

Tipo: RulesConfigurations

withOrganization(organization)

Set the organization attribute

Parámetros

Nombre Tipo Opcional Descripción
organization string ❌ required field

Retorna

Tip

Tipo: RulesConfigurations

withParameters(parameters)

Allows the modification of the actions

Parámetros

Nombre Tipo Opcional Descripción
parameters array ❌

Retorna

Tip

Tipo: _RuleCondition

withType(type)

Set the type attribute

Parámetros

Nombre Tipo Opcional Descripción
type string ❌

Retorna

Tip

Tipo: RulesConfigurations