The status of a ride booked through a ride-booking service.


class INRideStatus : NSObject


When the user books a ride or requests the status of a ride, you create an INRideStatus object as part of your response and fill it with the relevant information. A ride status object conveys information about the current status of a ride, such as whether the ride is ongoing, completed, or has yet to occur. This object also contains details about the ride such as the pickup location, drop-off location, and information about the driver and vehicle. Siri and Maps display the information in this object to the user at appropriate times.

When configuring ride status objects, always provide values for as many properties as possible. Siri and Maps display almost all of the information that you provide to the user, so it is good to offer as many details as you can.


Accessing the Ride Identifier

var rideIdentifier: String?

The unique string that you use to identify the ride.

Specifying the Ride Status

var phase: INRidePhase

The current status of the ride.

enum INRidePhase

Constants indicating the current ride status.

var completionStatus: INRideCompletionStatus?

Information about how the ride ended.

Accessing Ride Information

var vehicle: INRideVehicle?

The vehicle assigned to pick up the user.

var driver: INRideDriver?

The driver providing the ride.

var rideOption: INRideOption?

Information about the type of ride that you are offering to the user.

Accessing the Pickup and Drop Off Times

var scheduledPickupTime: INDateComponentsRange?

The scheduled pickup time for the user.

var estimatedPickupDate: Date?

The estimated pickup time for the ride.

var estimatedPickupEndDate: Date?

The date after which the driver may stop waiting for the user.

var estimatedDropOffDate: Date?

The estimated drop-off time for the ride.

Accessing the Route Information

var pickupLocation: CLPlacemark?

The starting location for the ride.

var waypoints: [CLPlacemark]?

The intermediate waypoints for the journey.

var dropOffLocation: CLPlacemark?

The destination of the user.

Providing User Activity Objects

var userActivityForCancelingInApplication: NSUserActivity?

A user activity object for canceling the ride request.

var additionalActionActivities: [NSUserActivity]?

Additional activities that the user may choose to perform while the ride request is active.


Inherits From

See Also

Data Objects

class INRideOption

Details about a type of ride offered by your ride-booking service.

class INRideDriver

Identifying information about a driver of a ride service.

class INRideVehicle

A specific vehicle used by a ride-booking service.

class INRideFareLineItem

A specific type of ride-related charge.

class INRidePartySizeOption

The price of a ride involving the specified number of people.

class INRideCompletionStatus

Additional details about whether a ride completed successfully or someone canceled the ride.