import RuleConfigurations from 'opengate-js/src/rulesConfiguration/RuleConfigurations.js'

public class | source

RuleConfigurations

Extends:

BaseProvision → RuleConfigurations

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

Constructor Summary

Public Constructor
public	constructor(Reference: InternalOpenGateAPI) Constructor

Method Summary

Public Methods
public	create(): Promise Create a new Rule
public	delete(): Promise Deletes the selected RuleConfiguration
public	update(): Promise Udpate a Rule
public	updateParameters(newParameters: *): Promise Udpate a Rule
public	withActions(actions: object): _RuleCondition Allows the modification of the actions
public	withActionsDelay(actionsDelay: number): RulesConfigurations Set the actions delay attribute
public	withActive(active: boolean): RulesConfigurations Set the active attribute
public	withChannel(channel: string): RulesConfigurations Set the channel attribute
public	withCondition(conditionFilter: string): _RuleCondition Allows the modification of a condition
public	withDescription(description: string): RulesConfigurations Set the description attribute
public	withIdentifier(identifier: string): RulesConfigurations Set the identifier attribute
public	withJavascript(javascript: string): RulesConfigurations Set the javascript attribute
public	withMode(mode: string): RulesConfigurations Set the mode attribute
public	withName(name: string): RulesConfigurations Set the name attribute
public	withOrganization(organization: string): RulesConfigurations Set the organization attribute
public	withParameters(parameters: array): _RuleCondition Allows the modification of the actions
public	withType(type: string): RulesConfigurations Set the type attribute

Inherited Summary

From class BaseProvision
public	create(): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function create a entity of provision
public	delete(body: *): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function deletes a entity of provision
public	update(): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function updates a entity of provision

Public Constructors

public constructor(Reference: InternalOpenGateAPI) source

Constructor

Override:

BaseProvision#constructor

Params:

Name	Type	Attribute	Description
Reference	InternalOpenGateAPI		to the API object.

Public Methods

public create(): Promise source

Create a new Rule

public delete(): Promise source

Deletes the selected RuleConfiguration

Override:

BaseProvision#delete

Return:

Promise

Throw:

Error

public update(): Promise source

Udpate a Rule

Override:

BaseProvision#update

Return:

Promise

Throw:

Error

public updateParameters(newParameters: *): Promise source

Udpate a Rule

Params:

Name	Type	Attribute	Description
newParameters	*

Return:

Promise

Throw:

Error

public withActions(actions: object): _RuleCondition source

Allows the modification of the actions

Params:

Name	Type	Attribute	Description
actions	object

Return:

_RuleCondition

public withActionsDelay(actionsDelay: number): RulesConfigurations source

Set the actions delay attribute

Params:

Name	Type	Attribute	Description
actionsDelay	number

Return:

RulesConfigurations

public withActive(active: boolean): RulesConfigurations source

Set the active attribute

Params:

Name	Type	Attribute	Description
active	boolean

Return:

RulesConfigurations

public withChannel(channel: string): RulesConfigurations source

Set the channel attribute

Params:

Name	Type	Attribute	Description
channel	string		required field

Return:

RulesConfigurations

public withCondition(conditionFilter: string): _RuleCondition source

Allows the modification of a condition

Params:

Name	Type	Attribute	Description
conditionFilter	string

Return:

_RuleCondition

public withDescription(description: string): RulesConfigurations source

Set the description attribute

Params:

Name	Type	Attribute	Description
description	string

Return:

RulesConfigurations

public withIdentifier(identifier: string): RulesConfigurations source

Set the identifier attribute

Params:

Name	Type	Attribute	Description
identifier	string		required field

Return:

RulesConfigurations

public withJavascript(javascript: string): RulesConfigurations source

Set the javascript attribute

Params:

Name	Type	Attribute	Description
javascript	string

Return:

RulesConfigurations

public withMode(mode: string): RulesConfigurations source

Set the mode attribute

Params:

Name	Type	Attribute	Description
mode	string

Return:

RulesConfigurations

public withName(name: string): RulesConfigurations source

Set the name attribute

Params:

Name	Type	Attribute	Description
name	string		required field

Return:

RulesConfigurations

public withOrganization(organization: string): RulesConfigurations source

Set the organization attribute

Params:

Name	Type	Attribute	Description
organization	string		required field

Return:

RulesConfigurations

public withParameters(parameters: array): _RuleCondition source

Allows the modification of the actions

Params:

Name	Type	Attribute	Description
parameters	array

Return:

_RuleCondition

public withType(type: string): RulesConfigurations source

Set the type attribute

Params:

Name	Type	Attribute	Description
type	string

Return:

RulesConfigurations