ForeSee (ForeSee SDK v5.2.0)

java.lang.Object
- ForeSeeBase
- - com.foresee.sdk.ForeSee

```
public class ForeSee
extends ForeSeeBase
```
This class contains the main API methods to be used by implementers when instrumenting their application.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ForeSee.ForeSeeSDKConfigurationListener
Listener to notify on completion or failure of the configuration process

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ForeSee.ForeSeeSDKConfigurationListener` Listener to notify on completion or failure of the configuration process

Constructor Summary

Constructors
Constructor and Description

ForeSee()

Constructors
Constructor and Description
`ForeSee()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static void`	`activityPaused(android.app.Activity activity)` Deprecated. This method was deprecated in version 3.4.3
`static void`	`activityResumed(android.app.Activity activity)` Deprecated. This method was deprecated in version 3.4.3
`static void`	`activityStarted(android.app.Activity activity)` Deprecated. This method was deprecated in version 3.4.3
`static void`	`addCPPValue(java.lang.String key, java.lang.String value)` Adds a CPP key/value pair.
`static void`	`appendCPPValue(java.lang.String key, java.lang.String value)` Appends a value to a comma separated list stored against a custom CPP key.
`static void`	`checkIfEligibleForSurvey()` Check to see if the user is eligible for a survey.
`static void`	`customInviteAccepted()` Tells the SDK that a custom invite was accepted.
`static void`	`customInviteDeclined()` Tells the SDK that a custom invite was declined.
`static java.util.Map<ContactType,java.lang.String>`	`getAllContactDetails()` Check all contact details
`static java.util.Map<java.lang.String,java.lang.String>`	`getAllCPPs()` Gets all CPP key/value pairs
`static java.lang.String`	`getContactDetails()` Deprecated. Check the preferred contact details stored in the SDK
`static java.lang.String`	`getContactDetails(ContactType contactType)` Check the contact details for the given contact type stored in the SDK
`static java.lang.String`	`getCPPValue(java.lang.String key)` Gets the CPP value associated to a given key
`static ContactType`	`getPreferredContactType()` Get the preferred contact type
`static java.lang.String`	`getVersion()` Gets the version of the SDK
`static void`	`incrementPageViews()` Manually increment the number of pages counted by the ForeSee SDK.
`static void`	`incrementSignificantEventCountWithKey(java.lang.String key)` Increment the significant event count for a given key.
`static boolean`	`isDebugLogEnabled()` Check whether debug logging is enabled
`static void`	`registerFragmentView(android.view.View fragmentView)` Deprecated. This method was deprecated in version 4.1
`static void`	`removeCPPValue(java.lang.String key)` Removes a CPP value.
`static void`	`resetState()` Reset the state of the SDK.
`static void`	`setContactDetails(ContactType contactType, java.lang.String contactDetails)` Add contact details for a particular type for use in the CONTACT notification method
`static void`	`setContactDetails(java.lang.String contactDetails)` Deprecated. Add contact details for use in the CONTACT notification method
`static void`	`setCPPValueFromArray(java.lang.String key, java.lang.String[] values)` Adds a CPP key/value pair.
`static void`	`setDebugLogEnabled(boolean debugLoggingEnabled)` Allows implementers to configure the SDK to produce more verbose logging output.
`static void`	`setInviteListener(BaseInviteListener inviteListener)` Set the invite listener
`static void`	`setPreferredContactType(ContactType contactType)` Set a preferred contact type
`static void`	`setSkipPoolingCheck(boolean skipPoolingCheck)` Allows implementers to configure the SDK to skip the pooling check.
`boolean`	`shouldSkipPoolingCheck()` Check if the pooling check is disabled
`static void`	`showInviteForSurveyID(java.lang.String surveyId)` Programmatically present the invitation for a given survey ID (sid)
`static void`	`showSurveyForSurveyID(java.lang.String surveyId)` Programmatically present the survey for a given survey ID (sid)
`static void`	`start(android.app.Application application)` Start the ForeSee SDK.
`static void`	`start(android.app.Application application, ForeSee.ForeSeeSDKConfigurationListener listener)` Start the ForeSee SDK.
`static void`	`startWithConfiguration(android.app.Application application, java.lang.String filename)` Starts the SDK using a custom configuration file name.
`static void`	`startWithConfiguration(android.app.Application application, java.lang.String filename, ForeSee.ForeSeeSDKConfigurationListener listener)` Starts the SDK using a custom configuration file name.
`static void`	`startWithConfigurationJSON(android.app.Application application, java.lang.String configJSON)` Starts the SDK using a custom configuration JSON string.
`static void`	`startWithConfigurationJSON(android.app.Application application, java.lang.String configJSON, ForeSee.ForeSeeSDKConfigurationListener listener)` Starts the SDK using a custom configuration JSON string.
`static Configuration`	`updateConfig(android.app.Application application, java.lang.String configJSON)` Updates the SDK with a custom configuration JSON string.
`static Configuration`	`useLocalConfig(android.app.Application application)` Updates the current persistenceSerializer to use a local configuration file.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ForeSee
```
public ForeSee()
```
- Method Detail
  - start
```
public static void start(android.app.Application application)
```
    Start the ForeSee SDK.
    This method will initialize the ForeSee SDK - by convention, the SDK will look for a 'foresee_configuration.json' file in the 'assets' directory if the config wasn't set beforehand.
    
    Parameters:
    
    application - the Application context
  - start
```
public static void start(android.app.Application application,
                         ForeSee.ForeSeeSDKConfigurationListener listener)
```
    Start the ForeSee SDK.
    This method will initialize the ForeSee SDK - by convention, the SDK will look for a 'foresee_configuration.json' file in the 'assets' directory if the config wasn't set beforehand.
    
    Parameters:
    
    application - the Application context
    
    listener - callback which notifies when the SDK started or failed to start
  - startWithConfiguration
```
public static void startWithConfiguration(android.app.Application application,
                                          java.lang.String filename)
```
    Starts the SDK using a custom configuration file name.
    
    Parameters:
    
    application - the Application context
    
    filename - configuration filename
  - startWithConfiguration
```
public static void startWithConfiguration(android.app.Application application,
                                          java.lang.String filename,
                                          ForeSee.ForeSeeSDKConfigurationListener listener)
```
    Starts the SDK using a custom configuration file name.
    
    Parameters:
    
    application - the Application context
    
    filename - configuration filename
    
    listener - callback which notifies when the SDK started or failed to start
  - startWithConfigurationJSON
```
public static void startWithConfigurationJSON(android.app.Application application,
                                              java.lang.String configJSON)
```
    Starts the SDK using a custom configuration JSON string.
    
    Parameters:
    
    application - the Application context
    
    configJSON - JSON string for configuration
  - startWithConfigurationJSON
```
public static void startWithConfigurationJSON(android.app.Application application,
                                              java.lang.String configJSON,
                                              ForeSee.ForeSeeSDKConfigurationListener listener)
```
    Starts the SDK using a custom configuration JSON string.
    
    Parameters:
    
    application - the Application context
    
    configJSON - JSON string for configuration
    
    listener - callback which notifies when the SDK started or failed to start
  - updateConfig
```
public static Configuration updateConfig(android.app.Application application,
                                         java.lang.String configJSON)
```
    Updates the SDK with a custom configuration JSON string.
    
    Parameters:
    
    application - the Application context
    
    configJSON - JSON string for configuration
    
    Returns:
    
    the new Configuration file that will be used
  - useLocalConfig
```
public static Configuration useLocalConfig(android.app.Application application)
```
    Updates the current persistenceSerializer to use a local configuration file. Locale changes will cause the SDK to reload the local, region-specific configuration file.
    
    Parameters:
    
    application - the Application context
    
    Returns:
    
    the new Configuration file that will be used
  - incrementSignificantEventCountWithKey
```
public static void incrementSignificantEventCountWithKey(java.lang.String key)
```
    Increment the significant event count for a given key.
    
    Parameters:
    
    key - the key to increment the significant event count for
  - incrementPageViews
```
public static void incrementPageViews()
```
    Manually increment the number of pages counted by the ForeSee SDK. This can be useful where the user would consider a new page to have been shown, but the activity has not been changed, e.g. when using full screen fragments
  - setContactDetails
```
@Deprecated
public static void setContactDetails(java.lang.String contactDetails)
```
    Deprecated. Add contact details for use in the CONTACT notification method
    
    Parameters:
    
    contactDetails - An email address or mobile number to use. Format should be name@domain.com, 555-123-1234, 5551231234, etc.
  - setContactDetails
```
public static void setContactDetails(ContactType contactType,
                                     java.lang.String contactDetails)
```
    Add contact details for a particular type for use in the CONTACT notification method
    
    Parameters:
    
    contactType - A particular contact type
    
    contactDetails - An email address or mobile number to use. Format should be name@domain.com, 555-123-1234, 5551231234, etc.
  - setPreferredContactType
```
public static void setPreferredContactType(ContactType contactType)
```
    Set a preferred contact type
    
    Parameters:
    
    contactType - A particular contact type
  - addCPPValue
```
public static void addCPPValue(java.lang.String key,
                               java.lang.String value)
```
    Adds a CPP key/value pair. CPPs are transmitted along with surveys upon submission.
    
    Parameters:
    
    key - the key to store the CPP under
    
    value - the data to store in the CPP
  - removeCPPValue
```
public static void removeCPPValue(java.lang.String key)
```
    Removes a CPP value.
    
    Parameters:
    
    key - the key of the CPP to remove
  - setCPPValueFromArray
```
public static void setCPPValueFromArray(java.lang.String key,
                                        java.lang.String[] values)
```
    Adds a CPP key/value pair. The method takes a string key and an array, overwrites the key with the contents of the array, comma separated. CPPs are transmitted along with surveys upon submission.
    
    Parameters:
    
    key - the key to store the CPP under
    
    values - the value array to store in the CPP
  - appendCPPValue
```
public static void appendCPPValue(java.lang.String key,
                                  java.lang.String value)
```
    Appends a value to a comma separated list stored against a custom CPP key. CPPs are transmitted along with surveys upon submission.
    
    Parameters:
    
    key - the key to store the CPP under
    
    value - the value to append to the CPP
  - setInviteListener
```
public static void setInviteListener(BaseInviteListener inviteListener)
```
    Set the invite listener
    
    Parameters:
    
    inviteListener - - Choose the listener based on your notification type Options are: CustomExitSurveyInviteListener | CustomInSessionInviteListener | CustomContactInviteListener OR DefaultInviteListener if you are not customizing the invitation UI
  - customInviteAccepted
```
public static void customInviteAccepted()
```
    Tells the SDK that a custom invite was accepted. You should call this method whenever a user accepts a custom invite that you've presented.
  - customInviteDeclined
```
public static void customInviteDeclined()
```
    Tells the SDK that a custom invite was declined. You should call this method whenever a user declines a custom invite that you've presented.
  - getVersion
```
public static java.lang.String getVersion()
```
    Gets the version of the SDK
    
    Returns:
    
    the version of the SDK
  - getContactDetails
```
@Deprecated
public static java.lang.String getContactDetails()
```
    Deprecated. Check the preferred contact details stored in the SDK
    
    Returns:
    
    The stored preferred contact details
  - getContactDetails
```
public static java.lang.String getContactDetails(ContactType contactType)
```
    Check the contact details for the given contact type stored in the SDK
    
    Parameters:
    
    contactType - A given contact type
    
    Returns:
    
    The stored contact details for the given contact type
  - getAllContactDetails
```
public static java.util.Map<ContactType,java.lang.String> getAllContactDetails()
```
    Check all contact details
    
    Returns:
    
    The stored contact details
  - getPreferredContactType
```
public static ContactType getPreferredContactType()
```
    Get the preferred contact type
    
    Returns:
    
    The stored preferred contact type
  - getCPPValue
```
public static java.lang.String getCPPValue(java.lang.String key)
```
    Gets the CPP value associated to a given key
    
    Parameters:
    
    key - the key of the CPP
    
    Returns:
    
    The data stored in the CPP, or null if SDK is not started or the CPP for the key does not exist
  - getAllCPPs
```
public static java.util.Map<java.lang.String,java.lang.String> getAllCPPs()
```
    Gets all CPP key/value pairs
    
    Returns:
    
    A map that contains all CPP key/value pairs, or null if SDK is not started
  - checkIfEligibleForSurvey
```
public static void checkIfEligibleForSurvey()
```
    Check to see if the user is eligible for a survey. If the user meets CX Measure triggering criteria *and* are in the sampling pool, the invitation will be presented. Implementers must explicitly check for eligibility (the SDK will not do this automatically).
  - showInviteForSurveyID
```
public static void showInviteForSurveyID(java.lang.String surveyId)
```
    Programmatically present the invitation for a given survey ID (sid)
    
    Parameters:
    
    surveyId - the survey id to present the invitation for.
  - showSurveyForSurveyID
```
public static void showSurveyForSurveyID(java.lang.String surveyId)
```
    Programmatically present the survey for a given survey ID (sid)
    
    Parameters:
    
    surveyId - the survey id to present the survey for.
  - resetState
```
public static void resetState()
```
    Reset the state of the SDK.
  - setSkipPoolingCheck
```
public static void setSkipPoolingCheck(boolean skipPoolingCheck)
```
    Allows implementers to configure the SDK to skip the pooling check. This is often useful during development but *NOT* recommended for production use. By default, the pooling check is always enabled.
    
    Parameters:
    
    skipPoolingCheck - if set to true, skips the pooling check, otherwise the pooling check is performed.
  - shouldSkipPoolingCheck
```
public boolean shouldSkipPoolingCheck()
```
    Check if the pooling check is disabled
    
    Returns:
    
    TRUE if the pooling check is disabled
  - setDebugLogEnabled
```
public static void setDebugLogEnabled(boolean debugLoggingEnabled)
```
    Allows implementers to configure the SDK to produce more verbose logging output. If enabled, output from the SDK will be output to LogCat.
    
    Parameters:
    
    debugLoggingEnabled - if set to true, output from the SDK will be output to LogCat
  - isDebugLogEnabled
```
public static boolean isDebugLogEnabled()
```
    Check whether debug logging is enabled
    
    Returns:
    
    TRUE if debug logging is enabled
  - registerFragmentView
```
public static void registerFragmentView(android.view.View fragmentView)
```
    Deprecated. This method was deprecated in version 4.1
    
    Register a fragment view to ensure that its contents are processed correctly
    
    Parameters:
    
    fragmentView - the view of the fragment to be registered
  - activityStarted
```
public static void activityStarted(android.app.Activity activity)
```
    Deprecated. This method was deprecated in version 3.4.3
    
    Lifecycle instrumentation for notifying the SDK that an Activity has started.
    
    Parameters:
    
    activity - the Activity that started
  - activityResumed
```
public static void activityResumed(android.app.Activity activity)
```
    Deprecated. This method was deprecated in version 3.4.3
    
    Lifecycle instrumentation for notifying the SDK that an Activity has been resumed.
    
    Parameters:
    
    activity - the Activity that has resumed.
  - activityPaused
```
public static void activityPaused(android.app.Activity activity)
```
    Deprecated. This method was deprecated in version 3.4.3
    
    Lifecycle instrumentation for notifying the SDK that an Activity has been paused.
    
    Parameters:
    
    activity - the Activity that was paused.

Class ForeSee

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ForeSee

Method Detail

start

start

startWithConfiguration

startWithConfiguration

startWithConfigurationJSON

startWithConfigurationJSON

updateConfig

useLocalConfig

incrementSignificantEventCountWithKey

incrementPageViews

setContactDetails

setContactDetails

setPreferredContactType

addCPPValue

removeCPPValue

setCPPValueFromArray

appendCPPValue

setInviteListener

customInviteAccepted

customInviteDeclined

getVersion

getContactDetails

getContactDetails

getAllContactDetails

getPreferredContactType

getCPPValue

getAllCPPs

checkIfEligibleForSurvey

showInviteForSurveyID

showSurveyForSurveyID

resetState

setSkipPoolingCheck

shouldSkipPoolingCheck

setDebugLogEnabled

isDebugLogEnabled

registerFragmentView

activityStarted

activityResumed

activityPaused