Skip to main content

Interface: BaseChecklistControlEvents

Defined in: src/sdk/checklist/ChecklistControlEvents.ts:4

Events used to control checklists keyed by base topic names.

Properties​

checklist_complete_item​

checklist_complete_item: readonly [number, number, number, number]

Defined in: src/sdk/checklist/ChecklistControlEvents.ts:35

Completes an actionable checklist item. The event data is an ordered tuple of: the index of the checklist group containing the item to complete, the index of the checklist containing the item to complete within its group, and the index of the item to complete within its checklist.

checklist_complete_list​

checklist_complete_list: readonly [number, number]

Defined in: src/sdk/checklist/ChecklistControlEvents.ts:28

Completes every actionable item in a checklist. The event data is an ordered tuple of: the index of the checklist group containing the checklist to complete, and the index of the checklist to complete within its group.

checklist_reset_all​

checklist_reset_all: void

Defined in: src/sdk/checklist/ChecklistControlEvents.ts:6

Resets all checklists.

checklist_reset_group​

checklist_reset_group: number

Defined in: src/sdk/checklist/ChecklistControlEvents.ts:9

Resets a checklist group. The event data is the index of the group to reset.

checklist_reset_item​

checklist_reset_item: readonly [number, number, number, number]

Defined in: src/sdk/checklist/ChecklistControlEvents.ts:22

Resets an actionable checklist item. The event data is an ordered tuple of: the index of the checklist group containing the item to reset, the index of the checklist containing the item to reset within its group, and the index of the item to reset within its checklist.

checklist_reset_list​

checklist_reset_list: readonly [number, number]

Defined in: src/sdk/checklist/ChecklistControlEvents.ts:15

Resets a checklist. The event data is an ordered tuple of: the index of the checklist group containing the checklist to reset, and the index of the checklist to reset within its group.

checklist_state_request​

checklist_state_request: string

Defined in: src/sdk/checklist/ChecklistControlEvents.ts:49

Requests the full state of all checklists. The event data is an UUID that can be used to match responses to the request. The response will be published to the checklist_state_response topic (with the same index as the one used to send the request).

checklist_toggle_item​

checklist_toggle_item: readonly [number, number, number, number]

Defined in: src/sdk/checklist/ChecklistControlEvents.ts:42

Toggles an actionable checklist item. The event data is an ordered tuple of: the index of the checklist group containing the item to toggle, the index of the checklist containing the item to toggle within its group, and the index of the item to toggle within its checklist.