com.here.mobility.sdk.demand

Class RideOffersRequest

java.lang.Object

com.here.mobility.sdk.demand.RideOffersRequest

All Implemented Interfaces:

Parcelable

public abstract class RideOffersRequest
extends Object
implements Parcelable

Request from the SDK to the server for ride offers.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RideOffersRequest.Builder Builder to create RideOffersRequest object.
static class	RideOffersRequest.SortType How to sort the offers

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
RideOffersRequest()

Method Summary

Modifier and Type	Method and Description
static RideOffersRequest.Builder	builder() Builder to create RideOffersRequest object.
abstract BookingConstraints	getConstraints() Conditions that the supplier must accommodate, such as number of passengers, wheelchair access, etc.
abstract String	getLocale() The locale to use for the RideOffer.
abstract Integer	getMaxNumberOfOffers() Optional Maximum number of offers to be returned
abstract String	getPassengerNote() Optional note from the passenger.
abstract PaymentTypeFilter	getPaymentTypeFilter() Optional payment Type filter.
abstract Long	getPrebookPickupTime() Optional pre-booked pickup time, if the ride is requested for more than 30 minutes in the future.
abstract PriceRange	getPriceRange() Optional price range acceptable to the passenger.
abstract RideWaypoints	getRideWaypoints() The requested route.
abstract RideOffersRequest.SortType	getSortType() Optional sort type.
abstract TransitOptions	getTransitOptions() Optional Transit options.
abstract Collection<RideOffer.TransitType>	getTransportTypeFilter() Optional Transport type Filter.

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

RideOffersRequest

public RideOffersRequest()

Method Detail

builder

public static RideOffersRequest.Builder builder()

Builder to create RideOffersRequest object.

getRideWaypoints

public abstract RideWaypoints getRideWaypoints()

The requested route.

getConstraints

public abstract BookingConstraints getConstraints()

Conditions that the supplier must accommodate, such as number of passengers, wheelchair access, etc.

getPrebookPickupTime

public abstract Long getPrebookPickupTime()

Optional pre-booked pickup time, if the ride is requested for more than 30 minutes in the future. The time is given in milliseconds since Epoch.

getPriceRange

public abstract PriceRange getPriceRange()

Optional price range acceptable to the passenger.

getSortType

public abstract RideOffersRequest.SortType getSortType()

Optional sort type. If not given, the order is by price, and then by ETA.

getPassengerNote

public abstract String getPassengerNote()

Optional note from the passenger.

getTransitOptions

public abstract TransitOptions getTransitOptions()

Optional Transit options. This will affect the public transport offers.

getLocale

public abstract String getLocale()

The locale to use for the RideOffer. Indicates the language of passenger. Will be used to determine language of addresses and SMSs sent to demander. Complies with the ISO 639-1 standard and defaults to MobilitySdk#getUserPreferences()#getLocale().

Returns:

the locale

getTransportTypeFilter

public abstract Collection<RideOffer.TransitType> getTransportTypeFilter()

Optional Transport type Filter. Sets which transport types offers will be returned If set to null it's the same as not being set, i.e. get all Transport type

getMaxNumberOfOffers

public abstract Integer getMaxNumberOfOffers()

Optional Maximum number of offers to be returned

getPaymentTypeFilter

public abstract PaymentTypeFilter getPaymentTypeFilter()

Optional payment Type filter. Sets offers supporting these types of payments If set to null, it's the same as not being set, i.e. get only offline payments