Client

Last updated on

local prompts = OPX.Api.Get('prompts')

From client code inside opx_infinity. Each function answers a Result. None yields.

owner is your module name (1–64 characters of letters, digits, _ : - .). It is a label for grouping and expiry, not a security boundary. If it is a module of this runtime or a running resource, its groups are dropped when it stops.

Show

Puts a group up, or replaces the owner's group with that id in place. The spec is validated whole or refused.

prompts.Show(owner, id, spec)

Parameters

• owner: string
• id: string — the group id
• spec: table — see Spec format

Returns

• Result — { id, replaced, rows }

prompts.Show('mymodule', 'door', {
  title = 'DOOR',
  rows = { { id = 'open', label = 'Open', keys = { action = 'mymodule.open', fallback = 'E' } } },
})

Update

Patches a held group. Absent fields keep their value.

prompts.Update(owner, id, patch)

Parameters

• owner: string
• id: string
• patch: table
  • title, priority, rows, or values = { [rowId] = value } (false clears a value). rows and values cannot be combined.

Returns

• Result — { id }; error prompts.notFound

prompts.Update('mymodule', 'door', { values = { open = 'LOCKED' } })

Hide

Takes one group down. An unknown id answers removed = false, not an error.

prompts.Hide(owner, id)

Parameters

• owner: string
• id: string

Returns

• Result — { removed }

HideAll

Takes every group of the owner down.

prompts.HideAll(owner)

Parameters

• owner: string

Returns

• Result — { removed }

List

The owner's group ids (sorted), and whether any of them was in the last drawn strip.

prompts.List(owner)

Parameters

• owner: string

Returns

• Result — { prompts, count, visible }

Spec format

Row fields: