Custom metadata

If your use case requires it, it is possible to add your own data in the trip analysis request. For example, it can be data that is specific to your trip, application or user identification system.

Metadata is persisted, so if you want to send it only for one trip, you need to remove it at the end of the trip, on the sdkStateChanged(state: State)callback, by checking if state is inactive.

Set metadata

You can add additional metadata to your trip by calling the following method:

let metadata: [String: String] = [
    "key": "value"
]
DriveKitTripAnalysis.shared.setTripMetadata(metadata)

The metadata must be represented as a key/value object where the key and value have a String type.

The metadata can be set any time before the end of a trip.

If metadata is sent, it will also be added to the push data request in the metaData field.

Get metadata

It is possible to get a copy of configured metadata thanks to the following method on DriveKitTripAnalysis:

DriveKitTripAnalysis.shared.getTripMetadata()

Note: Any modification on the returned object has no effect on the metadata sent with a trip.

Update metadata

To update a value in metadata, call the following method:

DriveKitTripAnalysis.shared.updateTripMetadata(key: String, value: String?)

Delete a specific metadata

To delete a specific value in metadata, call the following method:

DriveKitTripAnalysis.shared.deleteTripMetadata(key: String)

Delete all metadata

To delete all values in metadata, call this method:

DriveKitTripAnalysis.shared.deleteTripMetadata()