Class

INListRideOptionsIntentResponse

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

Overview

An INListRideOptionsIntentResponse object contains your app’s response to a request for ride options that your service offers. SiriKit can ask for a list of ride options at any time. When creating your response object, provide the types of vehicles you can offer in the rideOptions property. Each option provides information about a specific type of vehicle, including information about the pricing and passenger capacity of those vehicles. You can also provide information about accepted forms of payment and when the list of ride options expires.

When creating a response object with a code that involves launching the app, always provide a relevant NSUserActivity object. The activity object is delivered to your parent app so that it has the context that it needs to handle the operation.

You create an INListRideOptionsIntentResponse object in the confirm(intent:completion:) and handle(intent:completion:) methods of your handler object. For more information about implementing your handler object, see INListRideOptionsIntentHandling.

Topics

Initializing the Response Object

init(code: INListRideOptionsIntentResponseCode, userActivity: NSUserActivity?)

Initialize the response object with the specified code and user activity object.

Getting the Response Code

var code: INListRideOptionsIntentResponseCode

The code indicating whether you successfully handled the intent.

Accessing the Response Parameters

var rideOptions: [INRideOption]?

An array of ride options representing the services and prices that you are able to offer.

var expirationDate: Date?

The date after which the specified ride options are no longer valid.

var paymentMethods: [INPaymentMethod]?

An array of payment methods supported by your service.

Constants

enum INListRideOptionsIntentResponseCode

Constants indicating the state of the response

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 INListRideOptionsIntent

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