Trip tag for Android app

Setting up


Methods

Add trip tag

/**
 * Add track tags. Return tags successfully added (with tag and type only, without source).
 *
 * @param trackId  Track id.
 * @throws IllegalStateException if [initialize] never called. See also [isInitialized].
 */ 
fun addTrackTags(trackId: String, tags: Array<TrackTag>): Array<TrackTag>

Remove trip tag

/**
 * Remove track tags. Return tags successfully removed (with tag and type only, without source).
 *
 * @param trackId  Track id.
 * @throws IllegalStateException if [initialize] never called. See also [isInitialized].
 */
fun removeTrackTags(trackId: String, tags: Array<TrackTag>): Array<TrackTag>

Get trip tags

/**
 * Returns track tags.
 *
 * @param trackId  Track id.
 * @throws IllegalStateException if [initialize] never called. See also [isInitialized].
 */
fun getTrackTags(trackId: String): Array<TrackTag>

Tag model

package com.raxeltelematics.v2.sdk.server.model.sdk

class TrackTag(
    /**
     * Tag name.
     */
    var tag: String,
    /**
     * Source. For ex. App module (optional)
     */
    var source: String? = null
) {

    /**
     * Source type. Maybe: "Sdk", "UserApp".
     * ONLY internal set. Readonly for public
     */
    var type: String? = null
        internal set(value) {
            field = value
        }
}

Did this page help you?