Protocols Reference


                    
                    
                    OloPayAPIProtocol

Protocol for mocking/testing purposes. See OloPayAPI for documentation

Declaration

Swift

@objc
public protocol OloPayAPIProtocol : NSObjectProtocol


                    
                    
                    OloPayApiInitializerProtocol

Protocol for mocking/testing purposes. See OloPayApiInitializer for documentation

Declaration

Swift

@objc
public protocol OloPayApiInitializerProtocol : NSObjectProtocol


                    
                    
                    OPApplePayLauncherDelegate

Protocol to hook into important events in the ApplePay flow

Required: Implement paymentMethodCreated to get payment method details that need to be submitted to Olo’s Ordering API when submitting a basket with OloPay

Optional: Implement applePayDismissed to know when the ApplePay sheet is dismissed

Declaration

Swift

@objc
public protocol OPApplePayLauncherDelegate : NSObjectProtocol


                    
                    
                    OPApplePayLauncherProtocol

Protocol for mocking/testing purposes. See OPApplePayLauncher for documentation

Declaration

Swift

@objc
public protocol OPApplePayLauncherProtocol : NSObjectProtocol


                    
                    
                    OPPaymentCardCvvViewDelegate

Defines the interface that should be implemented to receive updates from instances of OPPaymentCardCvvView. Each callback method is optional so you only need to implement the ones you need.

Important

There are two versions of each callback method. One version contains a reference to the view and can be used if you are implementing these callbacks in your UI layer. If implementing callbacks in a data layer it is recommended to implement the versions that do not contain a reference to a view.

Declaration

Swift

@objc
public protocol OPPaymentCardCvvViewDelegate : NSObjectProtocol


                    
                    
                    OPPaymentCardDetailsFormDelegate

Defines the interface that should be implemented to receive updates from instances of OPPaymentCardDetailsForm. Each callback method is optional so you only need to implement the ones you need.

Important

There are two versions of each callback method. One version contains a reference to the view and can be used if you are implementing these callbacks in your UI layer. If implementing callbacks in a data layer it is recommended to implement the versions that do not contain a reference to a view.

Declaration

Swift

@objc
public protocol OPPaymentCardDetailsFormDelegate : NSObjectProtocol


                    
                    
                    OPPaymentCardDetailsViewDelegate

Defines the interface that should be implemented to receive updates from instances of OPPaymentCardDetailsView. Each callback method is optional so you only need to implement the ones you need.

Important

There are two versions of each callback method. One version contains a reference to the view and can be used if you are implementing these callbacks in your UI layer. If implementing callbacks in a data layer it is recommended to implement the versions that do not contain a reference to a view.

Declaration

Swift

@objc
public protocol OPPaymentCardDetailsViewDelegate : NSObjectProtocol


                    
                    
                    OPAddressProtocol

Represents an address.

Declaration

Swift

@objc
public protocol OPAddressProtocol : NSObjectProtocol


                    
                    
                    OPCardFieldStateProtocol

Protocol representing the state of a credit card field (card number, expiration, cvv, postal code).

Declaration

Swift

@objc
public protocol OPCardFieldStateProtocol : NSObjectProtocol


                    
                    
                    OPCvvTokenParamsProtocol

Parameters class used to generate a CVV token via OloPayAPI.createCvvToken(...)

Declaration

Swift

@objc
public protocol OPCvvTokenParamsProtocol : NSObjectProtocol


                    
                    
                    OPCvvUpdateTokenProtocol

Represents a single-use cvv update token used to submit a basket via Olo’s Ordering API when a saved card requires CVV revalidation

Declaration

Swift

@objc
public protocol OPCvvUpdateTokenProtocol : NSObjectProtocol


                    
                    
                    OPPaymentMethodParamsProtocol

Payment method parameters to send payment data to OloPayAPI.createPaymentMethod(...)

Declaration

Swift

@objc
public protocol OPPaymentMethodParamsProtocol : NSObjectProtocol


                    
                    
                    OPPaymentMethodProtocol

Represents a payment method containing all information needed to submit a basket via Olo’s Ordering API

Declaration

Swift

@objc
public protocol OPPaymentMethodProtocol : NSObjectProtocol