Functions
All parameters (if any) are passed into a any given engine methods method as a map of parameter value keyed to parameter name. The parameters given in the tables are the keys in the map that will represent the given values.
newPico
Creates a new pico and returns it's representation. i.e. `{id: "some-id"}`
removePico
id. No parameters are given.
| Parameter | Datatype | Required |
|---|
| ------------------ | --------------------- | ----------------- |
| Code Block |
|---|
|
response = engine:newPico().klog("Response Structure: ")
/*
Response Structure:
{
"id" : <new_pico_id>
}
*/ |
removePico
| Info |
|---|
|
removePico does not accept a map, but a single id value as its parameter. |
| Parameter | Datatype | Required |
|---|
| <id> | <string> | YES |
| Code Block |
|---|
|
response = engine:removePico(id).klog("engine:removePico Response Structure: ")//id is just a string variable
/*
Response Structure:
undefined
//engine:removePico(id) does not return anything
*/ |
newChannel
Creates a new channel for a pico (identified to the engine by the pico_id parameter).
| Parameter | Datatype | Required |
|---|
| <pico_id> | <string> | YES |
| <name> | <string> | YES |
<channel_name>
| Code Block |
|---|
|
response = engine:newChannel({ "name": "channel_name", "type": "channel_type", "pico_id": id }).klog("Response Structure: ")
/*
Response Structure:
{
"id" : id,
"name": "channel_name",
"type": "channel_type"
}
*/ |
removeChannel
Removes a channel whose eci matches the provided eci. This comparison and deletion takes place on the pico with the provided id.
| Parameter | Datatype | Required |
|---|
| <pico_id> | <string> | YES |
<channel_type>
| Code Block |
|---|
|
response = engine:removeChannel({"pico_id": id, "eci": eci_of_channel}).klog("Response Structure: ")
/*
Response Structure:
undefined
//engine:removeChannel({"pico_id": id, "eci": eci_of_channel}) does not return anything
*/ |
registerRuleset
unregisterRuleset(rid)
...
| Parameter | Datatype | Required |
|---|
| <pico_id> | <string> | YES |
| <rid> | string | array | YES |
| Code Block |
|---|
|
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> } ); |
...