AppAuth
Classes | Typedefs
OIDAuthorizationService.h File Reference

AppAuth iOS SDK. More...

#import <Foundation/Foundation.h>

Go to the source code of this file.

Classes

class  OIDAuthorizationService
 Performs various OAuth and OpenID Connect related calls via the user agent or NSURLSession. More...
 

Typedefs

typedef void(^ OIDDiscoveryCallback) (OIDServiceConfiguration *_Nullable configuration, NSError *_Nullable error)
 Represents the type of block used as a callback for creating a service configuration from a remote OpenID Connect Discovery document. More...
 
typedef void(^ OIDAuthorizationCallback) (OIDAuthorizationResponse *_Nullable authorizationResponse, NSError *_Nullable error)
 Represents the type of block used as a callback for various methods of OIDAuthorizationService. More...
 
typedef void(^ OIDEndSessionCallback) (OIDEndSessionResponse *_Nullable endSessionResponse, NSError *_Nullable error)
 Block used as a callback for the end-session request of OIDAuthorizationService. More...
 
typedef void(^ OIDTokenCallback) (OIDTokenResponse *_Nullable tokenResponse, NSError *_Nullable error)
 Represents the type of block used as a callback for various methods of OIDAuthorizationService. More...
 
typedef NSDictionary< NSString *, NSString * > *_Nullable OIDTokenEndpointParameters
 Represents the type of dictionary used to specify additional querystring parameters when making authorization or token endpoint requests.
 
typedef void(^ OIDRegistrationCompletion) (OIDRegistrationResponse *_Nullable registrationResponse, NSError *_Nullable error)
 Represents the type of block used as a callback for various methods of OIDAuthorizationService. More...
 

Detailed Description

AppAuth iOS SDK.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Typedef Documentation

◆ OIDAuthorizationCallback

typedef void(^ OIDAuthorizationCallback) (OIDAuthorizationResponse *_Nullable authorizationResponse, NSError *_Nullable error)

Represents the type of block used as a callback for various methods of OIDAuthorizationService.

Parameters
authorizationResponseThe authorization response, if available.
errorThe error if an error occurred.

◆ OIDDiscoveryCallback

typedef void(^ OIDDiscoveryCallback) (OIDServiceConfiguration *_Nullable configuration, NSError *_Nullable error)

Represents the type of block used as a callback for creating a service configuration from a remote OpenID Connect Discovery document.

Parameters
configurationThe service configuration, if available.
errorThe error if an error occurred.

◆ OIDEndSessionCallback

typedef void(^ OIDEndSessionCallback) (OIDEndSessionResponse *_Nullable endSessionResponse, NSError *_Nullable error)

Block used as a callback for the end-session request of OIDAuthorizationService.

Parameters
endSessionResponseThe end-session response, if available.
errorThe error if an error occurred.

◆ OIDRegistrationCompletion

typedef void(^ OIDRegistrationCompletion) (OIDRegistrationResponse *_Nullable registrationResponse, NSError *_Nullable error)

Represents the type of block used as a callback for various methods of OIDAuthorizationService.

Parameters
registrationResponseThe registration response, if available.
errorThe error if an error occurred.

◆ OIDTokenCallback

typedef void(^ OIDTokenCallback) (OIDTokenResponse *_Nullable tokenResponse, NSError *_Nullable error)

Represents the type of block used as a callback for various methods of OIDAuthorizationService.

Parameters
tokenResponseThe token response, if available.
errorThe error if an error occurred.