Class

INRequestRideIntent

A request to book the specified ride from your service.

Overview

SiriKit creates an INRequestRideIntent object when the user asks to book a ride using your app. A ride request intent contains user-supplied information about the ride, such as its starting point and the number of people. You use this intent object to identify possible ride options for the user to choose from and to book the ride when it is confirmed.

To handle this intent, the handler object in your Intents extension must adopt the INRequestRideIntentHandling protocol. Your handler should confirm the request and create an INRequestRideIntentResponse object with information about whether the ride was booked successfully.

For a list of other intents in the ride-booking domain, see INRidesharingDomainHandling.

Additional Intent Attributes

Table 1 lists additional attributes of this intent object.

Table 1

Request ride intent attributes

Attribute

Description

Supported by

Siri, Maps

Always requires unlocked device

Yes

Example Phrases

There are many ways in which users can ask Siri to book a ride. Table 2 provides a few sample phrases in different languages. You can use these phrases during testing to trigger your intents. This list is not exhaustive and Siri may recognize many other phrases.

Table 2

Siri phrases that trigger the booking of a ride

Locale

Example 1

Example 2

en

Get me a ride to the airport using <appName>

Book me a ride with <appName>

zh_CN

<appName>叫一辆车到旧金山机场

我想叫一台出租车从中关村到五道口

zh_HK

喺滴滴出行搵車去舊金山機場

用滴滴出行搵部車去酒店

zh_TW

叫一台<appName>我要去台北101

預約一台<appName>

yue_CN

喺滴滴出行揾车去旧金山机场

用滴滴出行揾部车去酒店

ar

ابحث عن <appName> لمرافقتي في دبي مول

إعثر على <appName> لنقلي في دبي مول

da

skaf en <appName> til lufthavnen

de

Ein <appName> suchen welches mich am Arbeitplatz aufgabelt

Finde ein <appName> welches mich vom Potsdamer Platz mitnimmt

es

Pídeme un taxi al aeropuerto usando <appName>

Pídeme un viaje usando <appName>

fi

Tarvitsen <appName> kyydin lentokentälle

Varaa <appName> lentokentälle

fr

Commande un chauffeur <appName> pour l'aéroport

Réserve-moi un taxi avec <appName> pour aller à l'aéroport

he

יש <appName> באוסטין

תזמיני רכב מ<appName>

it

Trovami un passaggio per l'aeroporto usando <appName>

Prenotami un passaggio con <appName>

ja

<appName>の車で空港まで行きたい

空港まで<appName>の車を手配して

ko

다운타운에서 <appName> 찾아줘

인천공항에서 탈 수 있는 <appName> 찾아줘

ms

Cari kenderaan untuk pergi ke Kuala Lumpur menggunakan <appName>

Tempah <appName>

nb

Skaff en bil til flyplassen med <appName>

Bestill skyss med <appName>

nl

Vind een taxi naar de luchthaven via <appName>

Boek een taxi met <appName>

pt

Chamar um carro para o aeroporto usando <appName>

Reservar um <appName>

ru

Закажи <appName> чтобы забрал на Ленинском проспекте

забронируй <appName>

sv

Boka en skjuts till flygplatsen med hjälp av <appName>

Förbeställ en bil från <appName>

th

ฉันต้องการเดินทางไปลาดพร้าวโดยใช้ <appName>

จอง <appName>

tr

<appName>'den araç bul Üsküdar'a gitmeliyim

Taksim'e gitmek üzere <appName>'den araç bul

In the preceding examples, <appName> represents the name of the app whose Intents extension books the ride. If your app uses custom names for rides, you can tell Siri about those names in your global vocabulary file.

Topics

Getting the Ride Details

var rideOptionName: INSpeakableString?

The name of the ride option selected by the user.

var partySize: Int?

The number of passengers that the ride must accommodate.

var pickupLocation: CLPlacemark?

The user’s starting location.

var scheduledPickupTime: INDateComponentsRange?

The time at which to pick up the user.

var dropOffLocation: CLPlacemark?

The user’s destination.

Getting the Payment Information

var paymentMethod: INPaymentMethod?

The user’s requested payment method.

Relationships

Inherits From

Conforms To

See Also

Request a Ride

protocol INRequestRideIntentHandling

The handler interface for booking a ride for the user.

class INRequestRideIntentResponse

Your app’s response to a request ride intent.