Interface SentianceDrivingInsights

interface SentianceDrivingInsights {
    addDrivingInsightsReadyListener(onDrivingInsightsReady: ((drivingInsights: DrivingInsights) => void)): Promise<EmitterSubscription>;
    getAverageOverallSafetyScore(params: SafetyScoreRequestParameters): Promise<null | number>;
    getCallEvents(transportId: string): Promise<CallEvent[]>;
    getCallWhileMovingEvents(transportId: string): Promise<CallWhileMovingEvent[]>;
    getDrivingInsights(transportId: string): Promise<null | DrivingInsights>;
    getHarshDrivingEvents(transportId: string): Promise<HarshDrivingEvent[]>;
    getPhoneUsageEvents(transportId: string): Promise<PhoneUsageEvent[]>;
    getSpeedingEvents(transportId: string): Promise<SpeedingEvent[]>;
    getWrongWayDrivingEvents(transportId: string): Promise<WrongWayDrivingEvent[]>;
}

Methods

addDrivingInsightsReadyListener getAverageOverallSafetyScore getCallEvents getCallWhileMovingEvents getDrivingInsights getHarshDrivingEvents getPhoneUsageEvents getSpeedingEvents getWrongWayDrivingEvents

Methods

addDrivingInsightsReadyListener

  • addDrivingInsightsReadyListener(onDrivingInsightsReady): Promise<EmitterSubscription>

  • Adds a listener that will be invoked when the driving insights for a completed, non-provisional transport becomes ready.
    See this to learn more about what a provisional event is.

    Parameters

    • onDrivingInsightsReady: ((drivingInsights: DrivingInsights) => void)

      listener to receive the driving insights

        • (drivingInsights): void

        • Parameters

          Returns void

    Returns Promise<EmitterSubscription>

getAverageOverallSafetyScore

  • getAverageOverallSafetyScore(params): Promise<null | number>

  • Returns the average overall safety score for a given set of parameters.

    Parameters

    Returns Promise<null | number>

    the average overall safety score, or null if a score is not available.

    Throws

    Error if any of the inputs provided is invalid.

    Example

    import drivingInsights from "@sentiance-react-native/driving-insights";
    const params = {
       period: 7,
       transportModes: ["CAR", "BUS"],
       occupantRoles: "ALL_ROLES"
    }
    const avgOverallScore = await drivingInsights.getAverageOverallSafetyScore(params);

getCallEvents

  • getCallEvents(transportId): Promise<CallEvent[]>

  • Returns the call events for a completed, non-provisional transport.
    See this to learn more about what a provisional event is.

    Parameters

    • transportId: string

      the id of the desired transport

    Returns Promise<CallEvent[]>

getCallWhileMovingEvents

  • getCallWhileMovingEvents(transportId): Promise<CallWhileMovingEvent[]>

  • Returns the call while moving events for a completed, non-provisional transport.
    See this to learn more about what a provisional event is.

    Parameters

    • transportId: string

      the id of the desired transport

    Returns Promise<CallWhileMovingEvent[]>

    Deprecated

    Use getCallEvents instead.

getDrivingInsights

  • getDrivingInsights(transportId): Promise<null | DrivingInsights>

  • Returns the driving insights for a given non-provisional transport, or null if there are no driving insights, the transport ID is invalid or the transport is a provisional one.
    See this to learn more about what a provisional event is.

    Parameters

    • transportId: string

      the id of the desired transport

    Returns Promise<null | DrivingInsights>

getHarshDrivingEvents

  • getHarshDrivingEvents(transportId): Promise<HarshDrivingEvent[]>

  • Returns the harsh driving events for a completed, non-provisional transport.
    See this to learn more about what a provisional event is.

    Parameters

    • transportId: string

      the id of the desired transport

    Returns Promise<HarshDrivingEvent[]>

getPhoneUsageEvents

  • getPhoneUsageEvents(transportId): Promise<PhoneUsageEvent[]>

  • Returns the phone usage events for a completed, non-provisional transport.
    See this to learn more about what a provisional event is.

    Parameters

    • transportId: string

      the id of the desired transport

    Returns Promise<PhoneUsageEvent[]>

getSpeedingEvents

  • getSpeedingEvents(transportId): Promise<SpeedingEvent[]>

  • Returns the speeding events for a completed, non-provisional transport.
    See this to learn more about what a provisional event is.

    Parameters

    • transportId: string

      the id of the desired transport

    Returns Promise<SpeedingEvent[]>

getWrongWayDrivingEvents

  • getWrongWayDrivingEvents(transportId): Promise<WrongWayDrivingEvent[]>

  • Returns the wrong way driving events for a completed, non-provisional transport.
    See this to learn more about what a provisional event is.

    Parameters

    • transportId: string

      the id of the desired transport

    Returns Promise<WrongWayDrivingEvent[]>

Settings

Member Visibility

On This Page

Methods