Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
children = engine:listChildren(pico_id)
/*
  [
    "child 0 pico_id",
    "child 1 pico_id",
    ...
  ]
*/

listPolicies

List all the engine policies.

Code Block
policies = engine:listPolicies()
/*
  [
    {id: "1234", name: "policy 1", event: {allow: [...]} query: ...},
    {id: "4321", name: "policy 2", event: {allow: [...]} query: ...},
    {id: "5555", name: "policy 3", event: {allow: [...]} query: ...},
  ]
*/


listChannels

List the pico's channels.

...

Code Block
engine:removePico(id)


newPolicy

Creates a new policy.

ParameterDatatypeRequired
<policy><map>YES


Code Block
engine:newPolicy({
    name: "only allow foo/bar events",
    event: {
        allow: [
            {domain: "foo", type: "bar"}
        ]
    }
}) setting(resp)
/*
	{
        id: "1234",
    	name: "only allow foo/bar events",
        event: {
            allow: [{domain: "foo", type: "bar"}],
            deny: [],
        },
        query: {allow: [], deny: []}
	}
*/

For more description on how these policies work see: https://github.com/Picolab/pico-engine/pull/350#issue-160657235

removePolicy

Removes a policy. It will error if any channels are still using it.

ParameterDatatypeRequired
<policy_id><string>YES


Code Block
engine:removePolicy("1234")






newChannel

Creates a new channel for a pico.

...