@appsemble/lang-sdk/schemas/FlowPageActionsDefinition.js

Language SDK for Appsemble

export const FlowPageActionsDefinition = {
    type: 'object',
    description: 'These actions are fired on a flow page.',
    additionalProperties: false,
    properties: {
        onFlowCancel: {
            $ref: '#/components/schemas/ActionDefinition',
            description: 'This action gets triggered when `flow.cancel` gets called.',
        },
        onFlowFinish: {
            $ref: '#/components/schemas/ActionDefinition',
            description: `This action gets triggered when a flow is finished.

A flow is finished when \`flow.finish\` gets called, or when \`flow.next\` gets called on the final
subpage. This action has a special property in which the cumulative input data from each previous subpage gets sent, instead of the individual block that triggered this action.`,
        },
        onLoad: {
            $ref: '#/components/schemas/ActionDefinition',
            description: 'This action is fired when a page loads, highly helpful in loading data for the page',
        },
    },
};
//# sourceMappingURL=FlowPageActionsDefinition.js.map