Class

INGetAvailableRestaurantReservationBookingsIntent

A request for the time slots available for making a reservation.

Overview

An INGetAvailableRestaurantReservationBookingsIntent object asks you to generate details regarding the available time slots offered by a restaurant for a given party size. Maps sends this intent to your Intents extension when the user begins the booking process. You use this intent to obtain the initial details about the reservation request, including the number of people and the preferred date for the reservation. You use those details to identify potential time slots that can accommodate the party and return those time slots in your response object.

To handle this intent, the handler object in your Intents extension must adopt the INGetAvailableRestaurantReservationBookingsIntentHandling protocol. Your handler should resolve and confirm any parameters and create an INGetAvailableRestaurantReservationBookingsIntentResponse object with the list of potential time slots.

Additional Intent Attributes

Table 1 lists additional attributes of this intent object.

Table 1

Get available restaurant reservation bookings intent attributes

Attribute

Description

Supported by

Maps

Always requires unlocked device

Yes

Topics

Getting the Restaurant

var restaurant: INRestaurant

The restaurant associated with the reservation.

Getting the Reservation Details

var partySize: Int

The number of people in the guest’s party.

var preferredBookingDateComponents: DateComponents?

The date and time preferred by the user for the reservation.

Getting the Time Slot Constraints

var earliestBookingDateForResults: Date?

The earliest date for which to return results.

var latestBookingDateForResults: Date?

The latest date for which to return results.

var maximumNumberOfResults: NSNumber?

The maximum number of reservation results to return.

Relationships

Inherits From

See Also

Get Available Restaurant Reservation Bookings

protocol INGetAvailableRestaurantReservationBookingsIntentHandling

The handler interface for generating a list of potential reservation times from which the user can select.

class INGetAvailableRestaurantReservationBookingsIntentResponse

Your app’s response to a get available restaurant reservation bookings intent.