Type Aliases Reference


                    
                    
                    OPVoidBlock

An empty block, called with no arguments, returning nothing.

Swift

public typealias OPVoidBlock = () -> Void


                    
                    
                    OPApplePayCompletionBlock

A callback used to return an error during the ApplePay completion flow

Swift

public typealias OPApplePayCompletionBlock = (_ error: Error?) -> Void


                                error

The error that occurred when submitting an ApplePay payment method to Olo’s Ordering API, or nil if no error occurred


                    
                    
                    OPPaymentMethodCompletionBlock

A completion handler used when generating payment methods

Swift

public typealias OPPaymentMethodCompletionBlock = (_ paymentMethod: OPPaymentMethodProtocol?, _ error: Error?) -> Void

`paymentMethod`	The payment method from the response. Will be `nil` if an error occurs.
`error`	The error returned from the response, or nil if no error occurred.


                    
                    
                    OPCvvTokenUpdateCompletionBlock

A completion handler used when generating CVV update tokens

Swift

public typealias OPCvvTokenUpdateCompletionBlock = (_ token: OPCvvUpdateTokenProtocol?, _ error: Error?) -> Void

`token`	The CVV Update token from the response. Will be `nil` if an error occurs
`error`	The error returned from the response, or nil if no error occured


                    
                    
                    OPCardBrandImageBlock

A block used for returning an image associated with the card brand parameter

Swift

public typealias OPCardBrandImageBlock = (_ cardBrand: OPCardBrand) -> UIImage?


                                cardBrand

The brand to get an image for

An image associated with the given brand, or nil


                    
                    
                    OPCardErrorMessageBlock

A block used for returning an error message based on the current state of the Card control

Swift

public typealias OPCardErrorMessageBlock = (_ cardState: NSDictionary, _ cardBrand: OPCardBrand, _ ignoreUneditedFieldErrors: Bool) -> String

`cardState`	A representation of the current state of the card input control
`cardBrand`	The detected brand of the card number entered by the user
`ignoreUneditedFieldErrors`	If true, only fields that have been edited should be considered when generating an error message. If false, all fields should be considered.

An error message, or empty string if no message should be displayed


                    
                    
                    OPCvvErrorMessageBlock

A block used for returning an error message based on the current state of the CVV control

Swift

public typealias OPCvvErrorMessageBlock = (_ cvvFieldState: OPCardFieldStateProtocol, _ ignoreUneditedFieldErrors: Bool) -> String

`cvvFieldState`	A representation of the current state of the CVV control
`ignoreUneditedFieldErrors`	If true, only fields that have been edited should be considered when generating an error message. If false, all fields should be considered.

An error message, or empty string if no message should be displayed