Class

INRideCompletionStatus

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

Declaration

class 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

class func completed() -> Self

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

class func completed(settled: INCurrencyAmount) -> Self

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

class func completed(outstanding: INCurrencyAmount) -> Self

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

class func completed(feedbackType: INRideFeedbackTypeOptions) -> Self

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

class func canceledByService() -> Self

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

class func canceledByUser() -> Self

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

class func canceledMissedPickup() -> Self

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

Providing a User Activity Object

var completionUserActivity: NSUserActivity?

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

Getting the Status Information

var isCompleted: Bool

A Boolean value indicating whether the ride completed successfully.

var isCanceled: Bool

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

var isMissedPickup: Bool

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

var isOutstanding: Bool

A Boolean indicating whether payment is still outstanding.

var paymentAmount: INCurrencyAmount?

The amount paid or still outstanding for the ride.

Requesting Feedback About the Ride

var feedbackType: INRideFeedbackTypeOptions

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

struct INRideFeedbackTypeOptions

Constants indicating the type of feedback needed.

var defaultTippingOptions: Set<INCurrencyAmount>?

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

Relationships

Inherits From

See Also

Data Objects

class INRideOption

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

class INRideStatus

The status of a ride booked through a 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.