STPThreeDSUICustomization

@interface STPThreeDSUICustomization : NSObject

The STPThreeDSUICustomization provides configuration for UI elements displayed during 3D Secure authentication.

Note: It’s important to configure this object appropriately before calling any STPPaymentHandler APIs. The API makes a copy of the customization settings you provide; it ignores any subsequent changes you make to your STPThreeDSUICustomization instance.

See

https://stripe.com/docs/mobile/ios/authentication

+defaultSettings
The default settings. See individual properties for their default values.
Declaration
Objective-C

+ (nonnull instancetype)defaultSettings;
Swift

class func defaultSettings() -> Self
Show on GitHub
navigationBarCustomization
Provides custom settings for the UINavigationBar of all UIViewControllers displayed during 3D Secure authentication. The default is [STPThreeDSNavigationBarCustomization defaultSettings].
Declaration
Objective-C

@property (strong, nonatomic) STPThreeDSNavigationBarCustomization *_Nonnull navigationBarCustomization;
Swift

var navigationBarCustomization: STPThreeDSNavigationBarCustomization { get set }
Show on GitHub


                    
                    
                    labelCustomization

Provides custom settings for labels. The default is [STPThreeDSLabelCustomization defaultSettings].

Declaration

Objective-C

@property (strong, nonatomic) STPThreeDSLabelCustomization *_Nonnull labelCustomization;

Swift

var labelCustomization: STPThreeDSLabelCustomization { get set }

Show on GitHub


                    
                    
                    textFieldCustomization

Provides custom settings for text fields. The default is [STPThreeDSTextFieldCustomization defaultSettings].

Declaration

Objective-C

@property (nonatomic) STPThreeDSTextFieldCustomization *_Nonnull textFieldCustomization;

Swift

var textFieldCustomization: STPThreeDSTextFieldCustomization { get set }

Show on GitHub

backgroundColor
The primary background color of all UIViewControllers displayed during 3D Secure authentication. Defaults to white.
Declaration
Objective-C

@property (nonatomic) UIColor *_Nonnull backgroundColor;
Swift

var backgroundColor: UIColor { get set }
Show on GitHub
footerCustomization
Provides custom settings for the footer the challenge view can display containing additional details. The default is [STPThreeDSFooterCustomization defaultSettings].
Declaration
Objective-C

@property (strong, nonatomic) STPThreeDSFooterCustomization *_Nonnull footerCustomization;
Swift

var footerCustomization: STPThreeDSFooterCustomization { get set }
Show on GitHub


                    
                    
                    -setButtonCustomization:forType:

Sets a given button customization for the specified type.

Declaration

Objective-C

- (void)setButtonCustomization:
            (nonnull STPThreeDSButtonCustomization *)buttonCustomization
                       forType:(STPThreeDSCustomizationButtonType)buttonType;

Swift

func setButton(_ buttonCustomization: STPThreeDSButtonCustomization, for buttonType: STPThreeDSCustomizationButtonType)

Parameters

`buttonCustomization`	The buttom customization to use.
`buttonType`	The type of button to use the customization for.

Show on GitHub


                    
                    
                    -buttonCustomizationForButtonType:

Retrieves a button customization object for the given button type.

See

STPThreeDSButtonCustomization

Declaration

Objective-C

- (nonnull STPThreeDSButtonCustomization *)buttonCustomizationForButtonType:
    (STPThreeDSCustomizationButtonType)buttonType;

Swift

func buttonCustomization(for buttonType: STPThreeDSCustomizationButtonType) -> STPThreeDSButtonCustomization

Parameters


                                buttonType

The button type to retrieve a customization object for.

Return Value

A button customization object, or the default if none was set.

Show on GitHub

selectionCustomization
Provides custom settings for radio buttons and checkboxes. The default is [STPThreeDSSelectionCustomization defaultSettings].
Declaration
Objective-C

@property (strong, nonatomic) STPThreeDSSelectionCustomization *_Nonnull selectionCustomization;
Swift

var selectionCustomization: STPThreeDSSelectionCustomization { get set }
Show on GitHub

Progress View

activityIndicatorViewStyle
The style of UIActivityIndicatorViews displayed. This should contrast with backgroundColor. Defaults to gray.
Declaration
Objective-C

@property (nonatomic) UIActivityIndicatorViewStyle activityIndicatorViewStyle;
Swift

var activityIndicatorViewStyle: UIActivityIndicatorView.Style { get set }
Show on GitHub
blurStyle
The style of the UIBlurEffect displayed underneath the UIActivityIndicatorView. Defaults to UIBlurEffectStyleLight.
Declaration
Objective-C

@property (nonatomic) UIBlurEffectStyle blurStyle;
Swift

var blurStyle: UIBlurEffect.Style { get set }
Show on GitHub