Skip navigation links
A B C D E F G H I L M N O P R S T U V W 

A

AppState - Enum in com.factual.engine.api.mobile_state
The types of app-states.
AppStateUpdate - Class in com.factual.engine.api.mobile_state
Reports updates to foreground/background state.
AppStateUpdate(long, AppState) - Constructor for class com.factual.engine.api.mobile_state.AppStateUpdate
Constructs an AppStateUpdate object.
AT_PLACES - Static variable in class com.factual.engine.api.CircumstanceResponse
 

B

BaseApiReceiver - Class in com.factual.engine.api
 
BaseApiReceiver() - Constructor for class com.factual.engine.api.BaseApiReceiver
 
build() - Method in class com.factual.engine.api.mobile_state.UserJourneyEvent.Builder
build() - Method in class com.factual.engine.api.mobile_state.UserJourneySpan.Builder
Builds a UserJourneySpan.
Builder(long) - Constructor for class com.factual.engine.api.mobile_state.UserJourneyEvent.Builder
Creates a UserJourneyEvent.Builder object.
Builder() - Constructor for class com.factual.engine.api.mobile_state.UserJourneySpan.Builder
 

C

CANDIDATES - Static variable in class com.factual.engine.api.PlaceCandidateResponse
 
CATEGORY_IDS - Static variable in class com.factual.engine.api.FactualPlace
 
CHAIN_ID - Static variable in class com.factual.engine.api.FactualPlace
 
CIRCUMSTANCE - Static variable in class com.factual.engine.api.CircumstanceResponse
 
CIRCUMSTANCE_ID - Static variable in class com.factual.engine.api.FactualCircumstance
 
CircumstanceResponse - Class in com.factual.engine.api
The response object from a FactualCircumstance notification.
CircumstanceResponse(FactualCircumstance, List<FactualPlace>, List<FactualPlace>, Location) - Constructor for class com.factual.engine.api.CircumstanceResponse
Constructs a Circumstance object.
CIRCUMSTANCES_KEY - Static variable in class com.factual.engine.api.FactualGarageRelease
 
com.factual.engine - package com.factual.engine
Classes for interacting with Factual's Engine SDK.
com.factual.engine.api - package com.factual.engine.api
Contains BroadcastReceivers used by and API classes returned by Factual's Engine SDK.
com.factual.engine.api.mobile_state - package com.factual.engine.api.mobile_state
Contains User Journey API classes returned by Factual's Engine SDK.
COUNTRY - Static variable in class com.factual.engine.api.FactualPlace
 
CREATOR - Static variable in class com.factual.engine.api.CircumstanceResponse
 
CREATOR - Static variable in class com.factual.engine.api.FactualCircumstance
 
CREATOR - Static variable in class com.factual.engine.api.FactualConfigMetadata
 
CREATOR - Static variable in class com.factual.engine.api.FactualError
 
CREATOR - Static variable in class com.factual.engine.api.FactualGarageRelease
 
CREATOR - Static variable in class com.factual.engine.api.FactualInfo
 
CREATOR - Static variable in class com.factual.engine.api.FactualPlace
 
CREATOR - Static variable in class com.factual.engine.api.mobile_state.AppStateUpdate
 
CREATOR - Static variable in class com.factual.engine.api.mobile_state.FactualActivity
 
CREATOR - Static variable in class com.factual.engine.api.mobile_state.FactualActivityUpdate
 
CREATOR - Static variable in class com.factual.engine.api.mobile_state.FactualEgressEvent
 
CREATOR - Static variable in class com.factual.engine.api.mobile_state.FactualIngressEvent
 
CREATOR - Static variable in class com.factual.engine.api.mobile_state.FactualPlaceAttachmentUpdate
 
CREATOR - Static variable in class com.factual.engine.api.mobile_state.FactualPlaceVisit
 
CREATOR - Static variable in class com.factual.engine.api.mobile_state.FactualVisitUpdate
 
CREATOR - Static variable in class com.factual.engine.api.mobile_state.Geographies
 
CREATOR - Static variable in class com.factual.engine.api.mobile_state.UserJourneyEvent
 
CREATOR - Static variable in class com.factual.engine.api.mobile_state.UserJourneySpan
 

D

DEFAULT_CIRCUMSTANCE_NAME - Static variable in class com.factual.engine.api.FactualCircumstance
 
describeContents() - Method in class com.factual.engine.api.CircumstanceResponse
 
describeContents() - Method in class com.factual.engine.api.FactualCircumstance
 
describeContents() - Method in class com.factual.engine.api.FactualConfigMetadata
 
describeContents() - Method in class com.factual.engine.api.FactualError
 
describeContents() - Method in class com.factual.engine.api.FactualGarageRelease
 
describeContents() - Method in class com.factual.engine.api.FactualInfo
 
describeContents() - Method in class com.factual.engine.api.FactualPlace
 
describeContents() - Method in class com.factual.engine.api.mobile_state.AppStateUpdate
 
describeContents() - Method in class com.factual.engine.api.mobile_state.FactualActivity
 
describeContents() - Method in class com.factual.engine.api.mobile_state.FactualActivityUpdate
 
describeContents() - Method in class com.factual.engine.api.mobile_state.FactualEgressEvent
 
describeContents() - Method in class com.factual.engine.api.mobile_state.FactualIngressEvent
 
describeContents() - Method in class com.factual.engine.api.mobile_state.FactualPlaceAttachmentUpdate
 
describeContents() - Method in class com.factual.engine.api.mobile_state.FactualPlaceVisit
 
describeContents() - Method in class com.factual.engine.api.mobile_state.FactualVisitUpdate
 
describeContents() - Method in class com.factual.engine.api.mobile_state.Geographies
 
describeContents() - Method in class com.factual.engine.api.mobile_state.UserJourneyEvent
 
describeContents() - Method in class com.factual.engine.api.mobile_state.UserJourneySpan
 
didLoseSignal() - Method in class com.factual.engine.api.mobile_state.UserJourneySpan
Returns true if at some point during the span, location signal was lost for a significant period of time, so the span might not be accurate.
didTravel() - Method in class com.factual.engine.api.mobile_state.UserJourneySpan
Returns true if the user traveled from place to place, false if the user remained in one place.
disableActivityMonitoring() - Static method in class com.factual.engine.FactualEngine
Disables activity monitoring.
disableCircumstance(String) - Static method in class com.factual.engine.FactualEngine
Disables circumstance monitoring for the particular circumstance.
disableRemoteAnalytics() - Static method in class com.factual.engine.FactualEngine
Disables the sending of data to Factual to power remote analytics.
dispatchExtendedIntent(Intent) - Method in class com.factual.engine.FactualClientReceiver
 
DISTANCE - Static variable in class com.factual.engine.api.FactualPlace
 

E

enableActivityMonitoring() - Static method in class com.factual.engine.FactualEngine
Enables activity monitoring.
enableCircumstance(String) - Static method in class com.factual.engine.FactualEngine
Enable circumstance monitoring for the particular circumstance.
enableRemoteAnalytics() - Static method in class com.factual.engine.FactualEngine
Enables the sending of data to Factual to power remote analytics.
EXPRESSION - Static variable in class com.factual.engine.api.FactualCircumstance
 

F

FACTUAL_ID - Static variable in class com.factual.engine.api.FactualPlace
 
FactualActionHandler - Interface in com.factual.engine.api
A listener that receives callbacks related to circumstance notifications.
FactualActivity - Class in com.factual.engine.api.mobile_state
The user's activity.
FactualActivity(long, FactualActivityType) - Constructor for class com.factual.engine.api.mobile_state.FactualActivity
Construct a FactualActivity object.
FactualActivity(JSONObject) - Constructor for class com.factual.engine.api.mobile_state.FactualActivity
 
FactualActivityType - Enum in com.factual.engine.api.mobile_state
The types of activities reported by Factual.
FactualActivityUpdate - Class in com.factual.engine.api.mobile_state
Reports updates of the user's activity.
FactualActivityUpdate(FactualActivity, FactualActivity) - Constructor for class com.factual.engine.api.mobile_state.FactualActivityUpdate
Constructs a FactualActivityUpdate object.
FactualCircumstance - Class in com.factual.engine.api
A user defined circumstance.
FactualCircumstance(String, String, List<String>) - Constructor for class com.factual.engine.api.FactualCircumstance
Constructs a FacutalCircumstance object.
FactualCircumstance(String, String, List<String>, String) - Constructor for class com.factual.engine.api.FactualCircumstance
Constructs a FacutalCircumstance object.
FactualCircumstanceException - Exception in com.factual.engine.api
Thrown if a FactualCircumstance related error occurred.
FactualCircumstanceException(String) - Constructor for exception com.factual.engine.api.FactualCircumstanceException
 
FactualClientListener - Interface in com.factual.engine
A listener that receives callbacks related to the status of the Factual SDK.
FactualClientReceiver - Class in com.factual.engine
A android.content.BroadcastReceiver that receives callbacks related to the status of the Factual SDK.
FactualClientReceiver() - Constructor for class com.factual.engine.FactualClientReceiver
 
FactualConfigMetadata - Class in com.factual.engine.api
An object that contains metadata about the configuration downloaded from Factual's servers.
FactualConfigMetadata(Date, int, int, String) - Constructor for class com.factual.engine.api.FactualConfigMetadata
Constructs a FactualConfigMetadata object.
FactualConfigMetadata(Date, int, int, String, FactualGarageRelease) - Constructor for class com.factual.engine.api.FactualConfigMetadata
Constructs a FactualConfigMetadata object.
FactualEgressEvent - Class in com.factual.engine.api.mobile_state
Reports egress events (when the user finishes a visit).
FactualEgressEvent(Location, long) - Constructor for class com.factual.engine.api.mobile_state.FactualEgressEvent
Constructs a FactualEgressEvent.
FactualEngine - Class in com.factual.engine
The primary class for using Engine.
FactualError - Class in com.factual.engine.api
An object for reporting Factual error messages.
FactualError(String, int) - Constructor for class com.factual.engine.api.FactualError
Constructs a FactualError object.
FactualException - Exception in com.factual.engine.api
An Exception thrown by the Factual SDK.
FactualException(String) - Constructor for exception com.factual.engine.api.FactualException
Construct a FactualException.
FactualGarageRelease - Class in com.factual.engine.api
Information about circumstance configurations from Garage.
FactualGarageRelease(String, List<FactualCircumstance>) - Constructor for class com.factual.engine.api.FactualGarageRelease
Constructs a FactualGarageRelease object.
FactualInfo - Class in com.factual.engine.api
Reporting for info messages.
FactualInfo(String) - Constructor for class com.factual.engine.api.FactualInfo
Constructs a FactualInfo object.
FactualIngressEvent - Class in com.factual.engine.api.mobile_state
Reports ingress events (when the user begins a visit).
FactualIngressEvent(Location) - Constructor for class com.factual.engine.api.mobile_state.FactualIngressEvent
Constructs a FactualIngressEvent.
FactualJobIntentService - Class in com.factual.engine
The JobIntentService that handles the SDK's background processing.
FactualJobIntentService() - Constructor for class com.factual.engine.FactualJobIntentService
 
FactualPlace - Class in com.factual.engine.api
A place in Factual's Global Places dataset: http://www.factual.com/products/global
FactualPlace(String, String, double, double, double, PlaceConfidenceThreshold) - Constructor for class com.factual.engine.api.FactualPlace
Constructs a FactualPlace.
FactualPlace(JSONObject) - Constructor for class com.factual.engine.api.FactualPlace
Constructs a FactualPlace.
FactualPlaceAttachmentUpdate - Class in com.factual.engine.api.mobile_state
Reports place-attachment updates.
FactualPlaceAttachmentUpdate(FactualPlaceVisit, FactualPlaceVisit) - Constructor for class com.factual.engine.api.mobile_state.FactualPlaceAttachmentUpdate
FactualPlacesListener - Interface in com.factual.engine.api
A listener for on-demand Factual place candidates requests.
FactualPlaceVisit - Class in com.factual.engine.api.mobile_state
Reports place information about a user, including when they arrived at the place and whether the user is at home and/or work.
FactualPlaceVisit(Location, List<FactualPlace>, Geographies, boolean, boolean) - Constructor for class com.factual.engine.api.mobile_state.FactualPlaceVisit
Constructs a FactualPlaceVisit object.
FactualVisitUpdate - Class in com.factual.engine.api.mobile_state
Reports changes to visiting state, more specifically information when an ingress and/or egress occur.
FactualVisitUpdate(FactualIngressEvent, FactualEgressEvent) - Constructor for class com.factual.engine.api.mobile_state.FactualVisitUpdate
Construct a FactualVisitUpdate object.
findByValue(int) - Static method in enum com.factual.engine.api.mobile_state.FactualActivityType
Find a the enum type by its integer value.
forceTelemetrySend() - Static method in class com.factual.engine.FactualEngine
Forces telemetry to be sent to the telemetry server.

G

GARAGE_RELEASE_ID_KEY - Static variable in class com.factual.engine.api.FactualGarageRelease
 
GARAGE_RELEASE_KEY - Static variable in class com.factual.engine.api.FactualConfigMetadata
 
Geographies - Class in com.factual.engine.api.mobile_state
Reports the geographies the user is in.
Geographies(String, String, String, List<String>) - Constructor for class com.factual.engine.api.mobile_state.Geographies
Constructs a Geographies object.
Geographies(JSONObject) - Constructor for class com.factual.engine.api.mobile_state.Geographies
Constructs a Geographies object.
getActivities() - Method in class com.factual.engine.api.mobile_state.UserJourneySpan
Returns a list of FactualActivity, which may be empty, but not null.
getActivityUpdate() - Method in class com.factual.engine.api.mobile_state.UserJourneyEvent
Gets the FactualActivityUpdate, null if activity wasn't updated.
getAppState() - Method in class com.factual.engine.api.mobile_state.AppStateUpdate
Gets the foreground/background state.
getAppStateUpdate() - Method in class com.factual.engine.api.mobile_state.UserJourneyEvent
Gets the AppStateUpdate, null if app-state wasn't updated.
getAtPlaces() - Method in class com.factual.engine.api.CircumstanceResponse
Gets the list of places the user was at that helped trigger the circumstance.
getAttachedPlaces() - Method in class com.factual.engine.api.mobile_state.FactualPlaceVisit
Returns a list of places the user is at.
getCandidates() - Method in class com.factual.engine.api.PlaceCandidateResponse
Gets the candidates for the place attachment request ordered by confidence.
getCategoryIds() - Method in class com.factual.engine.api.FactualPlace
Gets the Factual category-ids for the place.
getChainId() - Method in class com.factual.engine.api.FactualPlace
Gets the Factual chain-id of the place.
getCircumstance() - Method in class com.factual.engine.api.CircumstanceResponse
Gets the FactualCircumstance that was triggered.
getCircumstanceId() - Method in class com.factual.engine.api.FactualCircumstance
Gets the id of the circumstance.
getCircumstances() - Method in class com.factual.engine.api.FactualGarageRelease
Gets the app's FactualCircumstances defined in the Garage.
getCode() - Method in class com.factual.engine.api.FactualError
Gets the FactualError code.
getContext() - Method in class com.factual.engine.api.BaseApiReceiver
Gets the application's context.
getCountry() - Method in class com.factual.engine.api.FactualPlace
Gets the country of the place.
getCountry() - Method in class com.factual.engine.api.mobile_state.Geographies
Returns the country the user is in.
getCurrentActivity() - Method in class com.factual.engine.api.mobile_state.FactualActivityUpdate
Gets the user's current activity.
getCurrentPlace() - Method in class com.factual.engine.api.mobile_state.UserJourneySpan
Returns the current place the user is at.
getCurrentPlaceVisit() - Method in class com.factual.engine.api.mobile_state.FactualPlaceAttachmentUpdate
Gets the place the user is currently.
getDistance() - Method in class com.factual.engine.api.FactualPlace
Gets the approximate distance between the place and the user in meters.
getDwellTimeSeconds() - Method in class com.factual.engine.api.mobile_state.FactualEgressEvent
Gets the length of time spent at the visit location in milliseconds.
getEgressEvent() - Method in class com.factual.engine.api.mobile_state.FactualVisitUpdate
Gets the egress event.
getEndTimestamp() - Method in class com.factual.engine.api.mobile_state.UserJourneySpan
Returns the time the span began in unix milliseconds.
getExpression() - Method in class com.factual.engine.api.FactualCircumstance
Gets the expression of the circumstance.
getFactualDeviceId() - Static method in class com.factual.engine.FactualEngine
Gets Factual's identifier for the device.
getFactualId() - Method in class com.factual.engine.api.FactualPlace
Gets the Factual id of the place.
getGarageRelease() - Method in class com.factual.engine.api.FactualConfigMetadata
Gets information specific to circumstance configurations from Garage.
getGeographies() - Method in class com.factual.engine.api.mobile_state.FactualPlaceVisit
Returns the geographies the user is at.
getId() - Method in class com.factual.engine.api.FactualGarageRelease
Gets the id of the Garage release.
getInfo() - Method in class com.factual.engine.api.FactualInfo
Gets the info message text.
getIngressEvent() - Method in class com.factual.engine.api.mobile_state.FactualVisitUpdate
Gets the ingress event.
getIngressLocation() - Method in class com.factual.engine.api.mobile_state.FactualIngressEvent
Gets the location where the ingress occurred.
getIngressLocation() - Method in class com.factual.engine.api.mobile_state.FactualPlaceVisit
Returns the location when the user started visiting the place.
getLatitude() - Method in class com.factual.engine.api.FactualPlace
Gets the latitude of the place.
getLocalities() - Method in class com.factual.engine.api.mobile_state.Geographies
Returns a list of localities the user is in.
getLocality() - Method in class com.factual.engine.api.FactualPlace
Gets the locality of the place.
getLocation() - Method in class com.factual.engine.api.CircumstanceResponse
Gets the location where the circumstance was met.
getLongitude() - Method in class com.factual.engine.api.FactualPlace
Gets the longitude of the place.
getMainActivityType() - Method in class com.factual.engine.api.mobile_state.UserJourneySpan
Returns a FactualActivityType representing the primary activity.
getMaxBufferSizeKb() - Method in class com.factual.engine.api.FactualConfigMetadata
Returns the maximum size of the on-device data buffer in KB.
getMessage() - Method in class com.factual.engine.api.FactualError
Gets the FactualError message text.
getName() - Method in class com.factual.engine.api.FactualCircumstance
Gets name associated with this circumstance.
getName() - Method in class com.factual.engine.api.FactualPlace
Gets the name of the place.
getNearPlaces() - Method in class com.factual.engine.api.CircumstanceResponse
Gets the list of places the user was near that helped trigger the circumstance.
getParcelData(Intent, Class<? extends Parcelable>) - Method in class com.factual.engine.api.BaseApiReceiver
 
getPlaceAttachmentUpdate() - Method in class com.factual.engine.api.mobile_state.UserJourneyEvent
Gets the FactualPlaceAttachmentUpdate, null if the attached places haven't changed.
getPlaceCandidates(FactualPlacesListener) - Static method in class com.factual.engine.FactualEngine
Starts an asynchronous request to get the list of Factual Place's the user is either at or near.
getPlaceCandidates(FactualPlacesListener, Location) - Static method in class com.factual.engine.FactualEngine
Starts an asynchronous request to get the list of Factual Place's the user is either at or near.
getPostcode() - Method in class com.factual.engine.api.FactualPlace
Gets the postcode of the place.
getPostcode() - Method in class com.factual.engine.api.mobile_state.Geographies
Returns the postcode the user is in.
getPreviousActivity() - Method in class com.factual.engine.api.mobile_state.FactualActivityUpdate
Gets the user's previous activity.
getPreviousPlace() - Method in class com.factual.engine.api.mobile_state.UserJourneySpan
Returns the previous place the user was at.
getPreviousPlaceVisit() - Method in class com.factual.engine.api.mobile_state.FactualPlaceAttachmentUpdate
Gets the place the user was previously.
getRegion() - Method in class com.factual.engine.api.FactualPlace
Gets the region of the place.
getRegion() - Method in class com.factual.engine.api.mobile_state.Geographies
Returns the region the user is in.
getRequestLocation() - Method in class com.factual.engine.api.PlaceCandidateResponse
Gets the location of the place attachment request.
getRequestTime() - Method in class com.factual.engine.api.PlaceCandidateResponse
Gets the time of the place attachment request in milliseconds UTC.
getSdkVersion() - Static method in class com.factual.engine.FactualEngine
Gets the version of Engine.
getSendBufferSizeKb() - Method in class com.factual.engine.api.FactualConfigMetadata
Gets the amount of data in KB stored in the SDK's on-device buffer before sending that data to the server.
getSpanId() - Method in class com.factual.engine.api.mobile_state.UserJourneySpan
Returns a uuid for a span.
getStartTimestamp() - Method in class com.factual.engine.api.mobile_state.UserJourneySpan
Returns the time the span began in unix milliseconds.
getStringData(Intent) - Method in class com.factual.engine.api.BaseApiReceiver
 
getTags() - Method in class com.factual.engine.api.FactualCircumstance
Gets the tags associated with the circumstance.
getThresholdMet() - Method in class com.factual.engine.api.FactualPlace
Gets whether the user is at the place with high or low confidence or just near it.
getTimestamp() - Method in class com.factual.engine.api.FactualConfigMetadata
Gets the time at which the config was downloaded.
getTimestamp() - Method in class com.factual.engine.api.mobile_state.AppStateUpdate
Gets the time of the app-state update in unix milliseconds.
getTimestamp() - Method in class com.factual.engine.api.mobile_state.FactualActivity
Gets the time of the activity update in unix milliseconds.
getTimestamp() - Method in class com.factual.engine.api.mobile_state.UserJourneyEvent
Gets the timestamp of the UserJourneyEvent.
getType() - Method in class com.factual.engine.api.mobile_state.FactualActivity
Gets the type of activity.
getValue() - Method in enum com.factual.engine.api.mobile_state.FactualActivityType
Get the integer value of this enum value.
getValue() - Method in enum com.factual.engine.api.VisitSensitivity
 
getVersion() - Method in class com.factual.engine.api.FactualConfigMetadata
Gets the SDK version string.
getVisitLocation() - Method in class com.factual.engine.api.mobile_state.FactualEgressEvent
Gets the location of the place the user was visiting.
getVisitSensitivity(int) - Static method in enum com.factual.engine.api.VisitSensitivity
 
getVisitSensitivity() - Static method in class com.factual.engine.FactualEngine
Gets a parameter that increases some qualities of generated visits while decreasing others.
getVisitUpdate() - Method in class com.factual.engine.api.mobile_state.UserJourneyEvent
Gets the FactualVisitUpdate, null if visiting state wasn't updated.

H

hasActivityUpdate() - Method in class com.factual.engine.api.mobile_state.UserJourneyEvent
Returns true if the user's activity was updated, false otherwise.
hasAppStateUpdate() - Method in class com.factual.engine.api.mobile_state.UserJourneyEvent
Returns true if app-state was updated, false otherwise.
hasPlaceAttachmentUpdate() - Method in class com.factual.engine.api.mobile_state.UserJourneyEvent
Returns true if the attached places were updated, false otherwise.
hasVisitUpdate() - Method in class com.factual.engine.api.mobile_state.UserJourneyEvent
Returns true if visiting-state was updated, false otherwise.

I

initialize(Context, String, Class<? extends FactualClientReceiver>) - Static method in class com.factual.engine.FactualEngine
Initializes FactualEngine asynchronously with the given Context, api-key, and FactualClientReceiver.
isActivityMonitoringEnabled() - Static method in class com.factual.engine.FactualEngine
Returns whether activity monitoring is enabled.
isEgress() - Method in class com.factual.engine.api.mobile_state.FactualVisitUpdate
If the update is an egress.
isEndTimestampUnavailable() - Method in class com.factual.engine.api.mobile_state.UserJourneySpan
Returns true if the end timestamp is unavailable.
isEngineStarted() - Static method in class com.factual.engine.FactualEngine
Returns true if Engine is started, false otherwise.
isHome() - Method in class com.factual.engine.api.mobile_state.FactualPlaceVisit
Returns true if the user is at home.
isIngress() - Method in class com.factual.engine.api.mobile_state.FactualVisitUpdate
If the update is an ingress.
isRemoteAnalyticsEnabled() - Static method in class com.factual.engine.FactualEngine
Returns whether remote analytics is enabled (ie.
isStartTimestampUnavailable() - Method in class com.factual.engine.api.mobile_state.UserJourneySpan
Returns true if the start timestamp is unavailable.
isWork() - Method in class com.factual.engine.api.mobile_state.FactualPlaceVisit
Returns true if the user is at work.

L

LATITUDE - Static variable in class com.factual.engine.api.FactualPlace
 
LOCALITY - Static variable in class com.factual.engine.api.FactualPlace
 
LOCATION - Static variable in class com.factual.engine.api.CircumstanceResponse
 
LOCATION - Static variable in class com.factual.engine.api.PlaceCandidateResponse
 
LONGITUDE - Static variable in class com.factual.engine.api.FactualPlace
 

M

MAX_BUFFER_SIZE_KEY - Static variable in class com.factual.engine.api.FactualConfigMetadata
 

N

NAME - Static variable in class com.factual.engine.api.FactualCircumstance
 
NAME - Static variable in class com.factual.engine.api.FactualPlace
 
NEAR_PLACES - Static variable in class com.factual.engine.api.CircumstanceResponse
 

O

onCircumstanceError(FactualCircumstance, FactualError) - Method in interface com.factual.engine.api.FactualActionHandler
If an error occurred while evaluating a particular circumstance.
onCircumstancesMet(List<CircumstanceResponse>) - Method in interface com.factual.engine.api.FactualActionHandler
Called when one or more user defined circumstances are met.
onCircumstancesMet(List<CircumstanceResponse>) - Method in interface com.factual.engine.FactualClientListener
Called when one or more user defined circumstances are met.
onCircumstancesMet(List<CircumstanceResponse>) - Method in class com.factual.engine.FactualClientReceiver
 
onConfigLoad(FactualConfigMetadata) - Method in interface com.factual.engine.FactualClientListener
Called when a new config is loaded with metadata.
onConfigLoad(FactualConfigMetadata) - Method in class com.factual.engine.FactualClientReceiver
 
onContext(Context) - Method in class com.factual.engine.api.BaseApiReceiver
Gets called with the application's Context before one of the other functions in the receiver is called.
onDiagnosticMessage(String) - Method in interface com.factual.engine.FactualClientListener
Called when a structured diagnostic message is available.
onDiagnosticMessage(String) - Method in class com.factual.engine.FactualClientReceiver
 
onError(FactualError) - Method in interface com.factual.engine.FactualClientListener
Called when an error occurs in the sdk and provides a FactualError.
onError(FactualError) - Method in class com.factual.engine.FactualClientReceiver
 
onHandleWork(Intent) - Method in class com.factual.engine.FactualJobIntentService
 
onInfo(FactualInfo) - Method in interface com.factual.engine.FactualClientListener
Called when an info message is sent by the sdk and provides a FactualInfo.
onInfo(FactualInfo) - Method in class com.factual.engine.FactualClientReceiver
 
onInitialized() - Method in interface com.factual.engine.FactualClientListener
Called when the SDK initialized successfully.
onInitialized() - Method in class com.factual.engine.FactualClientReceiver
 
onPlacesError(FactualError) - Method in interface com.factual.engine.api.FactualPlacesListener
Called when an on-demand place candidate request fails.
onPlacesResponse(PlaceCandidateResponse) - Method in interface com.factual.engine.api.FactualPlacesListener
Called when an on-demand place candidate request returns successfully.
onReceive(Context, Intent) - Method in class com.factual.engine.api.BaseApiReceiver
 
onReceive(Context, Intent) - Method in class com.factual.engine.api.mobile_state.UserJourneyReceiver
 
onReceive(Context, Intent) - Method in class com.factual.engine.FactualClientReceiver
 
onStarted() - Method in interface com.factual.engine.FactualClientListener
Called when the sdk started successfully.
onStarted() - Method in class com.factual.engine.FactualClientReceiver
 
onStopCurrentWork() - Method in class com.factual.engine.FactualJobIntentService
 
onStopped() - Method in interface com.factual.engine.FactualClientListener
Called when the sdk stopped successfully.
onStopped() - Method in class com.factual.engine.FactualClientReceiver
 
onSyncWithGarageComplete() - Method in interface com.factual.engine.FactualClientListener
Called when an on-demand sync with Garage is complete.
onSyncWithGarageComplete() - Method in class com.factual.engine.FactualClientReceiver
 
onUserJourneyEvent(UserJourneyEvent) - Method in interface com.factual.engine.api.mobile_state.UserJourneyListener
Called when a user journey event occurs.
onUserJourneyEvent(UserJourneyEvent) - Method in class com.factual.engine.api.mobile_state.UserJourneyReceiver
Called when a mobile state update occurs.
onUserJourneySpan(UserJourneySpan) - Method in interface com.factual.engine.api.mobile_state.UserJourneyListener
Called when a user journey span occurs, either 1) when a user arrives at a place after a period of travel or 2) when a user departs a place after dwelling there.
onUserJourneySpan(UserJourneySpan) - Method in class com.factual.engine.api.mobile_state.UserJourneyReceiver
Called when a user journey span occurs, either 1) when a user arrives at a place after a period of travel or 2) when a user departs a place after dwelling there.

P

PlaceCandidateResponse - Class in com.factual.engine.api
The response object from a call to getPlaceCandidates().
PlaceCandidateResponse(List<FactualPlace>, Location) - Constructor for class com.factual.engine.api.PlaceCandidateResponse
Constructs a PlaceCandidateResponse object.
PlaceCandidateResponse(List<FactualPlace>, Location, long) - Constructor for class com.factual.engine.api.PlaceCandidateResponse
Constructs a PlaceCandidateResponse object.
PlaceCandidateResponse(JSONObject) - Constructor for class com.factual.engine.api.PlaceCandidateResponse
Constructs a PlaceCandidateResponse object.
PlaceConfidenceThreshold - Enum in com.factual.engine.api
The confidence level of the place-attachment.
POSTCODE - Static variable in class com.factual.engine.api.FactualPlace
 

R

REGION - Static variable in class com.factual.engine.api.FactualPlace
 
registerCircumstance(FactualCircumstance) - Static method in class com.factual.engine.FactualEngine
Registers a FactualCircumstance.
resetAdId() - Static method in class com.factual.engine.FactualEngine
Removes the ad-id from the SDK so that it is no longer associated with remote analytics.
runCircumstances() - Static method in class com.factual.engine.FactualEngine
Begins an asynchronous call to check all registered and enabled circumstances.
runCircumstances(Location) - Static method in class com.factual.engine.FactualEngine
Begins an asynchronous call to check all registered and enabled circumstances against a mock location.

S

SEND_BUFFER_SIZE_KEY - Static variable in class com.factual.engine.api.FactualConfigMetadata
 
setActivities(List<FactualActivity>) - Method in class com.factual.engine.api.mobile_state.UserJourneySpan.Builder
Sets the activities the UserJourneySpan.
setActivityUpdate(FactualActivityUpdate) - Method in class com.factual.engine.api.mobile_state.UserJourneyEvent.Builder
setAdId(String) - Static method in class com.factual.engine.FactualEngine
Sets the device's advertising-id in the SDK so that it will be associated with the remote analytics.
setAppStateUpdate(AppStateUpdate) - Method in class com.factual.engine.api.mobile_state.UserJourneyEvent.Builder
setBackgroundEnabled(boolean) - Static method in class com.factual.engine.FactualEngine
Enables or disables data collection in the background.
setCategoryIds(List<Integer>) - Method in class com.factual.engine.api.FactualPlace
Sets the Factual category-ids of the place.
setChainId(String) - Method in class com.factual.engine.api.FactualPlace
Sets the Factual chain-id of the place.
setCountry(String) - Method in class com.factual.engine.api.FactualPlace
Sets the country of the place.
setCurrentPlace(FactualPlaceVisit) - Method in class com.factual.engine.api.mobile_state.UserJourneySpan.Builder
Sets the currentPlace the UserJourneySpan.
setDidLoseSignal(boolean) - Method in class com.factual.engine.api.mobile_state.UserJourneySpan.Builder
Sets didLoseSignal in the UserJourneySpan.
setDidTravel(boolean) - Method in class com.factual.engine.api.mobile_state.UserJourneySpan.Builder
Sets didTravel in the UserJourneySpan.
setEndTimestamp(long) - Method in class com.factual.engine.api.mobile_state.UserJourneySpan.Builder
Sets endTimestamp in the UserJourneySpan.
setEndTimestampUnavailable(boolean) - Method in class com.factual.engine.api.mobile_state.UserJourneySpan.Builder
Sets endTimestampUnavailable in the UserJourneySpan.
setLocality(String) - Method in class com.factual.engine.api.FactualPlace
Sets the locality of the place.
setMainActivityType(FactualActivityType) - Method in class com.factual.engine.api.mobile_state.UserJourneySpan.Builder
Sets the mainActivityType the UserJourneySpan.
setPlaceAttachmentUpdate(FactualPlaceAttachmentUpdate) - Method in class com.factual.engine.api.mobile_state.UserJourneyEvent.Builder
setPostcode(String) - Method in class com.factual.engine.api.FactualPlace
Sets the postcode of the place.
setPreviousPlace(FactualPlaceVisit) - Method in class com.factual.engine.api.mobile_state.UserJourneySpan.Builder
Sets the previousPlace the UserJourneySpan.
setRegion(String) - Method in class com.factual.engine.api.FactualPlace
Sets the region of the place.
setSpanId(String) - Method in class com.factual.engine.api.mobile_state.UserJourneySpan.Builder
Sets the spanId in the UserJourneySpan.
setStartTimestamp(long) - Method in class com.factual.engine.api.mobile_state.UserJourneySpan.Builder
Sets the startTimestamp in the UserJourneySpan.
setStartTimestampUnavailable(boolean) - Method in class com.factual.engine.api.mobile_state.UserJourneySpan.Builder
Sets startTimestampUnavailable in the UserJourneySpan.
setUserJourneyReceiver(Class<? extends UserJourneyReceiver>) - Static method in class com.factual.engine.FactualEngine
Sets the UserJourneyReceiver class.
setVisitSensitivity(VisitSensitivity) - Static method in class com.factual.engine.FactualEngine
Sets a parameter that increases some qualities of generated visits while decreasing others.
setVisitUpdate(FactualVisitUpdate) - Method in class com.factual.engine.api.mobile_state.UserJourneyEvent.Builder
start() - Static method in class com.factual.engine.FactualEngine
Starts FactualEngine asynchronously.
stop() - Static method in class com.factual.engine.FactualEngine
Stops FactualEngine asynchronously.
syncWithGarage() - Static method in class com.factual.engine.FactualEngine
Requests an asynchronous on-demand sync with Garage.

T

TAGS - Static variable in class com.factual.engine.api.FactualCircumstance
 
THRESH_HIGH - Static variable in class com.factual.engine.api.FactualPlace
 
THRESH_LOW - Static variable in class com.factual.engine.api.FactualPlace
 
THRESH_NONE - Static variable in class com.factual.engine.api.FactualPlace
 
THRESHOLD - Static variable in class com.factual.engine.api.FactualPlace
 
TIMESTAMP - Static variable in class com.factual.engine.api.PlaceCandidateResponse
 
TIMESTAMP_KEY - Static variable in class com.factual.engine.api.FactualConfigMetadata
 
toJson() - Method in class com.factual.engine.api.CircumstanceResponse
Returns the CircumstanceResponse as a JSONObject
toJson() - Method in class com.factual.engine.api.FactualCircumstance
Returns the FactualCircumstance as a JSONObject.
toJson() - Method in class com.factual.engine.api.FactualConfigMetadata
 
toJson() - Method in class com.factual.engine.api.FactualGarageRelease
Returns the garage release as json.
toJson() - Method in class com.factual.engine.api.FactualPlace
Gets a JSON representation of the FactualPlace.
toJson() - Method in class com.factual.engine.api.mobile_state.AppStateUpdate
Returns the AppStateUpdate as json.
toJson() - Method in class com.factual.engine.api.mobile_state.FactualActivity
Returns the FactualActivity as json.
toJson() - Method in class com.factual.engine.api.mobile_state.FactualActivityUpdate
Returns the FactualActivityUpdate as json.
toJson() - Method in class com.factual.engine.api.mobile_state.FactualEgressEvent
Returns the FactualEgressEvent as json.
toJson() - Method in class com.factual.engine.api.mobile_state.FactualIngressEvent
Returns the FactualIngressEvent as json.
toJson() - Method in class com.factual.engine.api.mobile_state.FactualPlaceAttachmentUpdate
Returns the FactualPlaceAttachmentUpdate as json.
toJson() - Method in class com.factual.engine.api.mobile_state.FactualPlaceVisit
Returns a json representation of the FactualPlaceVisit.
toJson() - Method in class com.factual.engine.api.mobile_state.FactualVisitUpdate
Returns the FactualVisitUpdate as json.
toJson() - Method in class com.factual.engine.api.mobile_state.Geographies
Returns a json representation of the Geographies.
toJson() - Method in class com.factual.engine.api.mobile_state.UserJourneyEvent
Returns the UserJourneyEvent as json.
toJson() - Method in class com.factual.engine.api.mobile_state.UserJourneySpan
Returns the UserJourneySpan as json.
toJson() - Method in class com.factual.engine.api.PlaceCandidateResponse
Returns a JSON representation of a PlaceCandidateResponse.
toString() - Method in class com.factual.engine.api.FactualConfigMetadata
 
toString() - Method in class com.factual.engine.api.FactualError
Returns the FactualError message text
toString() - Method in class com.factual.engine.api.FactualGarageRelease
Gets the Json version of the GarageRelease as a string.
toString() - Method in class com.factual.engine.api.FactualInfo
Gets the info message text.

U

unregisterCircumstance(String) - Static method in class com.factual.engine.FactualEngine
Unregisters a FactualCircumstance.
UserJourneyEvent - Class in com.factual.engine.api.mobile_state
Reports user journey events that specify changes to place-attachment, activity, visits, and app-state.
UserJourneyEvent(long, FactualVisitUpdate, AppStateUpdate, FactualActivityUpdate, FactualPlaceAttachmentUpdate) - Constructor for class com.factual.engine.api.mobile_state.UserJourneyEvent
Constructs a UserJourneyEvent object.
UserJourneyEvent.Builder - Class in com.factual.engine.api.mobile_state
A builder for creating UserJourneyEvent instances.
UserJourneyListener - Interface in com.factual.engine.api.mobile_state
A listener for user journey events and spans.
UserJourneyReceiver - Class in com.factual.engine.api.mobile_state
A receiver for user journey events.
UserJourneyReceiver() - Constructor for class com.factual.engine.api.mobile_state.UserJourneyReceiver
 
UserJourneySpan - Class in com.factual.engine.api.mobile_state
Reports summarized user journey information over a defined span of time.
UserJourneySpan(String, long, boolean, long, boolean, boolean, boolean, FactualPlaceVisit, FactualPlaceVisit, FactualActivityType, List<FactualActivity>) - Constructor for class com.factual.engine.api.mobile_state.UserJourneySpan
Constructs a UserJourneySpan object.
UserJourneySpan.Builder - Class in com.factual.engine.api.mobile_state
A builder for creating UserJourneySpan instances.

V

valueOf(String) - Static method in enum com.factual.engine.api.mobile_state.AppState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.factual.engine.api.mobile_state.FactualActivityType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.factual.engine.api.PlaceConfidenceThreshold
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.factual.engine.api.VisitSensitivity
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.factual.engine.api.mobile_state.AppState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.factual.engine.api.mobile_state.FactualActivityType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.factual.engine.api.PlaceConfidenceThreshold
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.factual.engine.api.VisitSensitivity
Returns an array containing the constants of this enum type, in the order they are declared.
verifyPlaces(PlaceCandidateResponse, List<String>) - Static method in class com.factual.engine.FactualEngine
Allows the user to specify which place or places he/she is at.
verifyPlaces(PlaceCandidateResponse, List<String>, List<String>, JSONObject) - Static method in class com.factual.engine.FactualEngine
Allows the user to specify which place or places he/she is at.
VERSION_KEY - Static variable in class com.factual.engine.api.FactualConfigMetadata
 
VisitSensitivity - Enum in com.factual.engine.api
Used to control some qualities of generated visits.

W

writeToParcel(Parcel, int) - Method in class com.factual.engine.api.CircumstanceResponse
 
writeToParcel(Parcel, int) - Method in class com.factual.engine.api.FactualCircumstance
 
writeToParcel(Parcel, int) - Method in class com.factual.engine.api.FactualConfigMetadata
 
writeToParcel(Parcel, int) - Method in class com.factual.engine.api.FactualError
 
writeToParcel(Parcel, int) - Method in class com.factual.engine.api.FactualGarageRelease
 
writeToParcel(Parcel, int) - Method in class com.factual.engine.api.FactualInfo
 
writeToParcel(Parcel, int) - Method in class com.factual.engine.api.FactualPlace
 
writeToParcel(Parcel, int) - Method in class com.factual.engine.api.mobile_state.AppStateUpdate
 
writeToParcel(Parcel, int) - Method in class com.factual.engine.api.mobile_state.FactualActivity
 
writeToParcel(Parcel, int) - Method in class com.factual.engine.api.mobile_state.FactualActivityUpdate
 
writeToParcel(Parcel, int) - Method in class com.factual.engine.api.mobile_state.FactualEgressEvent
 
writeToParcel(Parcel, int) - Method in class com.factual.engine.api.mobile_state.FactualIngressEvent
 
writeToParcel(Parcel, int) - Method in class com.factual.engine.api.mobile_state.FactualPlaceAttachmentUpdate
 
writeToParcel(Parcel, int) - Method in class com.factual.engine.api.mobile_state.FactualPlaceVisit
 
writeToParcel(Parcel, int) - Method in class com.factual.engine.api.mobile_state.FactualVisitUpdate
 
writeToParcel(Parcel, int) - Method in class com.factual.engine.api.mobile_state.Geographies
 
writeToParcel(Parcel, int) - Method in class com.factual.engine.api.mobile_state.UserJourneyEvent
 
writeToParcel(Parcel, int) - Method in class com.factual.engine.api.mobile_state.UserJourneySpan
 
A B C D E F G H I L M N O P R S T U V W 
Skip navigation links