com.ingenico.sdk.customerscreen.survey

Interface ISurvey

All Superinterfaces:

IIngenicoApi

All Known Implementing Classes:

Survey

public interface ISurvey
extends IIngenicoApi

Survey Service Interface.

Method Summary

Modifier and Type	Method and Description
void	abort() Abort the current survey.
void	registerSurveyDoneListener(ISurveyDoneListener listener) Register a new listener to receive survey results.
SurveyRequest	start(SurveyInputData inputData) Prompt user to answer the survey.
void	unregisterSurveyDoneListener(ISurveyDoneListener listener) Unregister an existing survey listener.

Methods inherited from interface com.ingenico.sdk.IIngenicoApi

connect, disconnect, isConnected

Method Detail

start

SurveyRequest start(SurveyInputData inputData)
             throws IngenicoException

Prompt user to answer the survey.

Example:

ISurvey survey = Survey.getInstance(context);

// First register to surveyDone to show up survey result
survey.registerSurveyDoneListener(surveyListener);

// Prepare Survey input data
SurveyInputData inputData = SurveyInputData.builder()
        .setMessage("")
        .setSurveySettings(SurveySettings.builder()
                .setSurveyFormat(SurveyFormat.SURVEY_FORMAT_STAR)
                .setRatingMaxValue(5)
                .build())
        .build();

// Start the Survey
SurveyRequest request = survey.start(inputData);

// Check if request has been accepted
if (request.isSurveyAccepted()) {
    // Ok, the Survey is being processed
}

Throws:

IngenicoException - when a failure occurs while starting a survey

abort

void abort()
    throws IngenicoException

Abort the current survey.

Example:

survey.abort();

Throws:

IngenicoException - when a failure occurs while aborting a survey

registerSurveyDoneListener

void registerSurveyDoneListener(ISurveyDoneListener listener)

Register a new listener to receive survey results.

Parameters:

listener -

unregisterSurveyDoneListener

void unregisterSurveyDoneListener(ISurveyDoneListener listener)

Unregister an existing survey listener.

Parameters:

listener -