+ View on GitHub
+ 
+ STPRedirectContext Class Reference
+ STPRedirectContext
+
+@interface STPRedirectContext : NSObjectThis is a helper class for handling redirect sources.
+ +Init an instance with the redirect flow source you want to handle, + then choose a redirect method. The context will fire the completion handler + when the redirect completes.
+ +Due to the nature of iOS, very little concrete information can be gained
+ during this process, as all actions take place in either the Safari app
+ or the sandboxed SFSafariViewController class. The context attempts to
+ detect when the user has completed the necessary redirect action by listening
+ for both app foregrounds and url callbacks received in the app delegate.
+ However, it is possible the when the redirect is completed
, the user may
+ have not actually completed the necessary actions to authorize the charge.
You can use STPAPIClient to listen for state changes on the source
+ object as a way to identify whether the user action succeeded or not.
+ - see: [STPAPIClient startPollingSourceWithId:clientSecret:timeout:completion:]
You should not use either this class, nor STPAPIClient, as a way
+ to determine when you should charge the source. Use Stripe webhooks on your
+ backend server to listen for source state changes and to make the charge.
-
+
-
+ ++
+ + + state +++ +++ + +++The current state of the context.
+ +++Declaration
+++Objective-C
+
+ +@property (readonly, nonatomic) STPRedirectContextState state;++Swift
+
+ +var state: STPRedirectContextState { get }+ Show on GitHub ++
+ -
+ ++
+ + + -initWithSource:completion: +++ +++ + +++Initializer for context.
+ +++ +Note
+You must ensure that the returnURL set up in the created source +correctly goes to your app so that users can be returned once +they complete the redirect in the web broswer.
+ +++ +Note
+Firing of the completion block does not necessarily mean the user successfully +performed the redirect action. You can re-fetch the source object using +its id and clientSecret, and poll for status updates on it to determine if +the source was sucessfully made chargeable.
+ +++ +See
+
+ +[STPAPIClient startPollingSourceWithId:clientSecret:timeout:completion:]++Declaration
+++Objective-C
+
+ +- (nullable instancetype) +initWithSource:(nonnull STPSource *)source + completion:(nonnull STPRedirectContextCompletionBlock)completion;++Swift
+
+ +init?(source: STPSource, completion: @escaping STPRedirectContextCompletionBlock)++Parameters
++ +
++ ++ ++ source +++ +++The source that needs user redirect action to be taken.
+ ++ + ++ ++ completion +++ +++A block to fire when the action is believed to have been completed.
+ +++Return Value
+Nil if the specified source is not a redirect-flow source. Otherwise a new context object.
+ ++ Show on GitHub ++
+ -
+ ++
+ + + -init +++ +++ + +++Use
+ +initWithSource:completion:++Declaration
+++Objective-C
+
+ +- (nonnull instancetype)init;+ Show on GitHub ++
+ -
+ ++
+ + + -startRedirectFlowFromViewController: +++ +++ + +++Starts a redirect flow.
+ +You must ensure that your app delegate listens for the
+ +returnURLthat you + set on your source object, and forwards it to the Stripe SDK so that the + context can be notified when the redirect is completed and dismiss the + view controller. See[Stripe handleStripeURLCallbackWithURL:]The context will listen for both received URLs and app open notifications + and fire its completion block when either the URL is received, or the next + time the app is foregrounded.
+ +If the app is running on iOS 9+ it will initiate the flow by presenting + a SFSafariViewController instance from the pass in view controller. + Otherwise, if the app is running on iOS 8 it will initiate the flow by + bouncing the user out to the Safari app. If you want more manual control + over the redirect method, you can use
+ +startSafariViewControllerRedirectFlowFromViewController+ orstartSafariAppRedirectFlow++ +Note
+This method does nothing if the context is not in the
+ +STPRedirectContextStateNotStartedstate.++Declaration
+++Objective-C
+
+ +- (void)startRedirectFlowFromViewController: + (nonnull UIViewController *)presentingViewController;++Swift
+
+ +func startRedirectFlow(fromViewController presentingViewController: Any!)++Parameters
++ +
++ + ++ ++ presentingViewController +++ +++The view controller to present the Safari view controller from.
+ ++ Show on GitHub ++
+ -
+
+ + ++
+ + +++Starts a redirect flow by presenting an SFSafariViewController in your app + from the passed in view controller.
+ +You must ensure that your app delegate listens for the
+ +returnURLthat you + set on your source object, and forwards it to the Stripe SDK so that the + context can be notified when the redirect is completed and dismiss the + view controller. See[Stripe handleStripeURLCallbackWithURL:]The context will listen for both received URLs and app open notifications + and fire its completion block when either the URL is received, or the next + time the app is foregrounded.
+ +++ +Note
+This method does nothing if the context is not in the
+ +STPRedirectContextStateNotStartedstate.++Declaration
+++Objective-C
+
+ +- (void)startSafariViewControllerRedirectFlowFromViewController: + (nonnull UIViewController *)presentingViewController;++Parameters
++ +
++ + ++ ++ presentingViewController +++ +++The view controller to present the Safari view controller from.
+ ++ Show on GitHub ++
+ -
+ ++
+ + + -startSafariAppRedirectFlow +++ +++ + +++Starts a redirect flow by calling
+ +openURLto bounce the user out to + the Safari app.The context will listen for app open notifications and fire its completion + block the next time the user re-opens the app (either manually or via url)
+ +++ +Note
+ This method does nothing if the context is not in theSTPRedirectContextStateNotStartedstate. + +++Declaration
+++Objective-C
+
+ +- (void)startSafariAppRedirectFlow;++Swift
+
+ +func startSafariAppRedirectFlow()+ Show on GitHub ++
+ -
+ ++
+ + + -cancel +++ +++ + +++Dismisses any presented views and stops listening for any +app opens or callbacks. The completion block will not be fired.
+ +++Declaration
+++Objective-C
+
+ +- (void)cancel;++Swift
+
+ +func cancel()+ Show on GitHub ++
+