Dashboard methods: ask, schedule
The Dashboard Verbs ask, schedule as typed SDK methods, with inputs, result, refusals and an example.
Reference for Dashboard, one group of Dashboard methods.
Dashboard.ask
Ask answers a plain-language question with a query over the Startup’s records and shows the query beside the result. Verb page.
interface DashboardVerbs {
ask(input: DashboardAskInput, options?: SB.CallOptions): SB.Call<DashboardAskOutput>
}Emits Dashboard.asked.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
question | text | required | The question, in plain language. |
dashboard | Dashboard | The Dashboard to add the answer to as a tile. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
query | text | required | The query it ran, to read and reuse. |
rows | json | required | The result, as a table or chart. |
dashboard | Dashboard | required | The Dashboard the question was asked on. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
import { $ } from 'startup-builder'
const { query, rows, dashboard } = await $.Dashboard.ask({ question: 'Example question' })Dashboard.schedule
Schedule sends a Dashboard on a cadence to a Mailbox, a Channel or an Agent’s context, rendered for each. Verb page.
interface DashboardVerbs {
schedule(input: DashboardScheduleInput, options?: SB.CallOptions): SB.Call<Dashboard>
}Emits Dashboard.scheduled.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
dashboard | Dashboard | required | The Dashboard to send. |
cadence | string | required | How often it goes out. |
to | string | required | The Mailbox, Channel or Agent that receives it. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
dashboard | Dashboard | required | The Dashboard, with its schedule. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
import { $ } from 'startup-builder'
const dashboard = await $.Dashboard.schedule({ dashboard: 'dashboard_QL9I0ALqO4', cadence: 'daily', to: 'Example to' })