LogoLogo
SentianceInsights-Control-TowerLegacy DocsImportant Security Notice
  • Introduction
  • Integrating the SDK
    • Getting Started
    • Android Quick Start
      • 1. Including the SDK
      • 2. Initialization
      • 3. User Creation
      • 4. Enabling Detections
      • 5. SDK Status Updates
      • 6. Permissions
      • 7. Additional Requirements
    • iOS Quick Start
      • 1. Including the SDK
        • Using CocoaPods
        • Using Carthage
        • Using Swift Package Manager
        • Manual Integration
      • 2. Project Settings
      • 3. Initialization
      • 4. User Creation
      • 5. Enabling Detections
      • 6. SDK Status Updates
      • 7. Permissions
      • 8. Additional Requirements
    • React Native Quick Start
      • 1. Including the SDK
      • 2. Configuration
      • 3. Initialization
      • 4. User Creation
      • 5. Enabling Detections
      • 6. SDK Status Updates
    • Flutter Quick Start
      • 1. Including the SDK
      • 2. Configuration
      • 3. Initialization
      • 4. User Creation
      • 5. Enabling Detections
      • 6. SDK Status Updates
    • What Comes After Integration
    • Integration (FAQ)
    • Detections (FAQ)
  • Sentiance Insights
    • Overview of Sentiance Insights
      • Driving Insights
        • Transports
        • Driving Events and Scores
        • Car Crashes
      • Mobility and Lifestyle Insights
        • Visit Essentials
        • User Segmentation
    • Engagement
      • User Adaptive Score
      • Streaks
      • Challenges
      • Reward System
      • Communication Campaign
      • Social Groups
        • Technical Details
    • Accessing Sentiance Insights
      • via On Device API
      • via Cloud API
      • via Firehose - Realtime Messages
      • via Offloads
  • FAQ
    • Security, Privacy and Terms of Service (FAQ)
  • Important topics
    • SDK
      • Appendix
        • Android
          • Android 10 Update Behavior
          • Android Battery Optimization
          • Artifacts & Dependencies
          • Manifest Permissions
          • Notification Management
          • Sample Notification
          • Supported API Levels
        • iOS
          • App Store Privacy Section
          • App Store Release
          • Apple Privacy Manifest
          • ARM Simulator Support
          • Dependencies
          • iOS 13 permission changes
          • Supported iOS Versions & Architectures
          • Swift Support
          • v5.x Framework Files
          • v6.x Framework Files
        • Controlled Detections
          • Automatic Detections
          • Automatic Detections with Forced Trips
          • Controlled Trips Only
          • Checking Trip Status
        • Control Sending Data
        • Custom User Metadata
        • Detecting Vehicle Crashes
        • Feature Production Readiness
        • Migration Guide
          • Android
          • iOS
          • React Native
          • Flutter
        • On-Device Features
        • React Native
        • SDK Initialization
        • User Access Token
        • User Creation
        • User Linking
        • Xamarin
      • API Reference
        • Android
          • AsyncInitializationError
          • AsyncInitializationResult
          • DateTime
          • DetectionStatus
          • DisableDetectionsError
          • DisableDetectionsResult
          • Driving Insights
            • CallWhileMovingEvent
            • DrivingInsight
            • DrivingInsightsApi
            • DrivingInsightsReadyListener
            • HarshDrivingEvent
              • Type
            • PhoneUsageEvent
            • SafetyScores
            • SafetyScoreRequestParameters
              • Builder
              • OccupantRoles
              • Period
              • TransportModes
            • SpeedingEvent
          • Smart Geofences
            • DetectionMode
            • SmartGeofence
            • SmartGeofenceApi
            • SmartGeofenceEvent
              • Type
            • SmartGeofenceEventListener
            • SmartGeofencesRefreshError
              • SmartGeofencesRefreshFailureReason
            • SmartGeofencesRefreshResult
          • EnableDetectionsError
            • EnableDetectionsFailureReason
          • EnableDetectionsResult
          • EventTimeline
            • EventType
            • TransportMode
            • Event
              • OffTheGridEvent
              • StationaryEvent
              • TransportEvent
              • UnknownEvent
            • EventTimelineUpdateListener
            • EventTimelineApi
            • OccupantRole
            • Venue
              • VenueType
              • VenueSignificance
          • Feedback
            • FeedbackApi
            • OccupantRoleFeedback
            • OccupantRoleFeedbackResult
          • GeoLocation
          • InitializationResult
            • InitializationFailureReason
          • InitState
          • MetaUserLinker
          • MetaUserLinkerAsync
          • MetaUserLinkerCallback
          • OnInitCallback
            • InitIssue
          • OnSdkStatusUpdateHandler
          • OnStartFinishedHandler
          • PendingOperation
            • OnSuccessListener
            • OnFailureListener
            • OnFailureListener
            • OnCompleteListener
          • ResetCallback
            • ResetCallback.ResetFailureReason
          • ResetError
            • ResetFailureReason
          • ResetResult
          • SdkConfig
            • LocationPermission
            • Builder
          • SdkException
          • SdkStatus
            • LocationSetting
            • Quota Status
            • StartStatus
          • SdkStatusUpdateListener
          • Sentiance
          • SentianceOptions
            • SentianceOptions.Builder
          • StartTripError
            • StartTripFailureReason
          • StartTripResult
          • StationaryInfo
          • StopTripError
            • StopTripFailureReason
          • StopTripResult
          • SubmitDetectionsCallback
          • SubmitDetectionsError
            • SubmitDetectionsFailureReason
          • SubmitDetectionsResult
          • Token
          • TokenResultCallback
          • TransmittableDataType
          • Transport Sessions
            • SensorDataChunk
            • TransportSession
            • TransportSessionApi
            • TransportSessionListener
          • Trip
            • StartTripCallback
            • StopTripCallback
            • TransportMode
            • TripTimeoutListener
            • TripType
          • TripInfo
          • UserAccessTokenError
            • UserAccessTokenFailureReason
          • UserActivity
          • UserActivityListener
          • UserActivityType
          • UserContext
            • Attribute
            • Segment
              • SegmentCategory
              • SegmentSubcategory
              • SegmentType
            • SemanticTime
          • UserContextApi
            • RequestUserContextFailureReason
            • RequestUserContextError
            • UserContextUpdateCriteria
            • UserContextUpdateListener
          • UserCreationError
            • UserCreationFailureReason
          • UserCreationOptions
            • UserCreationOptions.Builder
          • UserCreationResult
            • UserInfo
          • UserLinker
          • UserLinkerAsync
          • UserLinkerCallback
          • UserLinkingError
            • UserLinkingFailureReason
          • UserLinkingResult
          • VehicleCrashDetection
            • CrashDetectionApi
            • CrashDetectionState
            • VehicleCrashDiagnostic
            • VehicleCrashEvent
            • VehicleCrashDiagnosticListener
            • VehicleCrashListener
            • VehicleCrashSeverity
          • Waypoint
        • iOS
          • Detections
            • Enable Detections
            • Disable Detections
          • Driving Insights
            • SENTCallWhileMovingEvent
            • SENTDrivingInsights
            • SENTDrivingInsightsReadyDelegate
            • SENTHarshDrivingEvent
              • HarshDrivingEventType
            • SENTPhoneUsageEvent
            • SENTSpeedingEvent
            • SENTSafetyScores
            • SafetyScoreRequestParameters
              • SafetyScoreRequestOccupantRoleOption
              • SafetyScoreRequestPeriod
              • SafetyScoreRequestTransportModeOption
          • Event Timeline
            • EventTimelineDelegate
            • SENTOccupantRole
            • SENTTimelineEvent
              • SENTOffTheGridEvent
              • SENTStationaryEvent
              • SENTTransportEvent
              • SENTUnknownEvent
            • SENTTimelineEventType
            • SENTTimelineTransportMode
            • SENTVenue
            • SENTVenueSignificance
            • SENTVenueType
          • Feedback
            • SENTFeedback
            • SENTOccupantRoleFeedback
            • SENTOccupantRoleFeedbackResult
          • SENTCompletionHandlers
          • SENTConfig
          • SENTDate
          • SENTGeolocation
          • SENTAsyncInitializationCompletionHandler
          • SENTAsyncInitializationError
          • SENTAsyncInitializationResult
          • Sentiance
          • SENTInitializationResult
          • SENTOptions
            • SENTOptionsInitPurpose
          • SENTPublicDefinitions
          • SENTSDKStatus
          • SENTToken
          • SENTTransmittableDataType
          • SENTUserActivity
          • SENTVehicleCrashDetectionState
          • SENTVehicleCrashDiagnostic
          • SENTVehicleCrashEvent
            • SENTVehicleCrashSeverity
          • SENTWaypoint
          • Smart Geofences
            • SENTSmartGeofencesRefreshHandler
            • SmartGeofenceDetectionMode
            • SmartGeofencesRefreshError
              • SmartGeofencesRefreshFailureReason
            • SmartGeofencesRefreshResult
            • SmartGeofence
            • SmartGeofenceEvent
              • SmartGeofenceEventType
            • SmartGeofenceEventDelegate
          • Transport Sessions
            • SENTAccelerometerDataIterator
            • SENTLocationDataIterator
            • SENTSensorDataChunk
            • SENTTransportSession
          • User Context
            • SENTAttribute
            • SENTRequestUserContextCompletionHandler
            • SENTRequestUserContextError
            • SENTRequestUserContextFailureReason
            • SENTSegment
              • SENTSegmentCategory
              • SENTSegmentSubCategory
              • SENTSegmentType
            • SENTSemanticTime
            • SENTUserContext
            • SENTUserContextDelegate
            • SENTUserContextUpdateCriteria
          • User Creation & Linking
            • SENTUserInfo
            • User Creation
              • SENTUserCreationResult
              • SENTUserCreationFailureReason
              • SENTUserCreationError
              • SENTUserCreationCompletionHandler
              • SENTUserCreationOptions
            • User Linking
              • SENTNoOpUserLinker
              • SENTUserLinkingResult
              • SENTUserLinkingFailureReason
              • SENTUserLinkingError
              • SENTUserLinkingCompletionHandler
              • SENTUserLinker
        • React Native
          • core
            • Definitions
            • Examples
          • crash-detection
            • Definitions
            • Examples
          • driving-insights
            • Definitions
            • Examples
          • smart-geofences
            • Definitions
            • Examples
          • event-timeline
            • Definitions
            • Examples
          • legacy
            • Definitions
            • Examples
          • user-context
            • Definitions
            • Examples
        • Flutter
      • Battery Optimization on Android
      • How To
        • Check the Location Permissions
        • Utilize the Event Timeline API
        • Utilize the Driving Insights API
        • Utilize the User Context API
        • Utilize the Smart Geofences API
      • Troubleshooting
        • Android
        • iOS
      • Changelog
        • Android
        • iOS
        • React Native
        • Flutter
    • Authentication and Authorization
    • User Creation (via Authentication Code)
    • User Deletion
    • PlayStore Location Access Review
    • Privacy Report & Dashboard
    • Crash Detection
    • Important Security Notice
    • Injecting Fake Data
    • Custom Aggregation For Analytics
    • Merging Scores for Motorcycles and Cars
  • Links
    • SDK Standard License
    • Insights-by-Sentiance Application
    • Insights-by-Sentiance Privacy Policy
    • Journeys License
    • Technical & Organizational Measures
Powered by GitBook
On this page

Last updated 22 days ago

SENTSDKInitState

Indicates the SDK initialization status.

SENTQuotaStatus

Quota status applicable to disk and network usage.

Attributes
Description

SENTResetFailureReason

Indicates the failure reason of the latest reset attempt.

Type
Description

canDetect

True only if detections are possible (i.e. there are no issues blocking detection)

canMonitorRegions

isRemoteEnabled

True if kill-switch is not enabled

locationPermission

CanDetect is true, if conditions for the location permissions are met.

isAccelPresent

True if device has an accelerometer

isPreciseLocationAuthorizationGranted

True if location accuracy authorization permission is granted. If false, canDetect will be false.

isDeviceLowPowerModeEnabled

Returns whether low power mode is enabled or not.

isLocationAvailable

The SDK's location availability state.

Generally, when the device location setting is in an acceptable state, and all required location related permissions are granted, this property will be true. However, under certain conditions, location data may still be unavailable, in which case this property will be false. Once location data becomes available again, the SDK will automatically update this property and resume detections if possible.

Note that it can take up to 30 seconds for a change in the device's location settings or permissions to take effect on SDK's location availability state.

isMotionActivityPermissionGranted

Returns whether motion activity permission is granted or not.

isGyroPresent

True if device has a gyroscope

isGpsPresent

True if device has a GPS unit

wifiQuotaStatus

Indicates WiFi quota state.

Sentiance assigns a limited quota for the SDK to utilized over a period of 1 month. The quota usage is reset on the first day of each month. Once the quota is exceeded, data submission over WiFi stops. The default quota is 2048 MB, but is configurable by Sentiance.

mobileQuotaStatus

Indicates mobile data quota state.

Sentiance assigns a limited quota for the SDK to utilized over a period of 1 month. The quota usage is reset on the first day of each month. Once the quota is exceeded, data submission over mobile data stops. The default quota is 250 MB, but is configurable by Sentiance.

diskQuotaStatus

Indicates disk quota state.

Sentiance assigns a limited quota for the SDK to utilized. Once the quota is exceeded, SDK detections stop. The default quota is 128 MB, but is configurable by Sentiance.

userExists

True if a user exists on the device.

detectionStatus

Indicates whenever the detection is enabled and start or the status of the SDK.

backgroundRefreshStatus

Get background refresh status for the background processing and fetch capabilities.

startStatus

Indicates the status of the SDK

isEqualToSDKStatus

The SDK must be able to monitor regions, so that it can do battery efficient detections. If monitoring regions is not possible, detections will be stopped. This can happen when, for example, the per-app limit of 20 regions has been exhausted, due to monitoring too many regions at the same time. See .

Attributes
Description

Returns a Boolean value that indicates whether a given is equal to the receiver using item by item comparsion.

SENTNotInitialized

The SDK has not been initialized or a previous initialization attempt has failed. To initialize the SDK, call [[SENTSDK sharedInstance] initWithConfig:(SENTConfig *) success:^(void)success failure:^(SENTInitIssue issue)failure]

SENTInitInProgress

Initialization is in progress. When it completes, the SDK will call success() and failure() if something went wrong.

SENTInitialized

The SDK has been initialized.

SENTResetting

The SDK reset is in progress. All public method calls will be ignored and callbacks will not be triggered during this state.

SENTQuotaStatusOK

The quota is below the threshold.

SENTQuotaStatusWarning

More than 90 percent of the quota is consumed.

SENTQuotaStatusExceeded

The quota is fully consumed.

SENTResetFailureReasonInitInProgress

SDK initialization is in progress.

SENTResetFailureReasonResetting

Another SDK reset is in progress.

@property(nonatomic, assign) BOOL canDetect;
@property (nonatomic, assign) BOOL canMonitorRegions;
@property(nonatomic, assign) BOOL isLocationPermGranted;
@property (nonatomic, assign) SENTLocationPermission locationPermission;
@property(nonatomic, assign) BOOL isAccelPresent;
@property (nonatomic, assign) BOOL isPreciseLocationAuthorizationGranted;
@property (nonatomic, assign) BOOL isDeviceLowPowerModeEnabled;
@property (nonatomic, assign) BOOL isLocationAvailable;
@property (nonatomic, assign) BOOL isMotionActivityPermissionGranted;
@property(nonatomic, assign) BOOL isGyroPresent;
@property(nonatomic, assign) BOOL isGpsPresent;
@property(nonatomic, assign) SENTQuotaStatus wifiQuotaStatus;
@property(nonatomic, assign) SENTQuotaStatus mobileQuotaStatus;
@property(nonatomic, assign) SENTQuotaStatus diskQuotaStatus;
@property (nonatomic, assign) BOOL userExists;
@property (nonatomic, readonly) SENTDetectionStatus detectionStatus;
@property (nonatomic, assign, readonly) UIBackgroundRefreshStatus backgroundRefreshStatus;
@property(nonatomic, assign) SENTStartStatus startStatus;
- (BOOL) isEqualToSDKStatus: (SENTSDKStatus*) sdkStatus;
  1. Important topics
  2. SDK
  3. API Reference
  4. iOS

SENTSDKStatus

PreviousSENTPublicDefinitionsNextSENTToken
  • SENTSDKInitState
  • SENTQuotaStatus
  • SENTResetFailureReason
  • canDetect
  • canMonitorRegions
  • isRemoteEnabled
  • locationPermission
  • isAccelPresent
  • isPreciseLocationAuthorizationGranted
  • isDeviceLowPowerModeEnabled
  • isLocationAvailable
  • isMotionActivityPermissionGranted
  • isGyroPresent
  • isGpsPresent
  • wifiQuotaStatus
  • mobileQuotaStatus
  • diskQuotaStatus
  • userExists
  • detectionStatus
  • backgroundRefreshStatus
  • startStatus
  • isEqualToSDKStatus
here
SDKStatus

SENTStartStatusNotStarted

SENTStartStatusPending

The enclosing app requested the start of SDK detections, but it could not be completed (e.g. because the user is not enabled on the Sentiance API, permissions are not granted, or location settings are invalid). When the underlying issues are resolved, the detections will start automatically.

SENTStartStatusStarted

SENTStartStatusExpired

SDK detections were not started (i.e. start: was never called), or are stopped (by explicitly calling ).

The SDK detections are successfully started after the enclosing app has called

The SDK start request expired on the date specified when calling . Detections are no longer running.

stop
start:
startWithStopDate