react-native-here-mobility-sdk
Version:
Offical Here Mobility SDK for react native to access Here's marketplace features
2,114 lines (928 loc) • 112 kB
HTML
<!doctype html>
<html>
<head>
<meta charset='utf-8' />
<title>react-native-here-mobility-sdk 1.0.7 | Documentation</title>
<meta name='viewport' content='width=device-width,initial-scale=1'>
<link href='assets/bass.css' type='text/css' rel='stylesheet' />
<link href='assets/style.css' type='text/css' rel='stylesheet' />
<link href='assets/github.css' type='text/css' rel='stylesheet' />
<link href='assets/split.css' type='text/css' rel='stylesheet' />
<meta name='description' content='Offical Here Mobility SDK for react native to access Here's marketplace features'>
</head>
<body class='documentation m0'>
<div class='flex'>
<div id='split-left' class='overflow-auto fs0 height-viewport-100'>
<div class='py1 px2'>
<h3 class='mb0 no-anchor'>react-native-here-mobility-sdk</h3>
<div class='mb1'><code>1.0.7</code></div>
<input
placeholder='Filter'
id='filter-input'
class='col12 block input'
type='text' />
<div id='toc'>
<ul class='list-reset h5 py1-ul'>
<li><a
href='#heremobilitysdk'
class=" toggle-sibling">
HereMobilitySDK
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Static members</span></li>
<li><a
href='#heremobilitysdksetuser'
class='regular pre-open'>
.setUser
</a></li>
<li><a
href='#heremobilitysdkgetuser'
class='regular pre-open'>
.getUser
</a></li>
<li><a
href='#heremobilitysdkgetloggingid'
class='regular pre-open'>
.getLoggingId
</a></li>
</ul>
</div>
</li>
<li><a
href='#heremobilitysdkdemand'
class=" toggle-sibling">
HereMobilitySDKDemand
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Static members</span></li>
<li><a
href='#heremobilitysdkdemandgetrideoffers'
class='regular pre-open'>
.getRideOffers
</a></li>
<li><a
href='#heremobilitysdkdemandcreateride'
class='regular pre-open'>
.createRide
</a></li>
<li><a
href='#heremobilitysdkdemandgetride'
class='regular pre-open'>
.getRide
</a></li>
<li><a
href='#heremobilitysdkdemandcancelride'
class='regular pre-open'>
.cancelRide
</a></li>
<li><a
href='#heremobilitysdkdemandgetrides'
class='regular pre-open'>
.getRides
</a></li>
<li><a
href='#heremobilitysdkdemandregisterforridesupdates'
class='regular pre-open'>
.registerForRidesUpdates
</a></li>
<li><a
href='#heremobilitysdkdemandunregisterfromridesupdates'
class='regular pre-open'>
.unregisterFromRidesUpdates
</a></li>
</ul>
</div>
</li>
<li><a
href='#latlng'
class="">
LatLng
</a>
</li>
<li><a
href='#address'
class="">
Address
</a>
</li>
<li><a
href='#waypoint'
class="">
Waypoint
</a>
</li>
<li><a
href='#ridewaypoints'
class="">
RideWaypoints
</a>
</li>
<li><a
href='#pricerange'
class="">
PriceRange
</a>
</li>
<li><a
href='#transitoptions'
class="">
TransitOptions
</a>
</li>
<li><a
href='#bookingconstraints'
class="">
BookingConstraints
</a>
</li>
<li><a
href='#rideofferrequestsorttype'
class="">
RideOfferRequestSortType
</a>
</li>
<li><a
href='#rideoffersrequest'
class="">
RideOffersRequest
</a>
</li>
<li><a
href='#transittype'
class="">
TransitType
</a>
</li>
<li><a
href='#price'
class="">
Price
</a>
</li>
<li><a
href='#priceestimate'
class="">
PriceEstimate
</a>
</li>
<li><a
href='#cancellationpolicy'
class="">
CancellationPolicy
</a>
</li>
<li><a
href='#supplier'
class="">
Supplier
</a>
</li>
<li><a
href='#heremobilitydemanderror'
class="">
HereMobilityDemandError
</a>
</li>
<li><a
href='#ridepreferences'
class="">
RidePreferences
</a>
</li>
<li><a
href='#driverdetails'
class="">
DriverDetails
</a>
</li>
<li><a
href='#vehicletype'
class="">
VehicleType
</a>
</li>
<li><a
href='#vehicle'
class="">
Vehicle
</a>
</li>
<li><a
href='#ridestatus'
class="">
RideStatus
</a>
</li>
<li><a
href='#ridestatuslog'
class="">
RideStatusLog
</a>
</li>
<li><a
href='#riderecord'
class="">
RideRecord
</a>
</li>
<li><a
href='#ridelocation'
class="">
RideLocation
</a>
</li>
<li><a
href='#passengerdetails'
class="">
PassengerDetails
</a>
</li>
<li><a
href='#cancellingparty'
class="">
CancellingParty
</a>
</li>
<li><a
href='#cancellationstatus'
class="">
CancellationStatus
</a>
</li>
<li><a
href='#cancellationinfo'
class="">
CancellationInfo
</a>
</li>
<li><a
href='#ride'
class="">
Ride
</a>
</li>
<li><a
href='#statusfilter'
class="">
StatusFilter
</a>
</li>
<li><a
href='#ridequerysorttype'
class="">
RideQuerySortType
</a>
</li>
<li><a
href='#ridequery'
class="">
RideQuery
</a>
</li>
<li><a
href='#ridequeryresponse'
class="">
RideQueryResponse
</a>
</li>
<li><a
href='#rideofferbase'
class="">
RideOfferBase
</a>
</li>
<li><a
href='#taxirideoffer'
class="">
TaxiRideOffer
</a>
</li>
<li><a
href='#publictransportrideoffer'
class="">
PublicTransportRideOffer
</a>
</li>
<li><a
href='#transportmode'
class="">
TransportMode
</a>
</li>
<li><a
href='#publictransportrouteleg'
class="">
PublicTransportRouteLeg
</a>
</li>
<li><a
href='#rideoffers'
class=" toggle-sibling">
RideOffers
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#rideoffersall'
class='regular pre-open'>
#all
</a></li>
<li><a
href='#rideofferstaxioffers'
class='regular pre-open'>
#taxiOffers
</a></li>
<li><a
href='#rideofferspublictransportoffers'
class='regular pre-open'>
#publicTransportOffers
</a></li>
</ul>
</div>
</li>
<li><a
href='#user'
class="">
User
</a>
</li>
</ul>
</div>
<div class='mt1 h6 quiet'>
<a href='http://documentation.js.org/reading-documentation.html'>Need help reading this?</a>
</div>
</div>
</div>
<div id='split-right' class='relative overflow-auto height-viewport-100'>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='heremobilitysdk'>
HereMobilitySDK
</h3>
</div>
<p>HereMobilitySDK is the client wrapper for accessing the HereSDKManager API.</p>
<div class='pre p1 fill-light mt0'>new HereMobilitySDK()</div>
<div class='py1 quiet mt1 prose-big'>Static Members</div>
<div class="clearfix">
<div class='border-bottom' id='heremobilitysdksetuser'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>setUser(user)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Sets the current user of the SDK (creates a HereSDKUser instance). To unregister the user, call setUser with a null parameter.</p>
<div class='pre p1 fill-light mt0'>setUser(user: <a href="#user">User</a>)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>user</span> <code class='quiet'>(<a href="#user">User</a>)</code>
The unique ID of the user.
</div>
</div>
</div>
</section>
</div>
</div>
<div class='border-bottom' id='heremobilitysdkgetuser'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>getUser(callback)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Gets the HereSDKUser instance of the user currently logged in.</p>
<div class='pre p1 fill-light mt0'>getUser(callback: function (user: <a href="#user">User</a>?): void)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>callback</span> <code class='quiet'>(function (user: <a href="#user">User</a>?): void)</code>
A callback function which will be called with the current user, or nil if no user is registered.
</div>
</div>
</div>
</section>
</div>
</div>
<div class='border-bottom' id='heremobilitysdkgetloggingid'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>getLoggingId()</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Gets the HereSDKUser logging id.</p>
<div class='pre p1 fill-light mt0'>getLoggingId(): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></div>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></code>:
A promise that resolve the logging id.
</section>
</div>
</div>
</div>
</section>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='heremobilitysdkdemand'>
HereMobilitySDKDemand
</h3>
</div>
<p>HereMobilitySDKDemand is the client wrapper for accessing the Demand API, used for requesting, booking and managing rides.
HERE Mobility offers a mobility platform solution for transportation service providers, businesses, and consumers.
The platform consists of the HERE Mobility Marketplace and API/SDK packages.
The HERE Mobility Marketplace is a "broker" between transportation suppliers and consumers, which matches up ride requests with ride offers.
The HERE Mobility SDK enables developers to create apps with a variety of mobility features, while connecting to the HERE Mobility Marketplace.</p>
<div class='pre p1 fill-light mt0'>new HereMobilitySDKDemand()</div>
<div class='py1 quiet mt1 prose-big'>Static Members</div>
<div class="clearfix">
<div class='border-bottom' id='heremobilitysdkdemandgetrideoffers'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>getRideOffers(request, callback)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Request ride offers that match a given request.</p>
<div class='pre p1 fill-light mt0'>getRideOffers(request: <a href="#rideoffersrequest">RideOffersRequest</a>, callback: function (response: <a href="#rideoffers">RideOffers</a>?, error: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>?): void)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>request</span> <code class='quiet'>(<a href="#rideoffersrequest">RideOffersRequest</a>)</code>
Ride offers request parameters.
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>callback</span> <code class='quiet'>(function (response: <a href="#rideoffers">RideOffers</a>?, error: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>?): void)</code>
Callback which will be called with the result. The first parameter is the ride offers array. The second parameter is the error (if any).
</div>
</div>
</div>
</section>
</div>
</div>
<div class='border-bottom' id='heremobilitysdkdemandcreateride'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>createRide(rideOfferId, passengerDetails, ridePreferences, callback)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Book a ride and create a new ride object with the given offer ID.</p>
<div class='pre p1 fill-light mt0'>createRide(rideOfferId: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, passengerDetails: <a href="#passengerdetails">PassengerDetails</a>, ridePreferences: <a href="#ridepreferences">RidePreferences</a>?, callback: function (response: <a href="#ride">Ride</a>?, error: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>?): void)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>rideOfferId</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
The ride offer ID received from getRideOffers
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>passengerDetails</span> <code class='quiet'>(<a href="#passengerdetails">PassengerDetails</a>)</code>
Details about the passenger booking the ride (name, phone number, photo URL).
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>ridePreferences</span> <code class='quiet'>(<a href="#ridepreferences">RidePreferences</a>?)</code>
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>callback</span> <code class='quiet'>(function (response: <a href="#ride">Ride</a>?, error: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>?): void)</code>
Callback which will be called with the result. The first parameter is the ride object. The second parameter is the error (if any).
</div>
</div>
</div>
</section>
</div>
</div>
<div class='border-bottom' id='heremobilitysdkdemandgetride'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>getRide(rideId, callback)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Get a ride by rideId.</p>
<div class='pre p1 fill-light mt0'>getRide(rideId: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, callback: function (response: <a href="#ride">Ride</a>?, error: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>?): void)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>rideId</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
The ID of the ride to retrieve.
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>callback</span> <code class='quiet'>(function (response: <a href="#ride">Ride</a>?, error: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>?): void)</code>
Callback which will be called with the result. The first parameter is the ride object. The second parameter is the error (if any).
</div>
</div>
</div>
</section>
</div>
</div>
<div class='border-bottom' id='heremobilitysdkdemandcancelride'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>cancelRide(rideId, reason, callback)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Cancel a ride</p>
<div class='pre p1 fill-light mt0'>cancelRide(rideId: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, reason: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, callback: function (cancellationInfo: <a href="#cancellationinfo">CancellationInfo</a>?, err: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>?): void)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>rideId</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
The ID of the ride to be cancelled.
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>reason</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
The cancellation reason.
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>callback</span> <code class='quiet'>(function (cancellationInfo: <a href="#cancellationinfo">CancellationInfo</a>?, err: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>?): void)</code>
A callback which returns information about the cancellation request (e.g. whether the request was accepted or rejected) and errors if any.
</div>
</div>
</div>
</section>
</div>
</div>
<div class='border-bottom' id='heremobilitysdkdemandgetrides'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>getRides(rideQuery, callback)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Query for rides with the given statuses and update time.</p>
<div class='pre p1 fill-light mt0'>getRides(rideQuery: <a href="#ridequery">RideQuery</a>?, callback: function (response: <a href="#ridequeryresponse">RideQueryResponse</a>?, error: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>?): void)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>rideQuery</span> <code class='quiet'>(<a href="#ridequery">RideQuery</a>?)</code>
A RideQuery object that contains fields specifying ride update times and statuses with which you want to filter results.
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>callback</span> <code class='quiet'>(function (response: <a href="#ridequeryresponse">RideQueryResponse</a>?, error: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>?): void)</code>
Callback which will be called with the query results. The first parameter is an array of rides, the second is the error(if any).
</div>
</div>
</div>
</section>
</div>
</div>
<div class='border-bottom' id='heremobilitysdkdemandregisterforridesupdates'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>registerForRidesUpdates(rideStatusChanged, rideLocationChanged, error)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Register for ride updates.
NOTE: Only one simultaneous registration for all types of updates is possible from this module.</p>
<div class='pre p1 fill-light mt0'>registerForRidesUpdates(rideStatusChanged: function (ride: <a href="#ride">Ride</a>, rideStatusLog: <a href="#ridestatuslog">RideStatusLog</a>): void, rideLocationChanged: function (ride: <a href="#ride">Ride</a>, rideLocation: <a href="#ridelocation">RideLocation</a>): void, error: function (error: <a href="#heremobilitydemanderror">HereMobilityDemandError</a>?): void)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>rideStatusChanged</span> <code class='quiet'>(function (ride: <a href="#ride">Ride</a>, rideStatusLog: <a href="#ridestatuslog">RideStatusLog</a>): void)</code>
A callback for handling errors
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>rideLocationChanged</span> <code class='quiet'>(function (ride: <a href="#ride">Ride</a>, rideLocation: <a href="#ridelocation">RideLocation</a>): void)</code>
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>error</span> <code class='quiet'>(function (error: <a href="#heremobilitydemanderror">HereMobilityDemandError</a>?): void)</code>
</div>
</div>
</div>
</section>
</div>
</div>
<div class='border-bottom' id='heremobilitysdkdemandunregisterfromridesupdates'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>unregisterFromRidesUpdates()</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Unregister for ride updates.</p>
<div class='pre p1 fill-light mt0'>unregisterFromRidesUpdates()</div>
</section>
</div>
</div>
</div>
</section>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='latlng'>
LatLng
</h3>
</div>
<p>Represents a location on the planet, defined as a (latitude, longitude) pair.</p>
<div class='pre p1 fill-light mt0'>LatLng</div>
<div class='py1 quiet mt1 prose-big'>Properties</div>
<div>
<div class='space-bottom0'>
<span class='code bold'>lat</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>)</code>
: The latitude; between -90 and 90 degrees, inclusive.
</div>
<div class='space-bottom0'>
<span class='code bold'>lng</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>)</code>
: The longitude; between -180 (inclusive) and 180 (exclusive) degrees.
</div>
</div>
</section>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='address'>
Address
</h3>
</div>
<p>A generic address type. Note that due to the many different address standards, and different uses of this class, all of its fields are optionals.</p>
<div class='pre p1 fill-light mt0'>Address</div>
<div class='py1 quiet mt1 prose-big'>Properties</div>
<div>
<div class='space-bottom0'>
<span class='code bold'>countryName</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
: Optional, the country name.
</div>
<div class='space-bottom0'>
<span class='code bold'>countryCode</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
: Optional, the ISO 3166 Alpha 3 country code.
</div>
<div class='space-bottom0'>
<span class='code bold'>stateName</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
: Optional, the state name (if relevant).
</div>
<div class='space-bottom0'>
<span class='code bold'>cityName</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
: Optional, the city name.
</div>
<div class='space-bottom0'>
<span class='code bold'>districtName</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
: Optional, the district name (if relevant).
</div>
<div class='space-bottom0'>
<span class='code bold'>streetName</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
: Optional, the street name.
</div>
<div class='space-bottom0'>
<span class='code bold'>houseNumber</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
: Optional, the house number.
</div>
<div class='space-bottom0'>
<span class='code bold'>postalCode</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
: Optional, the postal code.
</div>
<div class='space-bottom0'>
<span class='code bold'>county</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
: Optional, the county (second subdivision level below the country).
</div>
<div class='space-bottom0'>
<span class='code bold'>subDistrict</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
: Optional, the sub-district (subdivision level below the district; e.g. commonly used in IND).
</div>
<div class='space-bottom0'>
<span class='code bold'>building</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
: Optional, the building name (e.g. commonly used in HKG).
</div>
<div class='space-bottom0'>
<span class='code bold'>addressLines</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a><<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>>)</code>
: Optional, the formatted address lines, as they would have been written on an envelope. This field is optional, and may contain empty list.
</div>
</div>
</section>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='waypoint'>
Waypoint
</h3>
</div>
<p>Waypoint Type, that encapsulates a LatLng type, and additional information.</p>
<div class='pre p1 fill-light mt0'>Waypoint</div>
<div class='py1 quiet mt1 prose-big'>Properties</div>
<div>
<div class='space-bottom0'>
<span class='code bold'>location</span> <code class='quiet'>(<a href="#latlng">LatLng</a>)</code>
: Location of the waypoint.
</div>
<div class='space-bottom0'>
<span class='code bold'>address</span> <code class='quiet'>(<a href="#address">Address</a>)</code>
: Optional, address of the waypoint, null if no address exists.
</div>
<div class='space-bottom0'>
<span class='code bold'>description</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
: Optional, sets the free text description of the waypoint.
</div>
</div>
</section>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='ridewaypoints'>
RideWaypoints
</h3>
</div>
<p>The route of the ride, composed of the pickup location and the destination.</p>
<div class='pre p1 fill-light mt0'>RideWaypoints</div>
<div class='py1 quiet mt1 prose-big'>Properties</div>
<div>
<div class='space-bottom0'>
<span class='code bold'>pickup</span> <code class='quiet'>(<a href="#waypoint">Waypoint</a>)</code>
: Pickup waypoint.
</div>
<div class='space-bottom0'>
<span class='code bold'>destination</span> <code class='quiet'>(<a href="#waypoint">Waypoint</a>)</code>
: Destination waypoint.
</div>
</div>
</section>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='pricerange'>
PriceRange
</h3>
</div>
<p>Range of the price.</p>
<div class='pre p1 fill-light mt0'>PriceRange</div>
<div class='py1 quiet mt1 prose-big'>Properties</div>
<div>
<div class='space-bottom0'>
<span class='code bold'>lowerBound</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>)</code>
: Minimum amount.
</div>
<div class='space-bottom0'>
<span class='code bold'>upperBound</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>)</code>
: Maximum amount.
</div>
<div class='space-bottom0'>
<span class='code bold'>currencyCode</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
: Currency code.
</div>
</div>
</section>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='transitoptions'>
TransitOptions
</h3>
</div>
<p>Options relevant to public transport offers.</p>
<div class='pre p1 fill-light mt0'>TransitOptions</div>
<div class='py1 quiet mt1 prose-big'>Properties</div>
<div>
<div class='space-bottom0'>
<span class='code bold'>maxAllowedTransfers</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>)</code>
: Optional, maximum number of allowed transportation method changes. Allowed values are between 0-6, or null . If null is given, there will be no limit on the number of transfers.
</div>
<div class='space-bottom0'>
<span class='code bold'>maxWalkingDistance</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>)</code>
: Optional, maximum walking distance in the offer. The measurement unit is meters. valid values are between 0-6000 meters. The default value is 2000 meters.
</div>
<div class='space-bottom0'>
<span class='code bold'>locale</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
: Optional, the locale to use for the
<a href="#publictransportrideoffer">PublicTransportRideOffer</a>
. Complies with the ISO 639-1 standard. The default is "EN".
</div>
</div>
</section>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='bookingconstraints'>
BookingConstraints
</h3>
</div>
<p>Constraints that the supplier must fulfill for the current booking.</p>
<div class='pre p1 fill-light mt0'>BookingConstraints</div>
<div class='py1 quiet mt1 prose-big'>Properties</div>
<div>
<div class='space-bottom0'>
<span class='code bold'>passengerCount</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>)</code>
: Number of passengers on the ride.
</div>
<div class='space-bottom0'>
<span class='code bold'>suitcaseCount</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>)</code>
: Number of suitcases on the ride.
</div>
</div>
</section>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='rideofferrequestsorttype'>
RideOfferRequestSortType
</h3>
</div>
<div class='pre p1 fill-light mt0'>RideOfferRequestSortType</div>
<div class='py1 quiet mt1 prose-big'>Properties</div>
<div>
<div class='space-bottom0'>
<span class='code bold'>BY_PRICE</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
: Sort offers by price (lowest price first)
</div>
<div class='space-bottom0'>
<span class='code bold'>BY_ETA</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
: Sort offers by ETA to the pickup point (shortest ETA first)
</div>
</div>
</section>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='rideoffersrequest'>
RideOffersRequest
</h3>
</div>
<p>Request from the SDK to the server for ride offers.</p>
<div class='pre p1 fill-light mt0'>RideOffersRequest</div>
<div class='py1 quiet mt1 prose-big'>Properties</div>
<div>
<div class='space-bottom0'>
<span class='code bold'>rideWaypoints</span> <code class='quiet'>(<a href="#ridewaypoints">RideWaypoints</a>)</code>
: The requested route.
</div>
<div class='space-bottom0'>
<span class='code bold'>constraints</span> <code class='quiet'>(<a href="#bookingconstraints">BookingConstraints</a>)</code>
: Optional, conditions that the supplier must accommodate, such as number of passengers, wheelchair access, etc.
</div>
<div class='space-bottom0'>
<span class='code bold'>prebookPickupTime</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>)</code>
: 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.
</div>
<div class='space-bottom0'>
<span class='code bold'>priceRange</span> <code class='quiet'>(<a href="#pricerange">PriceRange</a>)</code>
: Optional price range acceptable to the passenger.
</div>
<div class='space-bottom0'>
<span class='code bold'>sortType</span> <code class='quiet'>(<a href="#rideofferrequestsorttype">RideOfferRequestSortType</a>)</code>
: Optional sort type. If not given, the order is by price, and then by ETA.
</div>
<div class='space-bottom0'>
<span class='code bold'>passengerNote</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>)</code>
: Optional note from the passenger.
</div>
<div class='space-bottom0'>
<span class='code bold'>transitOptions</span> <code class='quiet'>(<a href="#transitoptions">TransitOptions</a>)</code>
: Optional Transit options. This will affect the public transport offers.
*
</div>
</div>
</section>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='transittype'>
TransitType
</h3>
</div>
<p>The type of the offer.</p>
<div class='pre p1 fill-light mt0'>TransitType</div>
<p>
Type:
(<code>"TAXI"</code> | <