sdk/com.fairmatic.sdk.classes/FairmaticDriverAttributes

FairmaticDriverAttributes

class FairmaticDriverAttributes(var name: String, var email: String? = null, var phoneNumber: String? = null)

Additional attributes of a Fairmatic driver. The application can specify both predefined and custom attributes for a driver. These attributes are associated with a SDK driverId at SDK initialization time. In addition to predefined special attributes, up to 4 custom key value attributes can be associated with a driver of the Fairmatic SDK. These attributes are available on the Fairmatic dashboard and via the API.

All attribute keys and values can be upto 64 characters in length. Longer keys and values will be truncated to the first 64 characters.

Constructors

FairmaticDriverAttributes

constructor(name: String, email: String? = null, phoneNumber: String? = null)

Properties

var email: String?

var name: String

var phoneNumber: String?

Functions

fun equals(other: FairmaticDriverAttributes): Boolean

Returns true if the specified object is equal to the current object.

getCustomAttribute

fun getCustomAttribute(key: String): String

Returns the specified custom attribute if set or null.

getJsonForUpload

fun getJsonForUpload(): String

Get the json format to upload attributes.

fun getVehicleType(): FairmaticVehicleType?

Returns the vehicle type of the driver if set or null.

setCustomAttribute

fun setCustomAttribute(key: String, value: String)

Set the custom attribute of the driver. Up to 4 custom attributes can be set for a driver.

fun setVehicleType(vehicleType: FairmaticVehicleType)

Set the vehicle type for the driver. To enable the feature for any vehicle type other than FairmaticVehicleType.CAR, please contact us.

fun toJson(): JSONObject

Return the json representation of this object. Null if a json exception occurred.