ZendriveDriverAttributes (Zendrive SDK for Android v5.0.0-b-2)

java.lang.Object
- com.zendrive.sdk.ZendriveDriverAttributes

```
public class ZendriveDriverAttributes
extends java.lang.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.

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()` Default constructor
`ZendriveDriverAttributes(org.json.JSONObject jsonObject)` Construct ZendriveDriverAttributes from JSON.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object o)` Compares this instance with the specified object and indicates if they are equal.
`java.lang.String`	`getCustomAttribute(java.lang.String key)` Returns the specified custome attribute if set or null.
`java.util.Date`	`getDriverStartDate()` Returns the start date of the driver if set or null.
`java.lang.String`	`getEmail()` Returns the email of the driver if set or null.
`java.lang.String`	`getFirstName()` Returns the first name of the driver if set or null.
`java.lang.String`	`getGroup()` Returns the group id of the driver if set or null.
`java.lang.String`	`getJsonForUpload()` Get the json format to upload attributes.
`java.lang.String`	`getLastName()` Returns the last name of the driver if set or null.
`java.lang.String`	`getPhoneNumber()` Returns the phone number of the driver if set or null.
`ZendriveDriverAttributes.ServiceLevel`	`getServiceLevel()`
`int`	`hashCode()` Returns an integer hash code for this object.
`void`	`setCustomAttribute(java.lang.String key, java.lang.String value)` Set the custom attribute of the driver.
`void`	`setDriverStartDate(java.util.Date startDate)` The date which the driver signed up/started using your application.
`void`	`setEmail(java.lang.String email)` Set the email address of the driver.
`void`	`setFirstName(java.lang.String firstName)` Set the first name of the driver.
`void`	`setGroup(java.lang.String groupId)` Set the group id of the driver.
`void`	`setLastName(java.lang.String lastName)` Set the last name of the driver.
`void`	`setPhoneNumber(java.lang.String phoneNumber)` Set the phone number for the driver.
`void`	`setServiceLevel(ZendriveDriverAttributes.ServiceLevel priority)` The service level of a driver.
`org.json.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()
```
    Default constructor
  - ZendriveDriverAttributes
```
public ZendriveDriverAttributes(org.json.JSONObject jsonObject)
                         throws org.json.JSONException
```
    Construct ZendriveDriverAttributes from JSON.
    
    Parameters:
    
    jsonObject - The json object representing ZendriveDriverAttributes.
    
    Throws:
    
    org.json.JSONException - if the json object could not be parsed.
- Method Detail
  - setFirstName
```
public void setFirstName(java.lang.String firstName)
```
    Set the first name of the driver.
    
    Parameters:
    
    firstName - The first name of the driver.
  - setLastName
```
public void setLastName(java.lang.String lastName)
```
    Set the last name of the driver.
    
    Parameters:
    
    lastName - The last name of the driver.
  - setEmail
```
public void setEmail(java.lang.String email)
```
    Set the email address of the driver.
    
    Parameters:
    
    email - The email address of the driver.
  - setGroup
```
public void setGroup(java.lang.String groupId)
```
    Set the group id of the driver.
    
    Parameters:
    
    groupId - The group id of the driver.
  - setPhoneNumber
```
public void setPhoneNumber(java.lang.String phoneNumber)
```
    Set the phone number for the driver.
    
    Parameters:
    
    phoneNumber - The phone number of the driver. The phone number should be of the format <country_code><phone_number>. For example 14255526528, with 1 being the country code for US followed by the number. For India, it would be 918877554466, with 91 being the country code.
    
    Throws:
    
    java.lang.IllegalArgumentException - if phoneNumber is longer than 20 chars or contains non-digit characters.
  - setDriverStartDate
```
public void setDriverStartDate(java.util.Date startDate)
```
    The date which the driver signed up/started using your application.
    
    Parameters:
    
    startDate - The start date 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.
  - getServiceLevel
```
public ZendriveDriverAttributes.ServiceLevel getServiceLevel()
```
  - setCustomAttribute
```
public void setCustomAttribute(java.lang.String key,
                               java.lang.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:
    
    java.lang.IllegalStateException - if max custom attributes (4) are already specified.
  - getFirstName
```
public java.lang.String getFirstName()
```
    Returns the first name of the driver if set or null.
  - getLastName
```
public java.lang.String getLastName()
```
    Returns the last name of the driver if set or null.
  - getEmail
```
public java.lang.String getEmail()
```
    Returns the email of the driver if set or null.
  - getGroup
```
public java.lang.String getGroup()
```
    Returns the group id of the driver if set or null.
  - getPhoneNumber
```
public java.lang.String getPhoneNumber()
```
    Returns the phone number of the driver if set or null.
  - getDriverStartDate
```
public java.util.Date getDriverStartDate()
```
    Returns the start date of the driver if set or null.
  - getCustomAttribute
```
public java.lang.String getCustomAttribute(java.lang.String key)
```
    Returns the specified custome attribute if set or null.
  - getJsonForUpload
```
public java.lang.String getJsonForUpload()
```
    Get the json format to upload attributes.
  - toJson
```
public org.json.JSONObject toJson()
```
    Return the json representation of this object. Null if a json exception occured.
    
    Returns:
    
    the json representation of this object. Null if a json exception occured.
  - equals
```
public boolean equals(java.lang.Object o)
```
    Description copied from class: java.lang.Object
    
    Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than null is equal to null.
    The default implementation returns true only if this == o. See Writing a correct equals method if you intend implementing your own equals method.
    The general contract for the equals and Object.hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or neither of them.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    o - the object to compare this instance with.
    
    Returns:
    
    true if the specified object is equal to this Object; false otherwise.
    
    See Also:
    
    Object.hashCode()
  - hashCode
```
public int hashCode()
```
    Description copied from class: java.lang.Object
    
    Returns an integer hash code for this object. By contract, any two objects for which Object.equals(java.lang.Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.
    Note that hash values must not change over time unless information used in equals comparisons also changes.
    See Writing a correct hashCode method if you intend implementing your own hashCode method.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    this object's hash code.
    
    See Also:
    
    Object.equals(java.lang.Object)

Class ZendriveDriverAttributes

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ZendriveDriverAttributes

ZendriveDriverAttributes

Method Detail

setFirstName

setLastName

setEmail

setGroup

setPhoneNumber

setDriverStartDate

setServiceLevel

getServiceLevel

setCustomAttribute

getFirstName

getLastName

getEmail

getGroup

getPhoneNumber

getDriverStartDate

getCustomAttribute

getJsonForUpload

toJson

equals

hashCode