EventType

enum EventType
extension EventType : CaseIterable, CustomStringConvertible, Equatable, Hashable, RawRepresentable

As new event types are identified, a new enum case should be defined here so that it can be listened to and fired.

  • This event tracks which FI was centered

    Declaration

    Swift

    case FICentered
  • This event tracks which FI was selected

    Declaration

    Swift

    case FISelected
  • New FI card is added

    Declaration

    Swift

    case addCard
  • This event tracks when we approve the card from add card

    Declaration

    Swift

    case addCardApproved
  • This event tracks errors in the add card flow that need no interaction

    Declaration

    Swift

    case addCardError
  • This event is fired when add card state is updated to processing or not processing

    Declaration

    Swift

    case addCardStateUpdated
  • Undocumented

    Declaration

    Swift

    case addressLine1EditingChanged
  • When address validation query has finished and there is a reformatted address provided in the response. Firing this event will update ShippingCorrectionPage with the entered address and reformatted address.

    Declaration

    Swift

    case addressReformatted
  • When user toggles the billing balance

    Declaration

    Swift

    case billingBalanceToggled
  • When the SDK encounters a 3DS challenge when confirming payment, but the Cardinal SDK is not present to handle the transaction

    Declaration

    Swift

    case cardinalNotPresent
  • The user selected a country for the native add shipping experience.

    Declaration

    Swift

    case countrySelected
  • This event tracks when create order request has finished successfully with an order ID

    Declaration

    Swift

    case createOrderSucceeded
  • This event tracks when we get new quotes from gql or switch to a different crypto FI

    Declaration

    Swift

    case cryptoUpdated
  • When the cta needs to be updated

    Declaration

    Swift

    case ctaButtonUpdated
  • A textual representation of this instance.

    Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the String(describing:) initializer. This initializer works with any type, and uses the custom description property for types that conform to CustomStringConvertible:

    struct Point: CustomStringConvertible {
        let x: Int, y: Int
    
        var description: String {
            return "(\(x), \(y))"
        }
    }
    
    let p = Point(x: 21, y: 30)
    let s = String(describing: p)
    print(s)
    // Prints "(21, 30)"
    

    The conversion of p to a string in the assignment to s uses the Point type’s description property.

    Declaration

    Swift

    var description: String { get }
  • This event tracks when we find a duplicate button session id.

    Declaration

    Swift

    case duplicateButtonSessionID
  • This event tracks when we find a duplicate ec-token.

    Declaration

    Swift

    case duplicateTokenFound
  • This event tracks when there’s an error while approving 3DS during checkout. (approval happens after the user hits the continue/ pay now button).

    Declaration

    Swift

    case errorApproving3DS
  • This event indicates that during checkout after the user hits the continue button there was an error approving the payment.

    Declaration

    Swift

    case errorApprovingPayment
  • This event tracks when a funding option has failed 3DS authentication.

    Declaration

    Swift

    case fiFailed3DS
  • This event tracks when firebase finishes or times out

    Declaration

    Swift

    case firebaseSetProps
  • This event tracks any changes in the funding options list.

    Declaration

    Swift

    case fundingOptionsChanged
  • The default event type in the application

    Declaration

    Swift

    case gqlPayload
  • Fired after we fetch GQL checkoutSession.cart

    Declaration

    Swift

    case gqlSessionCart
  • Creates a new instance with the specified raw value.

    If there is no value of the type that corresponds with the specified raw value, this initializer returns nil. For example:

    enum PaperSize: String {
        case A4, A5, Letter, Legal
    }
    
    print(PaperSize(rawValue: "Legal"))
    // Prints "Optional("PaperSize.Legal")"
    
    print(PaperSize(rawValue: "Tabloid"))
    // Prints "nil"
    

    Declaration

    Swift

    init?(rawValue: String)
  • Keyboard will hide

    Declaration

    Swift

    case keyboardWillHide
  • Keyboard will show

    Declaration

    Swift

    case keyboardWillShow
  • Triggers a logout flow and redirects the user to the start experience

    Declaration

    Swift

    case logout
  • This event tracks the eligibility status

    Declaration

    Swift

    case nativeEligibilityUpdated
  • Lets us know when the onApprove RTDB message has been successfully sent

    Declaration

    Swift

    case onApproveRTDBMessage
  • Lets us know when the user has chosen to select Cancel

    Declaration

    Swift

    case onCancel
  • This event tracks when the close button is tapped

    Declaration

    Swift

    case onCloseButtonTapped
  • This is a generalized on error event which can be utilized anywhere.

    Declaration

    Swift

    case onError
  • Fire this event to display a generic error or a custom error message to the user without doing anything additional

    Declaration

    Swift

    case onGenericError
  • A link from the profile page has been tapped

    Declaration

    Swift

    case openProfileLink
  • Will open safari based on the route

    Declaration

    Swift

    case openWeb
  • This event tracks when the PaysheetViewController gets added to a view hierarchy.

    Declaration

    Swift

    case paysheetDidAppear
  • This event tracks when the PaysheetViewController will get removed from a view hierarchy.

    Declaration

    Swift

    case paysheetWillDisappear
  • We received successful response for PlaceDetails we can update our AddShippingPage with the normalized address.

    Declaration

    Swift

    case placeDetailsUpdate
  • Undocumented

    Declaration

    Swift

    case scrollPageOnAddressSuggestionsShown
  • As the SDK shuts down it makes a final mutation to the backend to modify the cart and payment that transactions are complete. The response from this call is used in several places. This event allows that to happen.

    Declaration

    Swift

    case sdkApprovePayment
  • This event tracks the start of the finishing flow

    Declaration

    Swift

    case sdkFinishing
  • This event indicates that the overall state of the SDK is has been shutdown. This is the ideal place for subscribers to indicate things need to be cleaned up, deinited and prepped for reuse.

    Declaration

    Swift

    case sdkShutdown
  • This event tracks when a user selects a new plan. (ie.splitPlan or a solo plan)

    Declaration

    Swift

    case selectedPlanChanged
  • This event sets the profile image view with the a new image The list of available images are located in the profileImages enum

    Declaration

    Swift

    case setNewProfileImage
  • A new shipping address has been added

    Declaration

    Swift

    case shippingAddressAdded
  • Fired after shipping change has completed to update UI with new shipping method and order’s amount. If shipping callback is nil, this event will be fired immediately after shipping address/method change, Otherwise, it’s fired after shipping callback has completed and we have fetched new cart info to refresh the Paysheet. Note: Shipping change includes when Paysheet first loads and when buyer selects new shipping address/method

    Declaration

    Swift

    case shippingChangeCompleted
  • Fired when we call shipping callback Note: Shipping change includes when Paysheet first loads and when buyer selects new shipping address/method

    Declaration

    Swift

    case shippingChangeStarted
  • Toggle the cart details view

    Declaration

    Swift

    case toggleCartDetailsView
  • We finished our ELMO treatments call and this event updates paysheet based on treatments.

    Declaration

    Swift

    case treatmentsUpdated
  • When the user has changed the currency conversion preference

    Declaration

    Swift

    case uiCurrencyConversionChanged
  • Fired after any height and content changes resulting from page transition

    Declaration

    Swift

    case uiPageDidChange
  • Fired during any height and content changes resulting from page transition

    Declaration

    Swift

    case uiPageIsChanging
  • Fired before any height and content changes resulting from page transition

    Declaration

    Swift

    case uiPageWillChange
  • When there is a profile pic data available, use this event to let views that are currently presently know.

    Declaration

    Swift

    case uiProfilePicAvailable
  • This event represents when the UI has set a card as preferred and the corresponding model should be updated.

    Declaration

    Swift

    case uiSetCardAsPreferred
  • Undocumented

    Declaration

    Swift

    case updateCarouselAddCardImage