SessionAppearance

@objc
public protocol SessionAppearance : AnyObject, NSObjectProtocol

Session appearance protocol.

Common

  • SDK appearance mode. If not implemented it will be treated as default.

    Declaration

    Swift

    @objc(appearanceModeForSession:)
optional func appearanceMode(for session: SessionProtocol) -> SDKAppearanceMode

    Parameters

    session

    Target session.

    Return Value

    SDKAppearanceMode

  • Defines if success/failure popup appears after the transaction finishes. Default is true.

    Declaration

    Swift

    @objc(sessionShouldShowStatusPopup:)
optional func sessionShouldShowStatusPopup(_ session: SessionProtocol) -> Bool

    Parameters

    session

    Target session.

    Return Value

    Bool

Background

  • Background color for payment screen.

    Declaration

    Swift

    @objc(backgroundColorForSession:)
optional func backgroundColor(for session: SessionProtocol) -> UIColor?

    Parameters

    session

    Target session.

    Return Value

    UIColor

  • Content background color for payment screen.

    Declaration

    Swift

    @objc(contentBackgroundColorForSession:)
optional func contentBackgroundColor(for session: SessionProtocol) -> UIColor?

    Parameters

    session

    Target session.

    Return Value

    UIColor

  • Background blur style for payment screen.

    Declaration

    Swift

    @objc(backgroundBlurEffectStyleForSession:)
optional func backgroundBlurEffectStyle(for session: SessionProtocol) -> TapBlurStyle

    Parameters

    session

    Target session.

    Return Value

    TapBlurEffectStyle

  • Background blur radius progress in range [0, 1]. If you return 0 here, blur will be hidden.

    Declaration

    Swift

    @available(iOS 10.0, *)
@objc(backgroundBlurProgressForSession:)
optional func backgroundBlurProgress(for session: SessionProtocol) -> CGFloat

    Parameters

    session

    Target session.

    Return Value

    CGFloat

Header

  • Font for the header text.

    Declaration

    Swift

    @objc(headerFontForSession:)
optional func headerFont(for session: SessionProtocol) -> UIFont

    Parameters

    session

    Target session.

    Return Value

    UIFont

  • Color for the header text.

    Declaration

    Swift

    @objc(headerTextColorForSession:)
optional func headerTextColor(for session: SessionProtocol) -> UIColor?

    Parameters

    session

    Target session.

    Return Value

    UIColor

  • Background color for the header.

    In windowed mode this color will be applied immediately, but in fullscreen mode only when there is content under the header.

    Declaration

    Swift

    @objc(headerBackgroundColorForSession:)
optional func headerBackgroundColor(for session: SessionProtocol) -> UIColor?

    Parameters

    session

    Target session.

    Return Value

    UIColor

  • Header cancel button font.

    Declaration

    Swift

    @objc(headerCancelButtonFontForSession:)
optional func headerCancelButtonFont(for session: SessionProtocol) -> UIFont

    Parameters

    session

    Target session.

    Return Value

    UIFont

  • Header cancel button text color.

    Declaration

    Swift

    @objc(headerCancelButtonTextColorForState:session:)
optional func headerCancelButtonTextColor(for state: UIControl.State, session: SessionProtocol) -> UIColor?

    Parameters

    state

    Control state. Either normal or highlighted.
    session

    Target session.

    Return Value

    UIColor

Card Input Fields

  • Card input fields font.

    Declaration

    Swift

    @objc(cardInputFieldsFontForSession:)
optional func cardInputFieldsFont(for session: SessionProtocol) -> UIFont

    Parameters

    session

    Target session.

    Return Value

    UIFont

  • Card input fields text color.

    Declaration

    Swift

    @objc(cardInputFieldsTextColorForSession:)
optional func cardInputFieldsTextColor(for session: SessionProtocol) -> UIColor?

    Parameters

    session

    Target session.

    Return Value

    UIColor

  • Card input fields placeholder color.

    Declaration

    Swift

    @objc(cardInputFieldsPlaceholderColorForSession:)
optional func cardInputFieldsPlaceholderColor(for session: SessionProtocol) -> UIColor?

    Parameters

    session

    Target session.

    Return Value

    UIColor

  • Card input fields invalid text color.

    Declaration

    Swift

    @objc(cardInputFieldsInvalidTextColorForSession:)
optional func cardInputFieldsInvalidTextColor(for session: SessionProtocol) -> UIColor?

    Parameters

    session

    Target session.

    Return Value

    UIColor

Card Input Description

  • Card input fields description font.

    Declaration

    Swift

    @objc(cardInputDescriptionFontForSession:)
optional func cardInputDescriptionFont(for session: SessionProtocol) -> UIFont

    Parameters

    session

    Target session.

    Return Value

    UIFont

  • Card input fields description text color.

    Declaration

    Swift

    @objc(cardInputDescriptionTextColorForSession:)
optional func cardInputDescriptionTextColor(for session: SessionProtocol) -> UIColor?

    Parameters

    session

    Target session.

    Return Value

    UIColor

  • Card input save card switch off tint color.

    Declaration

    Swift

    @objc(cardInputSaveCardSwitchOffTintColorForSession:)
optional func cardInputSaveCardSwitchOffTintColor(for session: SessionProtocol) -> UIColor?

    Parameters

    session

    Target session.

    Return Value

    UIColor

  • Card input save card switch on tint color.

    Declaration

    Swift

    @objc(cardInputSaveCardSwitchOnTintColorForSession:)
optional func cardInputSaveCardSwitchOnTintColor(for session: SessionProtocol) -> UIColor?

    Parameters

    session

    Target session.

    Return Value

    UIColor

  • Card input save card switch thumb tint color.

    Declaration

    Swift

    @objc(cardInputSaveCardSwitchThumbTintColorForSession:)
optional func cardInputSaveCardSwitchThumbTintColor(for session: SessionProtocol) -> UIColor?

    Parameters

    session

    Target session.

    Return Value

    UIColor

  • Card input scan icon frame tint color.

    Declaration

    Swift

    @objc(cardInputScanIconFrameTintColorForSession:)
optional func cardInputScanIconFrameTintColor(for session: SessionProtocol) -> UIColor?

    Parameters

    session

    Target session.

    Return Value

    UIColor

  • Card input scan icon tint color.

    Declaration

    Swift

    @objc(cardInputScanIconTintColorForSession:)
optional func cardInputScanIconTintColor(for session: SessionProtocol) -> UIColor?

    Parameters

    session

    Target session.

    Return Value

    UIColor

Pay/Save Button

  • Pay/Save button background color for the given state.

    Declaration

    Swift

    @objc(tapButtonBackgroundColorForState:session:)
optional func tapButtonBackgroundColor(for state: UIControl.State, session: SessionProtocol) -> UIColor?

    Parameters

    state

    Control state.
    session

    Target session.

    Return Value

    UIColor

  • Pay/Save button font.

    Declaration

    Swift

    @objc(tapButtonFontForSession:)
optional func tapButtonFont(for session: SessionProtocol) -> UIFont

    Parameters

    session

    Target session.

    Return Value

    UIFont

  • Pay/Save button text color for the given state.

    Declaration

    Swift

    @objc(tapButtonTextColorForState:session:)
optional func tapButtonTextColor(for state: UIControl.State, session: SessionProtocol) -> UIColor?

    Parameters

    state

    Control state.
    session

    Target session.

    Return Value

    UIColor

  • Pay/Save button corner radius.

    Declaration

    Swift

    @objc(tapButtonCornerRadiusForSession:)
optional func tapButtonCornerRadius(for session: SessionProtocol) -> CGFloat

    Parameters

    session

    Target session.

    Return Value

    CGFloat

  • Defines if loader is visible on Pay/Save button.

    Declaration

    Swift

    @objc(isLoaderVisibleOnTapButttonForSession:)
optional func isLoaderVisibleOnTapButtton(for session: SessionProtocol) -> Bool

    Parameters

    session

    Target session.

    Return Value

    Bool

  • Defines if security icon is visible on Pay/Save button.

    Declaration

    Swift

    @objc(isSecurityIconVisibleOnTapButtonForSession:)
optional func isSecurityIconVisibleOnTapButton(for session: SessionProtocol) -> Bool

    Parameters

    session

    Target session.

    Return Value

    Bool

  • Pay/Save button insets on payment/card saving screen from the edges (left, right and bottom) of the screen and content.

    Declaration

    Swift

    @objc(tapButtonInsetsForSession:)
optional func tapButtonInsets(for session: SessionProtocol) -> UIEdgeInsets

    Parameters

    session

    Target session.

    Return Value

    UIEdgeInsets

  • Pay/Save button height on payment/card saving screen.

    Declaration

    Swift

    @objc(tapButtonHeightForSession:)
optional func tapButtonHeight(for session: SessionProtocol) -> CGFloat

    Parameters

    session

    Target session.

    Return Value

    CGFloat