NetIQ Mobile SDK for iOS  2.0
Access Manager iOS Framework for OAuth & OIDC
<OIDAuthorizationFlowSession > Protocol Reference

Represents an in-flight authorization flow session. More...

#import <OIDAuthorizationService.h>

Inherits <NSObjectNSObject>.

Instance Methods

(void) - cancel
 Cancels the code flow session, invoking the request's callback with a cancelled error. More...
 
(BOOL) - resumeAuthorizationFlowWithURL:
 Clients should call this method with the result of the authorization code flow if it becomes available. More...
 
(void) - failAuthorizationFlowWithError:
 OIDAuthorizationUICoordinator or clients should call this method when the authorization flow failed with a non-OAuth error. More...
 

Detailed Description

Represents an in-flight authorization flow session.

Method Documentation

◆ cancel()

- (void OIDAuthorizationFlowSession) cancel

Cancels the code flow session, invoking the request's callback with a cancelled error.

Remarks
Has no effect if called more than once, or after a OIDAuthorizationFlowSession.resumeAuthorizationFlowWithURL: message was received. Will cause an error with code: ::OIDErrorCodeProgramCanceledAuthorizationFlow to be passed to the callback block passed to presentAuthorizationRequest:presentingViewController:callback: (OIDAuthorizationService(IOS))

◆ failAuthorizationFlowWithError:()

- (void OIDAuthorizationFlowSession) failAuthorizationFlowWithError: (NSError *)  error

OIDAuthorizationUICoordinator or clients should call this method when the authorization flow failed with a non-OAuth error.

Parameters
errorThe error that is the reason for the failure of this authorization flow.
Remarks
Has no effect if called more than once, or after a cancel message was received.

◆ resumeAuthorizationFlowWithURL:()

- (BOOL OIDAuthorizationFlowSession) resumeAuthorizationFlowWithURL: (NSURL *)  URL

Clients should call this method with the result of the authorization code flow if it becomes available.

Parameters
URLThe redirect URL invoked by the authorization server. When the URL represented a valid authorization response, implementations should clean up any left-over UI state from the authorization, for example by closing the or looback HTTP listener if those were used. The completion block of the pending authorization request should then be invoked.
Remarks
Has no effect if called more than once, or after a cancel message was received.
Returns
YES if the passed URL matches the expected redirect URL and was consumed, NO otherwise.

The documentation for this protocol was generated from the following file: