STPThreeDSUICustomization
Objective-C
@interface STPThreeDSUICustomization : NSObject
Swift
class 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.
-
The default settings. See individual properties for their default values.
Declaration
Objective-C
+ (nonnull instancetype)defaultSettings;
Swift
class func defaultSettings() -> Self
-
Provides custom settings for the UINavigationBar of all UIViewControllers displayed during 3D Secure authentication. The default is
[STPThreeDSNavigationBarCustomization defaultSettings]
.Declaration
Objective-C
@property (nonatomic, strong) STPThreeDSNavigationBarCustomization *_Nonnull navigationBarCustomization;
Swift
var navigationBarCustomization: STPThreeDSNavigationBarCustomization { get set }
-
Provides custom settings for labels. The default is
[STPThreeDSLabelCustomization defaultSettings]
.Declaration
Objective-C
@property (nonatomic, strong) STPThreeDSLabelCustomization *_Nonnull labelCustomization;
Swift
var labelCustomization: STPThreeDSLabelCustomization { get set }
-
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 }
-
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 }
-
Provides custom settings for the footer the challenge view can display containing additional details. The default is
[STPThreeDSFooterCustomization defaultSettings]
.Declaration
Objective-C
@property (nonatomic, strong) STPThreeDSFooterCustomization *_Nonnull footerCustomization;
Swift
var footerCustomization: STPThreeDSFooterCustomization { get set }
-
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.
-
Retrieves a button customization object for the given button type.
See
STPThreeDSButtonCustomizationDeclaration
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.
-
Provides custom settings for radio buttons and checkboxes. The default is
[STPThreeDSSelectionCustomization defaultSettings]
.Declaration
Objective-C
@property (nonatomic, strong) STPThreeDSSelectionCustomization *_Nonnull selectionCustomization;
Swift
var selectionCustomization: STPThreeDSSelectionCustomization { get set }
-
The style of
UIActivityIndicatorView
s displayed. This should contrast withbackgroundColor
. Defaults to gray.Declaration
Objective-C
@property (nonatomic) UIActivityIndicatorViewStyle activityIndicatorViewStyle;
Swift
var activityIndicatorViewStyle: UIActivityIndicatorView.Style { get set }
-
The style of the
UIBlurEffect
displayed underneath theUIActivityIndicatorView
. Defaults toUIBlurEffectStyleLight
.Declaration
Objective-C
@property (nonatomic) UIBlurEffectStyle blurStyle;
Swift
var blurStyle: UIBlurEffect.Style { get set }