OIDAuthState.h

Go to the documentation of this file.

 
#import <Foundation/Foundation.h>
 
@class OIDAuthorizationRequest;
@class OIDAuthorizationResponse;
@class OIDAuthState;
@class OIDRegistrationResponse;
@class OIDTokenResponse;
@class OIDTokenRequest;
@protocol OIDAuthStateChangeDelegate;
@protocol OIDAuthStateErrorDelegate;
@protocol OIDExternalUserAgent;
@protocol OIDExternalUserAgentSession;
 
NS_ASSUME_NONNULL_BEGIN
 
typedef void (^OIDAuthStateAction)(NSString *_Nullable accessToken,
                                   NSString *_Nullable idToken,
                                   NSError *_Nullable error);
 
typedef void (^OIDAuthStateAuthorizationCallback)(OIDAuthState *_Nullable authState,
                                                  NSError *_Nullable error);
 
@interface OIDAuthState : NSObject <NSSecureCoding>
 
@property(nonatomic, readonly, nullable) NSString *refreshToken;
 
@property(nonatomic, readonly, nullable) NSString *scope;
 
@property(nonatomic, readonly) OIDAuthorizationResponse *lastAuthorizationResponse;
 
@property(nonatomic, readonly, nullable) OIDTokenResponse *lastTokenResponse;
 
@property(nonatomic, readonly, nullable) OIDRegistrationResponse *lastRegistrationResponse;
 
@property(nonatomic, readonly, nullable) NSError *authorizationError;
 
@property(nonatomic, readonly) BOOL isAuthorized;
 
@property(nonatomic, weak, nullable) id<OIDAuthStateChangeDelegate> stateChangeDelegate;
 
@property(nonatomic, weak, nullable) id<OIDAuthStateErrorDelegate> errorDelegate;
 
+ (id<OIDExternalUserAgentSession>)
    authStateByPresentingAuthorizationRequest:(OIDAuthorizationRequest *)authorizationRequest
                            externalUserAgent:(id<OIDExternalUserAgent>)externalUserAgent
                                     callback:(OIDAuthStateAuthorizationCallback)callback;
 
- (instancetype)init NS_UNAVAILABLE;
 
- (instancetype)initWithAuthorizationResponse:(OIDAuthorizationResponse *)authorizationResponse;
 
- (instancetype)initWithAuthorizationResponse:(OIDAuthorizationResponse *)authorizationResponse
                                tokenResponse:(nullable OIDTokenResponse *)tokenResponse;
 
- (instancetype)initWithRegistrationResponse:(OIDRegistrationResponse *)registrationResponse;
 
- (instancetype)initWithAuthorizationResponse:
    (nullable OIDAuthorizationResponse *)authorizationResponse
           tokenResponse:(nullable OIDTokenResponse *)tokenResponse
    registrationResponse:(nullable OIDRegistrationResponse *)registrationResponse
    NS_DESIGNATED_INITIALIZER;
 
- (void)updateWithAuthorizationResponse:(nullable OIDAuthorizationResponse *)authorizationResponse
                                  error:(nullable NSError *)error;
 
- (void)updateWithTokenResponse:(nullable OIDTokenResponse *)tokenResponse
                          error:(nullable NSError *)error;
 
- (void)updateWithRegistrationResponse:(nullable OIDRegistrationResponse *)registrationResponse;
 
- (void)updateWithAuthorizationError:(NSError *)authorizationError;
 
- (void)performActionWithFreshTokens:(OIDAuthStateAction)action;
 
- (void)performActionWithFreshTokens:(OIDAuthStateAction)action
         additionalRefreshParameters:
    (nullable NSDictionary<NSString *, NSString *> *)additionalParameters;
 
- (void)performActionWithFreshTokens:(OIDAuthStateAction)action
         additionalRefreshParameters:
    (nullable NSDictionary<NSString *, NSString *> *)additionalParameters
                       dispatchQueue:(dispatch_queue_t)dispatchQueue;
 
- (void)setNeedsTokenRefresh;
 
- (nullable OIDTokenRequest *)tokenRefreshRequest;
 
- (nullable OIDTokenRequest *)tokenRefreshRequestWithAdditionalParameters:
    (nullable NSDictionary<NSString *, NSString *> *)additionalParameters;
 
@end
 
NS_ASSUME_NONNULL_END