Index (ForeSee SDK v5.2.0)

A B C D E F G H I M O R S T U V

A

activityPaused(Activity) - Static method in class com.foresee.sdk.ForeSee: Deprecated.
This method was deprecated in version 3.4.3
activityResumed(Activity) - Static method in class com.foresee.sdk.ForeSee: Deprecated.
This method was deprecated in version 3.4.3
activityStarted(Activity) - Static method in class com.foresee.sdk.ForeSee: Deprecated.
This method was deprecated in version 3.4.3
addCPPValue(String, String) - Static method in class com.foresee.sdk.ForeSee: Adds a CPP key/value pair.
appendCPPValue(String, String) - Static method in class com.foresee.sdk.ForeSee: Appends a value to a comma separated list stored against a custom CPP key.

B

BaseInviteListener - Interface in com.foresee.sdk.cxMeasure.tracker.listeners: Created by ardavan.kalhori on 16-04-22.

C

checkIfEligibleForSurvey() - Static method in class com.foresee.sdk.ForeSee: Check to see if the user is eligible for a survey.
checkIfFeedbackEnabled() - Static method in class com.foresee.sdk.ForeSeeFeedback: Check if the default feedback is enabled.
checkIfFeedbackEnabledForName(String) - Static method in class com.foresee.sdk.ForeSeeFeedback: Check if a feedback is enabled.
com.foresee.sdk - package com.foresee.sdk
com.foresee.sdk.common.configuration - package com.foresee.sdk.common.configuration
com.foresee.sdk.common.instrumentation - package com.foresee.sdk.common.instrumentation
com.foresee.sdk.cxMeasure.tracker.listeners - package com.foresee.sdk.cxMeasure.tracker.listeners
ContactType - Enum in com.foresee.sdk.common.configuration: Created by alan.wang on 4/24/18.
CustomContactInviteListener - Interface in com.foresee.sdk.cxMeasure.tracker.listeners: Created by ardavan.kalhori on 16-04-22.
CustomExitSurveyInviteListener - Interface in com.foresee.sdk.cxMeasure.tracker.listeners: Created by ardavan.kalhori on 16-04-22.
CustomInSessionInviteListener - Interface in com.foresee.sdk.cxMeasure.tracker.listeners: Created by ardavan.kalhori on 16-04-22.
customInviteAccepted() - Static method in class com.foresee.sdk.ForeSee: Tells the SDK that a custom invite was accepted.
customInviteDeclined() - Static method in class com.foresee.sdk.ForeSee: Tells the SDK that a custom invite was declined.

D

DefaultInviteListener - Interface in com.foresee.sdk.cxMeasure.tracker.listeners: Created by ardavan.kalhori on 16-04-22.

E

EligibleMeasureConfigurations - Class in com.foresee.sdk.common.configuration: Class representing eligible measure configurations
EligibleMeasureConfigurations(List<MeasureConfiguration>, Integer) - Constructor for class com.foresee.sdk.common.configuration.EligibleMeasureConfigurations
equals(Object) - Method in class com.foresee.sdk.common.configuration.EligibleMeasureConfigurations

F

ForeSee - Class in com.foresee.sdk: This class contains the main API methods to be used by implementers when instrumenting their application.
ForeSee() - Constructor for class com.foresee.sdk.ForeSee
ForeSee.ForeSeeSDKConfigurationListener - Interface in com.foresee.sdk: Listener to notify on completion or failure of the configuration process
ForeSeeFeedback - Class in com.foresee.sdk: Created by alan.wang on 7/23/18.
ForeSeeFeedback() - Constructor for class com.foresee.sdk.ForeSeeFeedback
ForeSeeFeedbackListener - Interface in com.foresee.sdk: Created by alan.wang on 7/23/18.

G

getAllContactDetails() - Static method in class com.foresee.sdk.ForeSee: Check all contact details
getAllCPPs() - Static method in class com.foresee.sdk.ForeSee: Gets all CPP key/value pairs
getAvailableFeedbackNames() - Static method in class com.foresee.sdk.ForeSeeFeedback: Get all available feedback names defined in the Configuration.
getChosenEligibleMeasureConfiguration() - Method in class com.foresee.sdk.common.configuration.EligibleMeasureConfigurations
getChosenMeasureIndex() - Method in class com.foresee.sdk.common.configuration.EligibleMeasureConfigurations
getCombinedCriteria() - Method in class com.foresee.sdk.common.configuration.MeasureConfiguration: Get the combined criteria contained within this measure
getContactDetails() - Static method in class com.foresee.sdk.ForeSee: Deprecated.
Check the preferred contact details stored in the SDK
getContactDetails(ContactType) - Static method in class com.foresee.sdk.ForeSee: Check the contact details for the given contact type stored in the SDK
getCPPValue(String) - Static method in class com.foresee.sdk.ForeSee: Gets the CPP value associated to a given key
getDaysSinceFirstLaunchCriteria() - Method in class com.foresee.sdk.common.configuration.MeasureConfiguration: Get the daysSinceFirstLaunch criteria for this measure
getDaysSinceLastLaunchCriteria() - Method in class com.foresee.sdk.common.configuration.MeasureConfiguration: Get the daysSinceFirstLaunch criteria for this measure
getEligibleMeasureConfigurations() - Method in class com.foresee.sdk.common.configuration.EligibleMeasureConfigurations
getIsStarted() - Method in class com.foresee.sdk.ForeSeeFeedback
getLaunchCountCriteria() - Method in class com.foresee.sdk.common.configuration.MeasureConfiguration: Get the launchCount criteria for this measure
getPageViewsCriteria() - Method in class com.foresee.sdk.common.configuration.MeasureConfiguration: Get the pageViews criteria for this measure
getPreferredContactType() - Static method in class com.foresee.sdk.ForeSee: Get the preferred contact type
getSignificantEventThresholds() - Method in class com.foresee.sdk.common.configuration.MeasureConfiguration: Get the significant event thresholds for this measure
getSurveyId() - Method in class com.foresee.sdk.common.configuration.MeasureConfiguration: Get the Survey ID (SID) associated with this measure
getSurveyStyle() - Method in class com.foresee.sdk.common.configuration.MeasureConfiguration: Get the survey style for this measure
getVersion() - Static method in class com.foresee.sdk.ForeSee: Gets the version of the SDK

H

hashCode() - Method in class com.foresee.sdk.common.configuration.EligibleMeasureConfigurations

I

IgnorePageViews - Annotation Type in com.foresee.sdk.common.instrumentation: Ignores unwanted page views
Any activity's onResume event will cause an increment of the page view count in the ForeSee SDK.
incrementPageViews() - Static method in class com.foresee.sdk.ForeSee: Manually increment the number of pages counted by the ForeSee SDK.
incrementSignificantEventCountWithKey(String) - Static method in class com.foresee.sdk.ForeSee: Increment the significant event count for a given key.
isDebugLogEnabled() - Static method in class com.foresee.sdk.ForeSee: Check whether debug logging is enabled

M

MeasureConfiguration - Class in com.foresee.sdk.common.configuration: Created by selwynleeke on 2017-03-21.
MeasureConfiguration(MeasureConfigurationInternal) - Constructor for class com.foresee.sdk.common.configuration.MeasureConfiguration

O

onContactFormatError() - Method in interface com.foresee.sdk.cxMeasure.tracker.listeners.CustomContactInviteListener: Called when the contact info is not in the correct format
onContactMissing() - Method in interface com.foresee.sdk.cxMeasure.tracker.listeners.CustomContactInviteListener: Called when the contact info is missing
onFailedInitializingSDK() - Method in interface com.foresee.sdk.ForeSee.ForeSeeSDKConfigurationListener: SDK initialization has failed due to a configuration error
onFeedbackNotPresentedWithDisabled(String) - Method in interface com.foresee.sdk.ForeSeeFeedbackListener: Called when a feedback is not presented due to the feedback is disabled
onFeedbackNotPresentedWithNetworkError(String) - Method in interface com.foresee.sdk.ForeSeeFeedbackListener: Called when a feedback is not presented due to a network error
onFeedbackNotSubmittedWithAbort(String) - Method in interface com.foresee.sdk.ForeSeeFeedbackListener: Called when a feedback is presented but has failed to submitted due to user has aborted it
onFeedbackNotSubmittedWithNetworkError(String) - Method in interface com.foresee.sdk.ForeSeeFeedbackListener: Called when a feedback is presented but has failed to submitted due to a network error
onFeedbackPresented(String) - Method in interface com.foresee.sdk.ForeSeeFeedbackListener: Called when a feedback is presented
onFeedbackStatusRetrieved(String, boolean) - Method in interface com.foresee.sdk.ForeSeeFeedbackListener: Called when a call to the ForeSeeFeedback.checkIfFeedbackEnabledForName(String) method or to the ForeSeeFeedback.checkIfFeedbackEnabled() method has retrieved the status of a given feedback.
onFeedbackSubmitted(String) - Method in interface com.foresee.sdk.ForeSeeFeedbackListener: Called when a feedback is successfully submitted
onInviteCancelledWithNetworkError() - Method in interface com.foresee.sdk.cxMeasure.tracker.listeners.CustomContactInviteListener: Called when invitation is cancelled due to a network error
onInviteCancelledWithNetworkError(EligibleMeasureConfigurations) - Method in interface com.foresee.sdk.cxMeasure.tracker.listeners.DefaultInviteListener: Called when invite could not be presented due to a network error
onInviteCompleteWithAccept(EligibleMeasureConfigurations) - Method in interface com.foresee.sdk.cxMeasure.tracker.listeners.BaseInviteListener: Called when invitation is completed and user has accepted the invitation
onInviteCompleteWithDecline(EligibleMeasureConfigurations) - Method in interface com.foresee.sdk.cxMeasure.tracker.listeners.BaseInviteListener: Called when invitation is completed and user has declined the invitation
onInviteNotShownWithEligibilityFailed(EligibleMeasureConfigurations) - Method in interface com.foresee.sdk.cxMeasure.tracker.listeners.BaseInviteListener: Called when invite could not be shown due to a eligibility check failure
onInviteNotShownWithNetworkError(EligibleMeasureConfigurations) - Method in interface com.foresee.sdk.cxMeasure.tracker.listeners.BaseInviteListener: Called when invite could not be shown due to a network error
onInviteNotShownWithSamplingFailed(EligibleMeasureConfigurations) - Method in interface com.foresee.sdk.cxMeasure.tracker.listeners.BaseInviteListener: Called when invite could not be shown due to a sampling check failure
onInvitePresented(EligibleMeasureConfigurations) - Method in interface com.foresee.sdk.cxMeasure.tracker.listeners.DefaultInviteListener: Called when invite presented
onSDKReady() - Method in interface com.foresee.sdk.ForeSee.ForeSeeSDKConfigurationListener: The SDK has been initialized successfully
onSurveyCancelledByUser() - Method in interface com.foresee.sdk.cxMeasure.tracker.listeners.CustomInSessionInviteListener: Called when the survey is cancelled by user
onSurveyCancelledByUser(EligibleMeasureConfigurations) - Method in interface com.foresee.sdk.cxMeasure.tracker.listeners.DefaultInviteListener: Called when the survey is cancelled by user
onSurveyCancelledWithNetworkError() - Method in interface com.foresee.sdk.cxMeasure.tracker.listeners.CustomInSessionInviteListener: Called when the survey could not be completed due to a network error
onSurveyCancelledWithNetworkError(EligibleMeasureConfigurations) - Method in interface com.foresee.sdk.cxMeasure.tracker.listeners.DefaultInviteListener: Called when the survey could not be completed due to a network error
onSurveyCompleted() - Method in interface com.foresee.sdk.cxMeasure.tracker.listeners.CustomInSessionInviteListener: Called when the survey is completed by user
onSurveyCompleted(EligibleMeasureConfigurations) - Method in interface com.foresee.sdk.cxMeasure.tracker.listeners.DefaultInviteListener: Called when the survey is completed by user
onSurveyPresented() - Method in interface com.foresee.sdk.cxMeasure.tracker.listeners.CustomInSessionInviteListener: Called when the survey is presented
onSurveyPresented(EligibleMeasureConfigurations) - Method in interface com.foresee.sdk.cxMeasure.tracker.listeners.DefaultInviteListener: Called when the survey is presented

R

registerFragmentView(View) - Static method in class com.foresee.sdk.ForeSee: Deprecated.
This method was deprecated in version 4.1
removeCPPValue(String) - Static method in class com.foresee.sdk.ForeSee: Removes a CPP value.
resetState() - Static method in class com.foresee.sdk.ForeSee: Reset the state of the SDK.

S

setContactDetails(String) - Static method in class com.foresee.sdk.ForeSee: Deprecated.
Add contact details for use in the CONTACT notification method
setContactDetails(ContactType, String) - Static method in class com.foresee.sdk.ForeSee: Add contact details for a particular type for use in the CONTACT notification method
setCPPValueFromArray(String, String[]) - Static method in class com.foresee.sdk.ForeSee: Adds a CPP key/value pair.
setDebugLogEnabled(boolean) - Static method in class com.foresee.sdk.ForeSee: Allows implementers to configure the SDK to produce more verbose logging output.
setFeedbackListener(ForeSeeFeedbackListener) - Static method in class com.foresee.sdk.ForeSeeFeedback: Set a feedback listener, which is an instance of ForeSeeFeedbackListener
setInviteListener(BaseInviteListener) - Static method in class com.foresee.sdk.ForeSee: Set the invite listener
setPreferredContactType(ContactType) - Static method in class com.foresee.sdk.ForeSee: Set a preferred contact type
setSkipPoolingCheck(boolean) - Static method in class com.foresee.sdk.ForeSee: Allows implementers to configure the SDK to skip the pooling check.
shouldSkipPoolingCheck() - Method in class com.foresee.sdk.ForeSee: Check if the pooling check is disabled
showFeedback() - Static method in class com.foresee.sdk.ForeSeeFeedback: Show the default feedback.
showFeedbackForName(String) - Static method in class com.foresee.sdk.ForeSeeFeedback: Show the feedback for a given feedback name.
showInvite(EligibleMeasureConfigurations) - Method in interface com.foresee.sdk.cxMeasure.tracker.listeners.CustomContactInviteListener: Called when invite is ready to be shown
showInvite(EligibleMeasureConfigurations) - Method in interface com.foresee.sdk.cxMeasure.tracker.listeners.CustomExitSurveyInviteListener: Called when invite is ready to be shown
showInvite(EligibleMeasureConfigurations) - Method in interface com.foresee.sdk.cxMeasure.tracker.listeners.CustomInSessionInviteListener: Called when invite is ready to be shown
showInviteForSurveyID(String) - Static method in class com.foresee.sdk.ForeSee: Programmatically present the invitation for a given survey ID (sid)
showSurveyForSurveyID(String) - Static method in class com.foresee.sdk.ForeSee: Programmatically present the survey for a given survey ID (sid)
start(Application) - Static method in class com.foresee.sdk.ForeSee: Start the ForeSee SDK.
start(Application, ForeSee.ForeSeeSDKConfigurationListener) - Static method in class com.foresee.sdk.ForeSee: Start the ForeSee SDK.
startWithConfiguration(Application, String) - Static method in class com.foresee.sdk.ForeSee: Starts the SDK using a custom configuration file name.
startWithConfiguration(Application, String, ForeSee.ForeSeeSDKConfigurationListener) - Static method in class com.foresee.sdk.ForeSee: Starts the SDK using a custom configuration file name.
startWithConfigurationJSON(Application, String) - Static method in class com.foresee.sdk.ForeSee: Starts the SDK using a custom configuration JSON string.
startWithConfigurationJSON(Application, String, ForeSee.ForeSeeSDKConfigurationListener) - Static method in class com.foresee.sdk.ForeSee: Starts the SDK using a custom configuration JSON string.

T

toString() - Method in class com.foresee.sdk.common.configuration.EligibleMeasureConfigurations
toString() - Method in class com.foresee.sdk.common.configuration.MeasureConfiguration

U

updateConfig(Application, String) - Static method in class com.foresee.sdk.ForeSee: Updates the SDK with a custom configuration JSON string.
useLocalConfig(Application) - Static method in class com.foresee.sdk.ForeSee: Updates the current persistenceSerializer to use a local configuration file.

V

valueOf(String) - Static method in enum com.foresee.sdk.common.configuration.ContactType: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.foresee.sdk.common.configuration.ContactType: Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G H I M O R S T U V