Skip to content

@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

ParameterTypeDefault valueDescription
vowelanyundefinedVowel client instance
actionsSurveyStateActionsundefinedSurvey state actions
surveyConfigSurveyConfigundefinedSurvey configuration (for step navigation)
callbacksSurveyCallbacks{}Survey lifecycle callbacks
enableTestToolsbooleanfalseWhether to enable test-specific tools (endTest) - ONLY for platform tester, defaults to false
onStepChangeInternal?(stepId) => voidundefinedOptional internal callback for step changes (for idle timeout)
onCompleteSurvey?(data) => Promise<void>undefinedOptional internal callback when survey completes (for result submission)
getSessionStartTime?() => number | nullundefinedOptional function to get the session start time
disconnectSession?() => Promise<void>undefinedOptional function to disconnect the voice session after completion

Returns

void