View Source

Functions

All parameters are passed into a engine methods as a map of parameter value keyed to parameter name.

`newPico`

Creates a new pico and returns it's representation. i.e. `{id: "some-id"}`

removePico

newChannel

Creates a new channel for a pico (identified to the engine by the pico_id parameter).

Parameter	Datatype	Required
<pico_id>	<string>	YES
<channel_name>	<string>	YES
<channel_type>	<string>	YES

removeChannel

registerRuleset

unregisterRuleset(rid)

Unregisters the ruleset given by the rid. It will throw an error if the ruleset is installed on any picos, or depended on by another ruleset.

installRuleset( )

Installs rulesets into a pico.

Parameter	Datatype	Required
<pico_id>	<string>	YES
<rid>	string \| array	YES

response = engine:installRuleset( { "pico_id": ent:id, "rid": "wrangler" } );
response = engine:installRuleset( { "pico_id": ent:id, "rid": ["wrangler","Pds"] } );
response = engine:installRuleset( { "pico_id": ent:id, "base": <base>, "url": <url> } );