Showing content from http://openid.github.io/AppAuth-iOS/docs/latest/interface_o_i_d_auth_state.html below:
AppAuth: OIDAuthState Class Reference
A convenience class that retains the auth state between OIDAuthorizationResponses and OIDTokenResponses. More...
#import <OIDAuthState.h>
(instancetype) - initWithAuthorizationResponse: Creates an auth state from an authorization response. More...
(instancetype) - initWithAuthorizationResponse:tokenResponse: Creates an auth state from an authorization and token response. More...
(instancetype) - initWithRegistrationResponse: Creates an auth state from an registration response. More...
(instancetype) - initWithAuthorizationResponse:tokenResponse:registrationResponse: Creates an auth state from an authorization, token and registration response. More...
(void) - updateWithAuthorizationResponse:error: Updates the authorization state based on a new authorization response. More...
(void) - updateWithTokenResponse:error: Updates the authorization state based on a new token response. More...
(void) - updateWithRegistrationResponse: Updates the authorization state based on a new registration response. More...
(void) - updateWithAuthorizationError: Updates the authorization state based on an authorization error. More...
(void) - performActionWithFreshTokens: Calls the block with a valid access token (refreshing it first, if needed), or if a refresh was needed and failed, with the error that caused it to fail. More...
(void) - performActionWithFreshTokens:additionalRefreshParameters: Calls the block with a valid access token (refreshing it first, if needed), or if a refresh was needed and failed, with the error that caused it to fail. More...
(void) - performActionWithFreshTokens:additionalRefreshParameters:dispatchQueue: Calls the block with a valid access token (refreshing it first, if needed), or if a refresh was needed and failed, with the error that caused it to fail. More...
(void) - setNeedsTokenRefresh Forces a token refresh the next time performActionWithFreshTokens: is called, even if the current tokens are considered valid.
(nullable OIDTokenRequest *) - tokenRefreshRequest Creates a token request suitable for refreshing an access token. More...
(nullable OIDTokenRequest *) - tokenRefreshRequestWithAdditionalParameters: Creates a token request suitable for refreshing an access token. More...
A convenience class that retains the auth state between OIDAuthorizationResponses and OIDTokenResponses.
◆ authStateByPresentingAuthorizationRequest:externalUserAgent:callback:() ◆ authStateByPresentingAuthorizationRequest:presentingViewController:callback:() ◆ initWithAuthorizationResponse:()
Creates an auth state from an authorization response.
-
Parameters
-
authorizationResponse The authorization response.
◆ initWithAuthorizationResponse:tokenResponse:()
Creates an auth state from an authorization and token response.
-
Parameters
-
authorizationResponse The authorization response. tokenResponse The token response.
◆ initWithAuthorizationResponse:tokenResponse:registrationResponse:()
Creates an auth state from an authorization, token and registration response.
-
Parameters
-
authorizationResponse The authorization response. tokenResponse The token response. registrationResponse The registration response.
◆ initWithRegistrationResponse:()
Creates an auth state from an registration response.
-
Parameters
-
registrationResponse The registration response.
◆ performActionWithFreshTokens:()
Calls the block with a valid access token (refreshing it first, if needed), or if a refresh was needed and failed, with the error that caused it to fail.
-
Parameters
-
action The block to execute with a fresh token. This block will be executed on the main thread.
◆ performActionWithFreshTokens:additionalRefreshParameters:()
Calls the block with a valid access token (refreshing it first, if needed), or if a refresh was needed and failed, with the error that caused it to fail.
-
Parameters
-
action The block to execute with a fresh token. This block will be executed on the main thread. additionalParameters Additional parameters for the token request if token is refreshed.
◆ performActionWithFreshTokens:additionalRefreshParameters:dispatchQueue:()
Calls the block with a valid access token (refreshing it first, if needed), or if a refresh was needed and failed, with the error that caused it to fail.
-
Parameters
-
action The block to execute with a fresh token. This block will be executed on the main thread. additionalParameters Additional parameters for the token request if token is refreshed. dispatchQueue The dispatchQueue on which to dispatch the action block.
◆ tokenRefreshRequest() ◆ tokenRefreshRequestWithAdditionalParameters:() - (nullable OIDTokenRequest *) tokenRefreshRequestWithAdditionalParameters: (nullable NSDictionary< NSString *, NSString * > *) additionalParameters ◆ updateWithAuthorizationError:() - (void) updateWithAuthorizationError: (NSError *) authorizationError
Updates the authorization state based on an authorization error.
-
Parameters
-
◆ updateWithAuthorizationResponse:error:() - (void) updateWithAuthorizationResponse: (nullable OIDAuthorizationResponse *) authorizationResponse error: (nullable NSError *) error
Updates the authorization state based on a new authorization response.
-
Parameters
-
authorizationResponse The new authorization response to update the state with. error Any error encountered when performing the authorization request. Errors in the domain
OIDOAuthAuthorizationErrorDomain are reflected in the auth state, other errors are assumed to be transient, and ignored. @discussion Typically called with the response from an incremental authorization request, or if using the implicit flow. Will clear the lastTokenResponse property.
◆ updateWithRegistrationResponse:()
Updates the authorization state based on a new registration response.
-
Parameters
-
registrationResponse The new registration response to update the state with. @discussion Typically called with the response from a successful client registration request. Will reset the auth state.
◆ updateWithTokenResponse:error:() - (void) updateWithTokenResponse: (nullable OIDTokenResponse *) tokenResponse error: (nullable NSError *) error
Updates the authorization state based on a new token response.
-
Parameters
-
tokenResponse The new token response to update the state from. error Any error encountered when performing the authorization request. Errors in the domain
OIDOAuthTokenErrorDomain are reflected in the auth state, other errors are assumed to be transient, and ignored. @discussion Typically called with the response from an authorization code exchange, or a token refresh.
◆ refreshToken - (NSString*) refreshToken readnonatomicassign ◆ scope
The scope of the current authorization grant. @discussion This represents the latest scope returned by the server and may be a subset of the scope that was initially granted.
The documentation for this class was generated from the following file:
RetroSearch is an open source project built by @garambo
| Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4