core/com.sentiance.sdk/Sentiance

Sentiance

open class Sentiance : PublicApiClass, ISentiance

Functions

Link copied to clipboard
open fun addTripMetadata(@NonNull metadata: Map<String, String>): Boolean
Adds metadata to an external ongoing trip.
Link copied to clipboard
open fun addUserMetadataField(@NonNull label: String, @NonNull value: String)
Adds a user specific metadata field.
Link copied to clipboard
open fun addUserMetadataFields(@NonNull metadata: Map<String, String>)
Adds multiple user specific metadata fields.The metadata is then uploaded to the Sentiance Cloud Platform and made available in backend API queries and offloads.
Link copied to clipboard
@NonNull
open fun createUser(@NonNull options: UserCreationOptions): PendingOperation<UserCreationResult, UserCreationError>
Creates a Sentiance user if one does not yet exist.
Link copied to clipboard
open fun disableBatteryOptimization()
Prompts a system dialog, asking the user to allow disabling battery optimization for the app.
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@NonNull
open fun getDetectionStatus(): DetectionStatus
Returns a the detection status as a DetectionStatus enum.
Link copied to clipboard
open fun getDiskQuotaLimit(): Long
Returns the SDK's disk quota limit.
Link copied to clipboard
open fun getDiskQuotaUsage(): Long
Returns the SDK's disk quota usage.
Link copied to clipboard
@NonNull
open fun getInitState(): InitState
Returns the initialization state of the Sentiance SDK.
Link copied to clipboard
@JvmStatic
@NonNull
open fun getInstance(@NonNull context: Context): Sentiance
Link copied to clipboard
open fun getMobileQuotaLimit(): Long
Returns the SDK's mobile data quota limit.
Link copied to clipboard
open fun getMobileQuotaUsage(): Long
Returns the SDK's mobile data quota usage.
Link copied to clipboard
@NonNull
open fun getSdkStatus(): SdkStatus
Returns an SdkStatus object representing the status of the SDK.
Link copied to clipboard
@NonNull
open fun getTransmittableDataTypes(): Set<TransmittableDataType>
Returns the data types that are allowed to be sent to the Sentiance Cloud Platform.
Link copied to clipboard
open fun getUserAccessToken(@NonNull callback: TokenResultCallback)
Deprecated: use requestUserAccessToken instead.
Link copied to clipboard
@NonNull
open fun getUserActivity(): UserActivity
Returns a UserActivity object representing the currently detected user's activity.
Link copied to clipboard
@Nullable
open fun getUserId(): String
Returns the Sentiance user ID, or null if a user does not exist.
Link copied to clipboard
open fun getUserTags(): Map<String, String>
Returns the tags currently set for the Sentiance user, as previously provided to setUserTags.
Link copied to clipboard
@NonNull
open fun getVersion(): String
Returns the SDK version.
Link copied to clipboard
open fun getWiFiQuotaLimit(): Long
Returns the SDK's WiFi quota limit.
Link copied to clipboard
open fun getWiFiQuotaUsage(): Long
Returns the SDK's WiFi quota usage.
Link copied to clipboard
open fun init(@NonNull sdkConfig: SdkConfig, @NonNull initCallback: OnInitCallback)
Deprecated: use initialize instead.
Link copied to clipboard
@NonNull
open fun initialize(): InitializationResult
Initializes the Sentiance SDK, thereby preparing it to resume detections if a Sentiance user exists, and if detections were last enabled.
@NonNull
open fun initialize(@NonNull options: SentianceOptions): InitializationResult
Initializes the Sentiance SDK, thereby preparing it to resume detections if a Sentiance user exists.
Link copied to clipboard
@NonNull
open fun initializeAsync(@NonNull options: SentianceOptions): PendingOperation<AsyncInitializationResult, AsyncInitializationError>
Initializes the Sentiance SDK, thereby preparing it to resume detections if a Sentiance user exists, and if detections were last enabled.
Link copied to clipboard
open fun isAllowedToUseMobileData(): Boolean
Returns whether the Sentiance SDK is allowed to use mobile data for uploading and downloading configuration and detection data.
Link copied to clipboard
open fun isAppSessionDataCollectionEnabled(): Boolean
Returns whether app session data collection is enabled.
Link copied to clipboard
open fun isTripOngoing(@NonNull tripType: TripType): Boolean
Indicates whether a trip is in progress.
Link copied to clipboard
open fun isUserLinked(): Boolean
Returns whether a Sentiance user exists on the device, and whether it is linked to your app's user.
Link copied to clipboard
@NonNull
open fun linkUser(@NonNull userLinker: UserLinker): PendingOperation<UserLinkingResult, UserLinkingError>
@NonNull
open fun linkUser(@NonNull userLinker: UserLinkerAsync): PendingOperation<UserLinkingResult, UserLinkingError>
@NonNull
open fun linkUser(@NonNull authenticationCode: String): PendingOperation<UserLinkingResult, UserLinkingError>
Links the Sentiance user to your app's user, on the Sentiance Cloud Platform.
Link copied to clipboard
open fun removeUserMetadataField(@NonNull label: String)
Removes a user specific metadata field.
Link copied to clipboard
@NonNull
open fun requestUserAccessToken(): PendingOperation<Token, UserAccessTokenError>
Returns the user's API access token as a Token object, via the PendingOperation result.
Link copied to clipboard
@NonNull
open fun reset(): PendingOperation<ResetResult, ResetError>
Resets the Sentiance SDK.
open fun reset(@Nullable callback: ResetCallback)
Deprecated: use reset instead.
Link copied to clipboard
open fun setAppSessionDataCollectionEnabled(enabled: Boolean)
If enabled, the SDK may collect additional sensor and location data when the app is in the foreground (i.e visible to the user).
Link copied to clipboard
open fun setIsAllowedToUseMobileData(isAllowed: Boolean)
Sets whether the Sentiance SDK is allowed to use mobile data for uploading and downloading configuration and detection data.
Link copied to clipboard
open fun setSdkStatusUpdateListener(@Nullable listener: SdkStatusUpdateListener)
Sets a listener that is invoked when the SDK's status is updated.
Link copied to clipboard
open fun setTransmittableDataTypes(@NonNull transmittableDataTypes: Set<TransmittableDataType>)
Sets the data types that are allowed to be sent to the Sentiance Cloud Platform.
Link copied to clipboard
open fun setTripTimeoutListener(@Nullable listener: TripTimeoutListener)
Sets a listener that is invoked when a trip times out.
Link copied to clipboard
open fun setUserActivityListener(@Nullable listener: UserActivityListener)
Sets a listener that is invoked when a new user activity is detected.
Link copied to clipboard
open fun setUserTags(@NonNull tags: Map<String, String>)
Sets the tags for the current Sentiance user.
Link copied to clipboard
open fun start(@Nullable handler: OnStartFinishedHandler)
open fun start(@Nullable stopDate: Date, @Nullable handler: OnStartFinishedHandler)
Deprecated: use enableDetections instead.
Link copied to clipboard
@NonNull
open fun startTrip(@Nullable metadata: Map<String, String>, @Nullable transportModeHint: TransportMode): PendingOperation<StartTripResult, StartTripError>
Starts an external trip.
open fun startTrip(@Nullable metadata: Map<String, String>, @Nullable transportModeHint: TransportMode, @Nullable callback: StartTripCallback)
Deprecated: use startTrip instead.
Link copied to clipboard
open fun stop()
Deprecated: use disableDetections instead.
Link copied to clipboard
@NonNull
open fun stopTrip(): PendingOperation<StopTripResult, StopTripError>
Stops the currently ongoing external trip (i.
open fun stopTrip(@Nullable callback: StopTripCallback)
Deprecated: use stopTrip instead.
Link copied to clipboard
@NonNull
open fun submitDetections(): PendingOperation<SubmitDetectionsResult, SubmitDetectionsError>
Submits any pending SDK detection to the Sentiance API.
open fun submitDetections(@Nullable callback: SubmitDetectionsCallback)
Deprecated: use submitDetections instead.
Link copied to clipboard
open fun updateSdkNotification(@NonNull notification: Notification)
Replaces the notification set via setNotification.
Link copied to clipboard
open fun userExists(): Boolean
Returns whether a Sentiance user exists on the device.