Contents

completed(outstanding:)

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

Declaration

class func completed(outstanding outstandingPaymentAmount: INCurrencyAmount) -> Self

Parameters

  • outstandingPaymentAmount:

    The amount of money owed by the user for the ride.

Return Value

An initialized INRideCompletionStatus object.

Discussion

Use this method when the ride completed successfully but the user has not yet provided full payment. This method sets the isCompleted and isOutstanding properties of the returned object to true, and it sets the isCanceled and isMissedPickup properties to false. It also sets the paymentAmount property to the value in the outstandingPaymentAmount parameter. Your app can use that amount later to handle the payment.

After creating the object, assign a value to the object’s completionUserActivity property. Your user activity object should indicate that payment is still required in your app. Providing the user activity object lets SiriKit know that it should notify the user that your app needs to take additional steps.

See Also

Creating a Ride Completion Status Object