Class

INRideCompletionStatus

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

Declaration

@interface INRideCompletionStatus : NSObject

Overview

An INRideCompletionStatus object contains detailed information about the status of a completed ride. Use this object to provide details about whether the ride was successful or canceled. You can also provide details related to the cost of the ride and whether the rider made payment.

When updating the status of a ride, you provide a response object that contains an INRideStatus object with details about the status. When the ride reaches the completed phase, create an instance of this class and assign it to the completionStatus property of the ride status object.

Topics

Creating a Ride Completion Status Object

+ completed

Creates an instance of this class that indicates the ride completed successfully.

+ completedWithSettledPaymentAmount:

Creates an instance of this class that indicates the ride completed successfully and with the specified cost.

+ completedWithOutstandingPaymentAmount:

Creates an instance of this class that indicates the ride completed successfully but still requires payment from the user.

+ completedWithOutstandingFeedbackType:

Creates an instance of this class that indicates the ride completed successfully but still requires feedback from the user.

+ canceledByService

Creates an instance of this class that indicates your service canceled the ride.

+ canceledByUser

Creates an instance of this class that indicates the user canceled the ride.

+ canceledMissedPickup

Creates an instance of this class that indicates someone canceled the ride because of a missed pickup.

Providing a User Activity Object

completionUserActivity

The user activity object indicating any additional steps the user needs to be take in your app.

Getting the Status Information

completed

A Boolean value indicating whether the ride completed successfully.

canceled

A Boolean value indicating whether someone canceled the ride for any reason.

missedPickup

A Boolean value indicating whether someone canceled the ride because the user was never picked up.

outstanding

A Boolean indicating whether payment is still outstanding.

paymentAmount

The amount paid or still outstanding for the ride.

Requesting Feedback About the Ride

feedbackType

The type of feedback required for the ride before the user books a new ride can.

INRideFeedbackTypeOptions

Constants indicating the type of feedback needed.

defaultTippingOptions

An array of default tip amounts to display to the user.

Relationships

Inherits From

See Also

Data Objects

INRideOption

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

INRideStatus

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

INRideDriver

Identifying information about a driver of a ride service.

INRideVehicle

A specific vehicle used by a ride-booking service.

INRideFareLineItem

A specific type of ride-related charge.

INRidePartySizeOption

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

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software