com.zendrive.sdk

Class ZendriveDriverAttributes

java.lang.Object

com.zendrive.sdk.ZendriveDriverAttributes

public class ZendriveDriverAttributes
extends Object

Additional attributes of a Zendrive 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 Zendrive SDK. These attributes are available on the Zendrive 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ZendriveDriverAttributes.ServiceLevel Enumeration for different service levels supported by Zendrive for a driver.

Constructor Summary

Constructors

Constructor and Description
ZendriveDriverAttributes()
ZendriveDriverAttributes(JSONObject jsonObject) Construct ZendriveDriverAttributes from JSON.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getAlias() Returns the alias of the driver if set or null.
String	getCustomAttribute(String key) Returns the specified custom attribute if set or null.
String	getGroup() Returns the group id of the driver if set or null.
String	getJsonForUpload() Get the json format to upload attributes.
ZendriveDriverAttributes.ServiceLevel	getServiceLevel()
ZendriveVehicleType	getVehicleType() Returns the vehicle type of the driver if set or null.
int	hashCode()
void	setAlias(String alias) Set an alias for the driver.
void	setCustomAttribute(String key, String value) Set the custom attribute of the driver.
void	setGroup(String groupId) Set the group id of the driver.
void	setServiceLevel(ZendriveDriverAttributes.ServiceLevel priority) The service level of a driver.
void	setVehicleType(ZendriveVehicleType vehicleType) Set the vehicle type for the driver.
JSONObject	toJson() Return the json representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ZendriveDriverAttributes

public ZendriveDriverAttributes()

ZendriveDriverAttributes

public ZendriveDriverAttributes(JSONObject jsonObject)
                         throws JSONException

Construct ZendriveDriverAttributes from JSON.

Parameters:

jsonObject - The json object representing ZendriveDriverAttributes.

Throws:

JSONException - if the json object could not be parsed.

Method Detail

setAlias

public void setAlias(String alias)

Set an alias for the driver. Alias is a string placeholder offered as a convenience for developers to create a reference for a driver.

Parameters:

alias - The alias for the driver.

setGroup

public void setGroup(String groupId)

Set the group id of the driver.

Parameters:

groupId - The group id of the driver.

setServiceLevel

public void setServiceLevel(ZendriveDriverAttributes.ServiceLevel priority)

The service level of a driver. This is useful for applications where Zendrive supports different service levels for different drivers. See ZendriveDriverAttributes.ServiceLevel for more information about this attribute.

setVehicleType

public void setVehicleType(ZendriveVehicleType vehicleType)

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

Parameters:

vehicleType - The vehicle type for the driver.

getServiceLevel

public ZendriveDriverAttributes.ServiceLevel getServiceLevel()

setCustomAttribute

public void setCustomAttribute(String key,
                               String value)

Set the custom attribute of the driver.

Up to 4 custom attributes can be set for a driver.

Parameters:

key - A key for the custom attribute.

value - Value of the custom attribute.

Throws:

IllegalStateException - if max custom attributes (4) are already specified.

getAlias

public String getAlias()

Returns the alias of the driver if set or null.

getGroup

public String getGroup()

Returns the group id of the driver if set or null.

getVehicleType

@Nullable
public ZendriveVehicleType getVehicleType()

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

getCustomAttribute

public String getCustomAttribute(String key)

Returns the specified custom attribute if set or null.

getJsonForUpload

public String getJsonForUpload()

Get the json format to upload attributes.

toJson

public JSONObject toJson()

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

Returns:

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object