Sentiance Insights-Control-Tower Legacy Docs

React Native

[6.7.1] - 22 Apr 2024

Breaking

  • Fixed type nonconformity of the UserContext Segment attributes on iOS. Attributes are now returned as an array of attribute objects, instead of a dictionary, in accordance with the type definition.

[6.7.0] - 5 Apr 2024

Added

  • A new API method for controlling whether the SDK is allowed to use mobile data for uploading/downloading configuration and detection data.

  • Support for isLocationAvailable SDK status property for iOS.

Changed

[6.6.0] - 5 Jan 2024

Added

  • A new event-timeline package, which can be use to query for historic transport and stationary events detected directly on the device, in addition to subscribing for real-time event updates. See the how-to guide here. The event timeline generation is part of Sentiance's on-device features, which must be enabled by Sentiance before use.

Changed

  • Updated the Sentiance Android SDK dependency to version 6.6.

  • Updated the Sentiance iOS SDK dependency to version 6.6.

[6.5.1] - 13 Oct 2023

Added

  • Call-while-moving safety score, which is computed using phone calls that are detected during vehicular transports. Corresponding call-while-moving events can be retrieved via the Driving Insights API.

  • Legal driving safety score, which is computed using the traveled speed information during vehicular transports, in addition to the use of speed limit information that is downloaded and stored offline by the SDK. Corresponding speeding events can be retrieved via the Driving Insights API.

  • Overall safety score, which is computed using the other safe driving scores.

Changed

  • Updated the Sentiance Android SDK dependency to version 6.5. This version adds support for targeting Android 14. Have a look at the corresponding Android changelog for important app-impacting changes.

  • Updated the Sentiance iOS SDK dependency to version 6.5.

[6.4.0] - 10 Jul 2023

Production Readiness Update

In this release, the following features have been promoted from Early Access to Production Ready:

  • Transport classification

  • Home & work detection

  • User segment detection

  • User's current context information

See our On-Device Features page for more information about these features. Detailed overview of feature production readiness can be found on this page.

This version includes breaking changes for some Early Access features.

Breaking

  • HarshDrivingEvent now provides separate start and end dates, instead of a single event date.

Added

  • Phone usage detection during vehicular transports. This feature is part of the on-device Driving Insights feature. It uses a custom machine learning model to accurately detect phone usages. The detected events can be obtained using the getPhoneUsageEvents.

  • Focused driving safety score, which is calculated by taking into account the detected phone usage events during vehicular transports. See here.

Changed

  • Updated the Sentiance Android SDK dependency to version 6.4.

  • Updated the Sentiance iOS SDK dependency to version 6.4.

  • The iOS Podspec path is now '../node_modules/@sentiance-react-native/core'. Please update your Podfile if necessary.

Fixed

  • Multiple compatibility issues with React Native 0.65+.

  • Autolinking for iOS projects. With this fix, you no longer need to manually specify the iOS pod dependency in your Podfile.

[6.3.1] - 7 Apr 2023

Added

  • A new Driving Insights feature, which provides information about a user's driving behaviour. In this first version, the SDK detects harsh driving events (e.g. acceleration, braking, and turning), which are then used to compute a vehicular transport's smooth driving score. This data is available via the new DrivingInsights package, which allows the subscription to, and retrieval of DrivingInsights and HarshDrivingEvents. This feature must be enabled by Sentiance before use.

  • A short history of locations inside CrashEvent, which represent the preceding locations leading up to the crash event.

Changed

  • Updated the Sentiance Android SDK dependency to version 6.3.

  • Updated the Sentiance iOS SDK dependency to version 6.3.

Removed

  • BREAKING: a number of user segments that are no longer supported.

[6.2.3] - 1 Feb 2023

Changed

  • Updated the target Sentiance Android SDK version from 6.2.0 to 6.2.+.

[6.2.0] - 9 Jan 2023

This version includes breaking changes for some Early Access features.

Added

  • Transport waypoint and distance information to TransportEvent, which is part of the event list returned in UserContext. Both waypoints and distance are based on unprocessed (i.e. raw) location data.

  • Venue information inside StationaryEvent, which is part of the events list returned in UserContext.

  • Venue significance and venue type information inside the Venue type.

  • Semantic time information inside to UserContext type.

Changed

  • BREAKING: startTimeEpoch and endTimeEpoch properties of objects returned part of the UserContext are now of type 'numeric', instead of 'string', and represent the Unix epoch time in milliseconds.

  • BREAKING: longitude, latitude and accuracy properties of an EventLocation object returned part of the UserContext are now of type 'numeric', instead of 'string'.

  • BREAKING: the EventLocation type of the UserContext has been renamed into GeoLocation.

  • Corrected the misspelled BICYCLE TransportMode type in the user context type definition file.

  • Updated the Sentiance Android SDK dependency to version 6.2.

  • Updated the Sentiance iOS SDK dependency to version 6.2.

  • Updated the isBatterySavingEnabled and isActivityRecognitionPermGranted fields of the SdkStatus to cover iOS as well. (previously Android only)

Removed

  • BREAKING: the venueSignificance and venueCandidates properties from the UserContext type have been removed. VenueCandidate and Visit classes have also been removed.

  • BREAKING: venue name and labels properties are removed from Venue.

[6.1.2] - 3 Nov 2022

Fixed

  • Typescript definition for UserCreationOptions in the core package.

  • npm i installing an older beta package instead of latest stable, when no version is specified.

[6.1.1] - 30 Sep 2022

This version includes breaking changes for some Early Access features.

Added

  • Diagnostic API for monitoring vehicle crash detection. See here.

  • App-configurable rules to control SDK data transmission to the Sentiance Cloud Platform. The app can specify which of the following data types are allowed to be transmitted to the Sentiance platform: vehicle crash data, SDK and device info, general detection data, all data. See here.

  • Support for car, bus, train, and tram/metro transport mode detection, part of the user's current context information.

Changed

  • Updated the Sentiance Android SDK dependency to version 6.1.

  • Updated the Sentiance iOS SDK dependency to version 6.1.

Removed

  • BREAKING: vehicle and rail transport modes from the user's current context information

[6.0.3] - 30 Aug 2022

Fixed

  • The module names in the type definition files.

  • Starting and stopping a trip on iOS via the core package.

[6.0.2] - 16 Aug 2022

Changed

  • Relax the target Sentiance SDK versions, to include patches.

[6.0.1] - 1 Aug 2022

Breaking Changes

Version 6.0 is a major release and includes multiple deprecations and breaking changes. Please read our migration guide to learn how to update to this version.

Given the significance of the changes in this version, we recommend testing your app carefully, before making it available to your wider audience.

Added

  • A function to check if a user exists on the device or not.

  • Detection enabling and disabling functions that are persistent across app restarts, and that replace the SDK's start and stop functions.

  • userExists and isUserLinked functions that are accessible without having to initialize the SDK.

  • setAppSessionDataCollectionEnabled(enabled)

  • isAppSessionDataCollectionEnabled()

  • A Sentiance user creation function that supports the existing user-linking flow, and a new authentication-code based flow. The new flow is the recommended approach for future integrations.

  • A linkUser function that supports linking a user following the existing user-linking flow.

  • A linkUserWithAuthCode function that supports linking a user following the new authentication-code flow.

  • An addSdkStatusUpdateListener function that supports registering listeners to get notified of SDK status updates without having to manually register a listener to the corresponding native device event.

  • An addTripTimeoutListener function that supports registering listeners to get notified of SDK trip timeouts without having to manually register a listener to the corresponding native device event.

  • An addSdkUserActivityUpdateListener function that supports registering listeners to get notified of SDK user activity updates without having to manually register a listener to the corresponding native device event.

  • An addVehicleCrashEventListener function that supports registering listeners to get notified of SDK vehicle crash events without having to manually register a listener to the corresponding native device event.

  • User Context information, which can be requested or subscribed for, and which includes a user's recent timeline events, the home and work locations (if detected), and a user's segments (if detected). This feature is released as Early Access and must be enabled by Sentiance first. For more information about it, see our On-Device Features page.

Changed

  • Renamed getUserAccessToken to requestUserAccessToken

  • Changed the return type of the reset function from boolean to ResetResult

  • Changed the return type of addUserMetadataField, addUserMetadataFields, removeUserMetadataField, disableBatteryOptimization , listenUserActivityUpdates , startTrip, stopTrip, submitDetections, updateSdkNotification from Promise<boolean> to Promise<void>.

  • Moved the listenVehicleCrashEvents, invokeDummyVehicleCrash, isVehicleCrashDetectionSupported functions to a separate crash-detection module.

  • Bumped the target Android Sentiance SDK version to 6.0

  • Bumped the target iOS Sentiance SDK version to 6.0

Deprecated

  • init(appId, secret, baseURL, shouldStart)

  • initWithUserLinkingEnabled(appId, secret, baseURL, shouldStart)

  • start()

  • startWithStopDate(stopEpochTimeMs)

  • stop()

  • isNativeInitializationEnabled()

  • enableNativeInitialization()

  • disableNativeInitialization()

  • isThirdPartyLinked()

  • getValueForKey(key, defaultValue)

  • setValueForKey(key, value)

  • userLinkCallback(success)

  • listenUserActivityUpdates()

  • listenTripTimeout()

PreviousiOSNextAuthentication and Authorization

Last updated