View on GitHub
STPPaymentCardTextFieldDelegate Protocol Reference
STPPaymentCardTextFieldDelegate
Objective-C
@protocol STPPaymentCardTextFieldDelegate <NSObject>Swift
protocol STPPaymentCardTextFieldDelegate : NSObjectProtocolThis protocol allows a delegate to be notified when a payment text field’s contents change, which can in turn be used to take further actions depending on the validity of its contents.
-
Called when either the card number, expiration, or CVC changes. At this point, one can call
isValidon the text field to determine, for example, whether or not to enable a button to submit the form. Example:(void)paymentCardTextFieldDidChange:(STPPaymentCardTextField *)textField { self.paymentButton.enabled = textField.isValid; }
Declaration
Objective-C
- (void)paymentCardTextFieldDidChange: (nonnull STPPaymentCardTextField *)textField;Swift
optional func paymentCardTextFieldDidChange(_ textField: STPPaymentCardTextField)Parameters
textFieldthe text field that has changed
-
Called when editing begins in the text field as a whole.
After receiving this callback, you will always also receive a callback for which specific subfield of the view began editing.
Declaration
Objective-C
- (void)paymentCardTextFieldDidBeginEditing: (nonnull STPPaymentCardTextField *)textField;Swift
optional func paymentCardTextFieldDidBeginEditing(_ textField: STPPaymentCardTextField) -
Notification that the user pressed the
returnkey after completely filling out the STPPaymentCardTextField with data that passes validation.The Stripe SDK is going to
resignFirstResponderon theSTPPaymentCardTextFieldto dismiss the keyboard after this delegate method returns, however if your app wants to do something more (ex: move first responder to another field), this is a good opportunity to do that.This is delivered before the corresponding
paymentCardTextFieldDidEndEditing:Declaration
Objective-C
- (void)paymentCardTextFieldWillEndEditingForReturn: (nonnull STPPaymentCardTextField *)textField;Swift
optional func paymentCardTextFieldWillEndEditing(forReturn textField: STPPaymentCardTextField)Parameters
textFieldThe STPPaymentCardTextField that was being edited when the user pressed return
-
Called when editing ends in the text field as a whole.
This callback is always preceded by an callback for which specific subfield of the view ended its editing.
Declaration
Objective-C
- (void)paymentCardTextFieldDidEndEditing: (nonnull STPPaymentCardTextField *)textField;Swift
optional func paymentCardTextFieldDidEndEditing(_ textField: STPPaymentCardTextField) -
Called when editing begins in the payment card field’s number field.
Declaration
Objective-C
- (void)paymentCardTextFieldDidBeginEditingNumber: (nonnull STPPaymentCardTextField *)textField;Swift
optional func paymentCardTextFieldDidBeginEditingNumber(_ textField: STPPaymentCardTextField) -
Called when editing ends in the payment card field’s number field.
Declaration
Objective-C
- (void)paymentCardTextFieldDidEndEditingNumber: (nonnull STPPaymentCardTextField *)textField;Swift
optional func paymentCardTextFieldDidEndEditingNumber(_ textField: STPPaymentCardTextField) -
Called when editing begins in the payment card field’s CVC field.
Declaration
Objective-C
- (void)paymentCardTextFieldDidBeginEditingCVC: (nonnull STPPaymentCardTextField *)textField;Swift
optional func paymentCardTextFieldDidBeginEditingCVC(_ textField: STPPaymentCardTextField) -
Called when editing ends in the payment card field’s CVC field.
Declaration
Objective-C
- (void)paymentCardTextFieldDidEndEditingCVC: (nonnull STPPaymentCardTextField *)textField;Swift
optional func paymentCardTextFieldDidEndEditingCVC(_ textField: STPPaymentCardTextField) -
Called when editing begins in the payment card field’s expiration field.
Declaration
Objective-C
- (void)paymentCardTextFieldDidBeginEditingExpiration: (nonnull STPPaymentCardTextField *)textField;Swift
optional func paymentCardTextFieldDidBeginEditingExpiration(_ textField: STPPaymentCardTextField) -
Called when editing ends in the payment card field’s expiration field.
Declaration
Objective-C
- (void)paymentCardTextFieldDidEndEditingExpiration: (nonnull STPPaymentCardTextField *)textField;Swift
optional func paymentCardTextFieldDidEndEditingExpiration(_ textField: STPPaymentCardTextField) -
Called when editing begins in the payment card field’s ZIP/postal code field.
Declaration
Objective-C
- (void)paymentCardTextFieldDidBeginEditingPostalCode: (nonnull STPPaymentCardTextField *)textField;Swift
optional func paymentCardTextFieldDidBeginEditingPostalCode(_ textField: STPPaymentCardTextField) -
Called when editing ends in the payment card field’s ZIP/postal code field.
Declaration
Objective-C
- (void)paymentCardTextFieldDidEndEditingPostalCode: (nonnull STPPaymentCardTextField *)textField;Swift
optional func paymentCardTextFieldDidEndEditingPostalCode(_ textField: STPPaymentCardTextField)