com.here.mobility.sdk.demand

Class Ride

java.lang.Object

com.here.mobility.sdk.demand.Ride

All Implemented Interfaces:

Parcelable

public abstract class Ride
extends Object
implements Parcelable

Active Ride.

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
Ride()

Method Summary

Modifier and Type	Method and Description
static Ride	create(String userId, String rideId, RideWaypoints route, Long requestedPickupTime, PriceEstimate bookingEstimatedPrice, BookingConstraints constraints, RideStatusLog statusLog, Supplier supplier, PassengerDetails passenger, String passengerNote, DriverDetails driver, Vehicle vehicle, CancellationPolicy cancellationPolicy, CancellationInfo cancellationInfo, Price price, LatLng confirmedPickupPoint, PaymentFlow paymentFlow) Create a new Ride object.
abstract PriceEstimate	getBookingEstimatedPrice() The price estimate, as was determined by booking time (will not be updated during the ride).
abstract CancellationInfo	getCancellationInfo() If the ride was cancelled, contains info about the cancellation.
abstract CancellationPolicy	getCancellationPolicy() The cancellation policy.
abstract LatLng	getConfirmedPickupPoint() Deprecated. This field is deprecated, please use getRoute().getPickup().getLocation() instead
abstract BookingConstraints	getConstraints() The constraints of the booking (e.g.
abstract DriverDetails	getDriver() The details of the driver.
abstract PassengerDetails	getPassenger() The details of the passenger that is the contact for this ride.
abstract String	getPassengerNote() An optional custom note from the passenger to the supplier.
abstract PaymentFlow	getPaymentFlow() The payment flow for a specific ride.
abstract Long	getPrebookPickupTime() The requested pickup time in milliseconds since Epoch.
abstract Price	getPrice() Optional.
abstract String	getRideId() Ride ID, to be sent to the server.
abstract RideWaypoints	getRoute() The route of the ride.
abstract RideStatusLog	getStatusLog() The status log of the ride (current status and previous statuses).
abstract Supplier	getSupplier() The ride supplier.
abstract String	getUserId() ID of the user who ordered the ride.
abstract Vehicle	getVehicle() The vehicle.

Methods inherited from class java.lang.Object

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

Methods inherited from interface android.os.Parcelable

describeContents, writeToParcel

Constructor Detail

Ride

public Ride()

Method Detail

getUserId

public abstract String getUserId()

ID of the user who ordered the ride.

getRideId

public abstract String getRideId()

Ride ID, to be sent to the server.

getRoute

public abstract RideWaypoints getRoute()

The route of the ride.

getPrebookPickupTime

public abstract Long getPrebookPickupTime()

The requested pickup time in milliseconds since Epoch. Exists only for pre-booked rides, and is equals to the value given in RideOffersRequest.Builder.setPrebookPickupTime(Long)

getBookingEstimatedPrice

public abstract PriceEstimate getBookingEstimatedPrice()

The price estimate, as was determined by booking time (will not be updated during the ride).

getConstraints

public abstract BookingConstraints getConstraints()

The constraints of the booking (e.g. passenger count, suitcase count...)

getStatusLog

public abstract RideStatusLog getStatusLog()

The status log of the ride (current status and previous statuses).

getSupplier

public abstract Supplier getSupplier()

The ride supplier.

getPassenger

public abstract PassengerDetails getPassenger()

The details of the passenger that is the contact for this ride.

getPassengerNote

public abstract String getPassengerNote()

An optional custom note from the passenger to the supplier.

getDriver

public abstract DriverDetails getDriver()

The details of the driver. Returns null if no driver was assigned.

getVehicle

public abstract Vehicle getVehicle()

The vehicle. Returns null if no vehicle was assigned, or no vehicle info was supplied.

getCancellationPolicy

public abstract CancellationPolicy getCancellationPolicy()

The cancellation policy.

getCancellationInfo

public abstract CancellationInfo getCancellationInfo()

If the ride was cancelled, contains info about the cancellation. Otherwise returns null.

getPrice

public abstract Price getPrice()

Optional. The final price of the ride as updated by the supplier. This may be updated around the time of the ride's end, when the ride's duration and final price can be known.

getConfirmedPickupPoint

@Deprecated
public abstract LatLng getConfirmedPickupPoint()

Deprecated. This field is deprecated, please use getRoute().getPickup().getLocation() instead

The actual point where the driver will arrive to pick up the passenger. This may be adjusted slightly in relation to the address that the passenger entered, to ensure that the vehicle can access this location. Display Ride.getConfirmedPickupPoint() rather than the user-defined address, because the confirmed pickup point is where the driver will arrive.

getPaymentFlow

public abstract PaymentFlow getPaymentFlow()

The payment flow for a specific ride.

create

public static Ride create(String userId,
                          String rideId,
                          RideWaypoints route,
                          Long requestedPickupTime,
                          PriceEstimate bookingEstimatedPrice,
                          BookingConstraints constraints,
                          RideStatusLog statusLog,
                          Supplier supplier,
                          PassengerDetails passenger,
                          String passengerNote,
                          DriverDetails driver,
                          Vehicle vehicle,
                          CancellationPolicy cancellationPolicy,
                          CancellationInfo cancellationInfo,
                          Price price,
                          LatLng confirmedPickupPoint,
                          PaymentFlow paymentFlow)

Create a new Ride object.