Automatic Detections with Forced Trips

While in automatic detection mode, the SDK can be forced to start a trip. Doing so will prevent the SDK from detecting stationary moments and force it to continue collecting trip data until the trip is explicitly stopped.

Once the forced trip is stopped, the SDK will resume automatic detections.

Starting a Trip

You can start a trip as follows:

iOS

Sentiance.shared.startTrip(metadata: metadata, transportModeHint: hint) { result, error in
}

The metadata is an NSDictionary representing a map of string to string types. You can use it to attach any piece of information to this trip. The transportModeHint is a hint you can give the SDK about the type of transport the trip is (e.g. car, bicycle, etc.).

In case starting a trip fails, you can check the error to determine the reason.

Android

sentiance.startTrip(metadata, transportModeHint)
    .addOnSuccessListener { startTripResult -> 
        // The trip was successfully started.
    }
    .addOnFailureListener { startTripError ->
        // Something prevented the trip to start.
        // Check the status object for more details.
    }

The metadata is a map of string to string types. You can use it to attach any piece of information to this trip. The transportModeHint is a hint of type TransportMode you can give the SDK about the type of transport the trip is (e.g. car, bicycle, etc.).

You can add an OnSuccessListener and OnFailureListener to the returned PendingOperation, you will be notified when a trip is successfully started. If it fails, you can check the StartTripError object to determine the reason.

Stopping a Trip

To stop a trip that you've started, call stopTrip as follows:

iOS

Sentiance.shared.stopTrip { result, error in
}

If stopping the trip fails, you can check the error to determine why. To check if a trip is ongoing before calling stopTrip, see this guide.

Android

sentiance.stopTrip()
    .addOnSuccessListener { stopTripResult -> }
    .addOnFailureListener { stopTripError -> }

You can add an OnSuccessListener and OnFailureListener to the returned PendingOperation, you will be notified when a trip is successfully started. If it fails, you can check the StopTripError object to determine the reason.

To check if a trip is ongoing before calling stopTrip(), see this guide.