HomeDocumentationAPI Reference
Getting StartedAPI ReferenceHelp CenterVideo Tours

Show Survey Welcome Message

Any survey usually starts off getting straight to the point. You can have the survey instead start with a simple welcome message. To enable the welcome message, you can use this API.

Surveys.shouldShowWelcomeScreen = true
IBGSurveys.shouldShowWelcomeScreen = YES;
Surveys.setShouldShowWelcomeScreen(true);
Surveys.setShouldShowWelcomeScreen(true);
cordova.plugins.surveys.setShouldShowSurveysWelcomeScreen(
            true,
            function () {
                console.log('Survey welcome screen will be shown.');
            },
            function (error) {
                console.log('Could not set survey welcome screen to be shown - ' + error);
            }
        );
//iOS
IBGSurveys.ShouldShowWelcomeScreen = true;

//Android 
Surveys.SetShouldShowWelcomeScreen(true);
Surveys.setShouldShowWelcomeScreen(true);