API Reference | InRule

📄️ API Reference

These documents contain all the API information for the InRule for JavaScript SDK.

Metadata attached to elements in the rule application at authoring time.

Top level InRule JavaScript object.

Runtime representation of a collection. Accessed via Entity.getCollection(collectionName).

Runtime representation of a Collection Member.

Provides access to Inline Tables and Value Lists. This is accessed via the RuleSession.

An instance of an authored Entity whose state is maintained by the RuleSession.

Runtime representation of a Field.

Represents a notification fired by the runtime engine from a Fire Notification action.

A name/value pair representing a query value list pass-through parameter.

Log of actions the engine took during rule execution. Will only be populated if a JavaScript rule application was packaged with logging options.

Functions for creating entities and executing rules. Should always be created via inrule.createRuleSession()

Instance of an authored Independent Rule Set.

Represents a validation fired by the runtime engine from a Mark Field Invalid action.

Represents a specific reason for a field invalidation.

Represents an authored Value List datatype.

A discrete item in a ValueList