com.ingenico.sdk.customerscreen.survey

Class Survey

java.lang.Object

com.ingenico.sdk.ServiceConnector

com.ingenico.sdk.customerscreen.survey.Survey

All Implemented Interfaces:

ISurvey, IIngenicoApi

public final class Survey
extends ServiceConnector
implements ISurvey

Nested Class Summary

Nested classes/interfaces inherited from class com.ingenico.sdk.ServiceConnector

ServiceConnector.InternalServiceConnection

Field Summary

Fields inherited from class com.ingenico.sdk.ServiceConnector

ACTION_BIND_V2, SERVICES_PACKAGE

Method Summary

Modifier and Type	Method and Description
void	abort() Abort the current survey.
static Survey	getInstance(android.content.Context context) Return a global instance of Survey, which is the default implementation of ISurvey, and instantiate it if needed.
protected java.lang.String	getServiceName() Must be overrided to provide service class name used for binding.
protected void	onServiceReady(android.os.IBinder service) Internal callback when service is connected.
protected void	onServiceUnbinded() Internal callback when service is disconnected.
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 class com.ingenico.sdk.ServiceConnector

connect, connectSync, disconnect, ensureServiceIsReady, getBindIntent, getContext, isConnected

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ingenico.sdk.IIngenicoApi

connect, disconnect, isConnected

Method Detail

getInstance

public static Survey getInstance(android.content.Context context)

Return a global instance of Survey, which is the default implementation of ISurvey, and instantiate it if needed.

Be aware that only one instance will be created for the whole application, so the associated context should not be a component which could be destroyed at some point, ie. an Activity. Passing the Application to this method is preferred over other context types.

Parameters:

context - A valid context to initialize the instance.

Returns:

start

public 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
}

Specified by:

start in interface ISurvey

Throws:

IngenicoException - when a failure occurs while starting a survey

abort

public void abort()
           throws IngenicoException

Abort the current survey.

Example:

survey.abort();

Specified by:

abort in interface ISurvey

Throws:

IngenicoException - when a failure occurs while aborting a survey

getServiceName

protected java.lang.String getServiceName()

Description copied from class: ServiceConnector

Must be overrided to provide service class name used for binding.

Specified by:

getServiceName in class ServiceConnector

Returns:

registerSurveyDoneListener

public void registerSurveyDoneListener(ISurveyDoneListener listener)

Description copied from interface: ISurvey

Register a new listener to receive survey results.

Specified by:

registerSurveyDoneListener in interface ISurvey

unregisterSurveyDoneListener

public void unregisterSurveyDoneListener(ISurveyDoneListener listener)

Description copied from interface: ISurvey

Unregister an existing survey listener.

Specified by:

unregisterSurveyDoneListener in interface ISurvey

onServiceReady

protected void onServiceReady(android.os.IBinder service)

Description copied from class: ServiceConnector

Internal callback when service is connected. This is where we should retrieve the aidl interface.

Specified by:

onServiceReady in class ServiceConnector

onServiceUnbinded

protected void onServiceUnbinded()

Description copied from class: ServiceConnector

Internal callback when service is disconnected.

Specified by:

onServiceUnbinded in class ServiceConnector