@sibilance.is/client v0.1.0-alpha.4
@sibilance.is/client / index / registerSurveyActions
Function: registerSurveyActions()
ts
function registerSurveyActions(
vowel,
actions,
surveyConfig,
callbacks,
enableTestTools,
onStepChangeInternal?,
onCompleteSurvey?,
getSessionStartTime?,
disconnectSession?): void;Defined in: CmdPr/sibilance/client/src/lib/survey-actions.ts:27
Register survey actions with Vowel client
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
vowel | any | undefined | Vowel client instance |
actions | SurveyStateActions | undefined | Survey state actions |
surveyConfig | SurveyConfig | undefined | Survey configuration (for step navigation) |
callbacks | SurveyCallbacks | {} | Survey lifecycle callbacks |
enableTestTools | boolean | false | Whether to enable test-specific tools (endTest) - ONLY for platform tester, defaults to false |
onStepChangeInternal? | (stepId) => void | undefined | Optional internal callback for step changes (for idle timeout) |
onCompleteSurvey? | (data) => Promise<void> | undefined | Optional internal callback when survey completes (for result submission) |
getSessionStartTime? | () => number | null | undefined | Optional function to get the session start time |
disconnectSession? | () => Promise<void> | undefined | Optional function to disconnect the voice session after completion |
Returns
void