Class

INListRideOptionsIntent

An intent for getting the types of rides available from a ride-booking service.

Overview

Maps creates an INListRideOptionsIntent object when it needs to display the types of vehicles that your service offers. Use the information in this intent to identify the possible vehicles that you can provide to the user right now. The intent contains information about the user’s pickup and drop-off locations, which you can use to determine ride availability, pricing, and estimated pickup times. This intent object represents a request for information and is not a commitment from the user to book any of the specified rides.

To handle this intent, the handler object in your Intents extension must adopt the INListRideOptionsIntentHandling protocol. Your handler should resolve and confirm the request parameters and create an INListRideOptionsIntentResponse object with the list of options.

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

List ride intent attributes

Attribute

Description

Supported by

Maps

Always requires unlocked device

Yes

Topics

Creating the Intent Object

init(pickupLocation: CLPlacemark?, dropOffLocation: CLPlacemark?)

Initializes the intent object with the specified pickup and drop-off locations.

Getting the Pickup and Drop Off Locations

var pickupLocation: CLPlacemark?

The user’s starting location.

var dropOffLocation: CLPlacemark?

The user’s destination.

Relationships

Inherits From

Conforms To

See Also

List Ride Options

Generating a List of Ride Options

Generate ride options for Maps to display to the user.

protocol INListRideOptionsIntentHandling

The handler interface for fetching the list of rides currently available from your ride-booking service.

class INListRideOptionsIntentResponse

Your app’s response to a list ride options intent.