ApiSchemasInterfaces
Interface: StartAutomationsOptions
Defined in: packages/core/src/schemas/automations.ts:750
Extends
Properties
| Property | Modifier | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
account | readonly | string | The account running them: a person's, for their app or agent, or a bot's own | - | packages/core/src/schemas/automations.ts:752 |
ask? | readonly | (trigger) => Promise<Pick<{ at: string; did: string; made?: string; ok: boolean; }, "did" | "ok">> | Does what an automation asks an agent. Without it, automations that ask are left to a runner that can. | RunAutomationsOptions.ask | packages/core/src/schemas/automations.ts:511 |
bot? | readonly | boolean | A bot, running as an account of its own: nothing it writes sets an automation off | RunAutomationsOptions.bot | packages/core/src/schemas/automations.ts:507 |
busy? | readonly | Set<string> | Records being acted on now, shared across calls so a second look leaves them alone | RunAutomationsOptions.busy | packages/core/src/schemas/automations.ts:515 |
claimMs? | readonly | number | How long to wait after claiming a record before acting, to hear whether a device of the same account claimed it too; the earlier claim acts and the later steps back. 0, the default, doesn't wait. | RunAutomationsOptions.claimMs | packages/core/src/schemas/automations.ts:521 |
notify? | readonly | AutomationNotifier | Shows a notification. Without it, a notify automation's run says nothing could. | RunAutomationsOptions.notify | packages/core/src/schemas/automations.ts:509 |
now? | readonly | () => Date | - | - | packages/core/src/schemas/automations.ts:760 |
onError? | readonly | (error) => void | - | - | packages/core/src/schemas/automations.ts:757 |
onRules? | readonly | (rules) => void | Called with the automations it runs, whenever they change | - | packages/core/src/schemas/automations.ts:756 |
onRun? | readonly | (trigger, run) => void | Each time an automation acted | RunAutomationsOptions.onRun | packages/core/src/schemas/automations.ts:523 |
tickMs? | readonly | number | How often the time is checked against every. Default 15 s. | - | packages/core/src/schemas/automations.ts:759 |
timed? | readonly | boolean | Whether automations run at the times they name; an app open now and then leaves that to an always-on runner. Default true. | - | packages/core/src/schemas/automations.ts:754 |
title? | readonly | (record) => string | What a record is called, for {title} | RunAutomationsOptions.title | packages/core/src/schemas/automations.ts:513 |