Package com.smartcar.sdk

Class Vehicle

java.lang.Object

com.smartcar.sdk.Vehicle

public class Vehicle
extends java.lang.Object

Smartcar Vehicle API Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Vehicle.UnitSystem

Constructor Summary

Constructors

Constructor	Description
Vehicle(java.lang.String vehicleId, java.lang.String accessToken)	Initializes a new Vehicle.
Vehicle(java.lang.String vehicleId, java.lang.String accessToken, SmartcarVehicleOptions options)	Initializes a new Vehicle with provided options

Method Summary

Modifier and Type	Method	Description
VehicleAttributes	attributes()	Send request to the / endpoint
BatchResponse	batch(java.lang.String[] paths)	Send request to the /batch endpoint
VehicleBattery	battery()	Send request to the /battery endpoint
VehicleBatteryCapacity	batteryCapacity()	Send request to the /battery/capacity endpoint
protected <T extends ApiData> T	call(java.lang.String path, java.lang.String method, okhttp3.RequestBody body, java.lang.Class<T> type)
protected <T extends ApiData> T	call(java.lang.String path, java.lang.String method, okhttp3.RequestBody body, java.lang.String accessToken, java.lang.Class<T> type)	Executes an API request under the VehicleIds endpoint.
protected <T extends ApiData> T	call(java.lang.String path, java.lang.String method, okhttp3.RequestBody body, java.util.Map<java.lang.String,java.lang.String> query, java.lang.Class<T> type)
VehicleCharge	charge()	Send request to the /charge endpoint
DisconnectResponse	disconnect()	Send request to the /disconnect endpoint
VehicleEngineOil	engineOil()	Send request to the /engine/oil endpoint
VehicleFuel	fuel()	Send request to the /fuel endpoint
VehicleChargeLimit	getChargeLimit()	Get a vehicle's charge limit
java.lang.String	getFlags()	Gets the flags that are passed to the vehicle object as a serialized string
java.lang.String	getVersion()	Gets the version of Smartcar API that this vehicle is using
VehicleLocation	location()	Send request to the /location endpoint
ActionResponse	lock()	Send request to the /security endpoint to lock a vehicle
VehicleLockStatus	lockStatus()	Send request to the /security endpoint to get the vehicle's lock status
VehicleOdometer	odometer()	Send request to the /odometer endpoint
ApplicationPermissions	permissions()	Send request to the /permissions endpoint
ApplicationPermissions	permissions(RequestPaging paging)	Send request to the /permissions endpoint with paging options set
VehicleResponse	request(SmartcarVehicleRequest vehicleRequest)	General purpose method to make a request to a Smartcar endpoint - can be used to make requests to brand specific endpoints.
ActionResponse	sendDestination(double latitude, double longitude)	Send request to the /navigation/destination endpoint to set the navigation destination
ActionResponse	setChargeLimit(double limit)	Set a vehicle's charge limit
void	setUnitSystem(Vehicle.UnitSystem unitSystem)	Sets the preferred unit system for subsequent API requests.
ActionResponse	startCharge()	Send request to the /charge endpoint to start charging a vehicle
ActionResponse	stopCharge()	Send request to the /charge endpoint to stop charging a vehicle
WebhookSubscription	subscribe(java.lang.String webhookId)	Subscribe vehicle to a webhook
VehicleTirePressure	tirePressure()	Send request to the /tires/pressure endpoint
ActionResponse	unlock()	Send request to the /security endpoint to unlock a vehicle
UnsubscribeResponse	unsubscribe(java.lang.String applicationManagementToken, java.lang.String webhookId)	Unsubscribe vehicle from a webhook
VehicleVin	vin()	Send request to the /vin endpoint

Methods inherited from class java.lang.Object

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

Constructor Detail

Vehicle

public Vehicle(java.lang.String vehicleId,
               java.lang.String accessToken)

Initializes a new Vehicle.

Parameters:

vehicleId - the vehicle ID

accessToken - the OAuth 2.0 access token

Vehicle

public Vehicle(java.lang.String vehicleId,
               java.lang.String accessToken,
               SmartcarVehicleOptions options)

Initializes a new Vehicle with provided options

Parameters:

vehicleId - vehicleId the vehicle ID

accessToken - accessToken the OAuth 2.0 access token

options - optional arguments provided with a SmartcarVehicleOptions instance

Method Detail

getVersion

public java.lang.String getVersion()

Gets the version of Smartcar API that this vehicle is using

Returns:

String representing version

getFlags

public java.lang.String getFlags()

Gets the flags that are passed to the vehicle object as a serialized string

Returns:

serialized string of the flags

call

protected <T extends ApiData> T call(java.lang.String path,
                                     java.lang.String method,
                                     okhttp3.RequestBody body,
                                     java.lang.String accessToken,
                                     java.lang.Class<T> type)
                              throws SmartcarException

Executes an API request under the VehicleIds endpoint.

Parameters:

path - the path to the sub-endpoint

method - the method of the request

body - the body of the request

type - the type into which the response will be parsed

Returns:

the parsed response

Throws:

SmartcarException - if the request is unsuccessful

call

protected <T extends ApiData> T call(java.lang.String path,
                                     java.lang.String method,
                                     okhttp3.RequestBody body,
                                     java.lang.Class<T> type)
                              throws SmartcarException

Throws:

SmartcarException

call

protected <T extends ApiData> T call(java.lang.String path,
                                     java.lang.String method,
                                     okhttp3.RequestBody body,
                                     java.util.Map<java.lang.String,java.lang.String> query,
                                     java.lang.Class<T> type)
                              throws SmartcarException

Throws:

SmartcarException

attributes

public VehicleAttributes attributes()
                             throws SmartcarException

Send request to the / endpoint

Returns:

VehicleInfo object

Throws:

SmartcarException - if the request is unsuccessful

vin

public VehicleVin vin()
               throws SmartcarException

Send request to the /vin endpoint

Returns:

the vin of the vehicle

Throws:

SmartcarException - if the request is unsuccessful

permissions

public ApplicationPermissions permissions()
                                   throws SmartcarException

Send request to the /permissions endpoint

Returns:

the permission of the application

Throws:

SmartcarException - if the request is unsuccessful

permissions

public ApplicationPermissions permissions(RequestPaging paging)
                                   throws SmartcarException

Send request to the /permissions endpoint with paging options set

Parameters:

paging - Request paging options

Returns:

the permissons of the application

Throws:

SmartcarException - if the request is unsuccessful

disconnect

public DisconnectResponse disconnect()
                              throws SmartcarException

Send request to the /disconnect endpoint

Returns:

a response indicating success

Throws:

SmartcarException - if the request is unsuccessful

odometer

public VehicleOdometer odometer()
                         throws SmartcarException

Send request to the /odometer endpoint

Returns:

the odometer of the vehicle

Throws:

SmartcarException - if the request is unsuccessful

fuel

public VehicleFuel fuel()
                 throws SmartcarException

Send request to the /fuel endpoint

Returns:

the fuel status of the vehicle

Throws:

SmartcarException - if the request is unsuccessful

engineOil

public VehicleEngineOil engineOil()
                           throws SmartcarException

Send request to the /engine/oil endpoint

Returns:

the engine oil status of the vehicle

Throws:

SmartcarException - if the request is unsuccessful

tirePressure

public VehicleTirePressure tirePressure()
                                 throws SmartcarException

Send request to the /tires/pressure endpoint

Returns:

the tire pressure status of the vehicle

Throws:

SmartcarException - if the request is unsuccessful

battery

public VehicleBattery battery()
                       throws SmartcarException

Send request to the /battery endpoint

Returns:

the battery status of the vehicle

Throws:

SmartcarException - if the request is unsuccessful

batteryCapacity

public VehicleBatteryCapacity batteryCapacity()
                                       throws SmartcarException

Send request to the /battery/capacity endpoint

Returns:

the battery capacity of the vehicle

Throws:

SmartcarException - if the request is unsuccessful

getChargeLimit

public VehicleChargeLimit getChargeLimit()
                                  throws SmartcarException

Get a vehicle's charge limit

Returns:

the charge limit of the vehicle as a float value between 0 and 1.

Throws:

SmartcarException - if the request is unsuccessful

setChargeLimit

public ActionResponse setChargeLimit(double limit)
                              throws SmartcarException

Set a vehicle's charge limit

Parameters:

limit - the new charge limit to set.

Returns:

a response indicating success

Throws:

SmartcarException - if the request is unsuccessful

charge

public VehicleCharge charge()
                     throws SmartcarException

Send request to the /charge endpoint

Returns:

the charge status of the vehicle

Throws:

SmartcarException - if the request is unsuccessful

location

public VehicleLocation location()
                         throws SmartcarException

Send request to the /location endpoint

Returns:

the location of the vehicle

Throws:

SmartcarException - if the request is unsuccessful

unlock

public ActionResponse unlock()
                      throws SmartcarException

Send request to the /security endpoint to unlock a vehicle

Returns:

a response indicating success

Throws:

SmartcarException - if the request is unsuccessful

lock

public ActionResponse lock()
                    throws SmartcarException

Send request to the /security endpoint to lock a vehicle

Returns:

a response indicating success

Throws:

SmartcarException - if the request is unsuccessful

startCharge

public ActionResponse startCharge()
                           throws SmartcarException

Send request to the /charge endpoint to start charging a vehicle

Returns:

a response indicating success

Throws:

SmartcarException - if the request is unsuccessful

stopCharge

public ActionResponse stopCharge()
                          throws SmartcarException

Send request to the /charge endpoint to stop charging a vehicle

Returns:

a response indicating success

Throws:

SmartcarException - if the request is unsuccessful

lockStatus

public VehicleLockStatus lockStatus()
                             throws SmartcarException

Send request to the /security endpoint to get the vehicle's lock status

Returns:

VehicleLockStatus

Throws:

SmartcarException

sendDestination

public ActionResponse sendDestination(double latitude,
                                      double longitude)
                               throws SmartcarException

Send request to the /navigation/destination endpoint to set the navigation destination

Parameters:

latitude - A double representing the destination's latitude

longitude - A double representing the destination's longitude

Returns:

a response indicating success

Throws:

SmartcarException - if the request is unsuccessful

java.lang.IllegalArgumentException - if the latitude is not between -90.0 and 90.0 or if the longitude is not between -180.0 and 180.0

subscribe

public WebhookSubscription subscribe(java.lang.String webhookId)
                              throws SmartcarException

Subscribe vehicle to a webhook

Returns:

information about the webhook and vehicle subscription

Throws:

SmartcarException - if the request is unsuccessful

unsubscribe

public UnsubscribeResponse unsubscribe(java.lang.String applicationManagementToken,
                                       java.lang.String webhookId)
                                throws SmartcarException

Unsubscribe vehicle from a webhook

Returns:

response indicating successful removal from the subscription

Throws:

SmartcarException - if the request is unsuccessful

batch

public BatchResponse batch(java.lang.String[] paths)
                    throws SmartcarException

Send request to the /batch endpoint

Parameters:

paths - the paths of endpoints to send requests to (ex. "/odometer", "/location", ...)

Returns:

the BatchResponse object containing the response from all the requested endpoints

Throws:

SmartcarException - if the request is unsuccessful

request

public VehicleResponse request(SmartcarVehicleRequest vehicleRequest)
                        throws SmartcarException,
                               java.io.IOException

General purpose method to make a request to a Smartcar endpoint - can be used to make requests to brand specific endpoints.

Parameters:

vehicleRequest - with options for this request. See Smartcar.SmartcarVehicleRequest

Returns:

the VehicleResponse object containing the response from the requested endpoint

Throws:

SmartcarException - if the request is unsuccessful

java.io.IOException

setUnitSystem

public void setUnitSystem(Vehicle.UnitSystem unitSystem)

Sets the preferred unit system for subsequent API requests.

Parameters:

unitSystem - the desired unit system