08a40b3516
* GoogleSignIn (4.4.0 -> 5.0.2) * GTMSessionFetcher (1.5.0 -> 1.7.2) * GoogleToolboxForMac (Removed)
85 lines
4.4 KiB
Objective-C
85 lines
4.4 KiB
Objective-C
/*! @file OIDAuthState+IOS.h
|
|
@brief AppAuth iOS SDK
|
|
@copyright
|
|
Copyright 2016 Google Inc. All Rights Reserved.
|
|
@copydetails
|
|
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.
|
|
*/
|
|
|
|
#import <TargetConditionals.h>
|
|
|
|
#if TARGET_OS_IOS || TARGET_OS_MACCATALYST
|
|
|
|
#import <UIKit/UIKit.h>
|
|
|
|
#import "OIDAuthState.h"
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
/*! @brief iOS specific convenience methods for @c OIDAuthState.
|
|
*/
|
|
@interface OIDAuthState (IOS)
|
|
|
|
/*! @brief Convenience method to create a @c OIDAuthState by presenting an authorization request
|
|
and performing the authorization code exchange in the case of code flow requests. For
|
|
the hybrid flow, the caller should validate the id_token and c_hash, then perform the token
|
|
request (@c OIDAuthorizationService.performTokenRequest:callback:)
|
|
and update the OIDAuthState with the results (@c
|
|
OIDAuthState.updateWithTokenResponse:error:).
|
|
@param authorizationRequest The authorization request to present.
|
|
@param presentingViewController The view controller to use for presenting the authentication UI.
|
|
@param callback The method called when the request has completed or failed.
|
|
@return A @c OIDExternalUserAgentSession instance which will terminate when it
|
|
receives a @c OIDExternalUserAgentSession.cancel message, or after processing a
|
|
@c OIDExternalUserAgentSession.resumeExternalUserAgentFlowWithURL: message.
|
|
*/
|
|
+ (id<OIDExternalUserAgentSession>)
|
|
authStateByPresentingAuthorizationRequest:(OIDAuthorizationRequest *)authorizationRequest
|
|
presentingViewController:(UIViewController *)presentingViewController
|
|
callback:(OIDAuthStateAuthorizationCallback)callback;
|
|
|
|
/*! @brief Convenience method to create a @c OIDAuthState by presenting an authorization request
|
|
(optionally using an emphemeral browser session that shares no cookies or data with the
|
|
normal browser session) and performing the authorization code exchange in the case of code
|
|
flow requests. For the hybrid flow, the caller should validate the id_token and c_hash, then
|
|
perform the token request (@c OIDAuthorizationService.performTokenRequest:callback:)
|
|
and update the OIDAuthState with the results (@c
|
|
OIDAuthState.updateWithTokenResponse:error:).
|
|
@param authorizationRequest The authorization request to present.
|
|
@param presentingViewController The view controller to use for presenting the authentication UI.
|
|
@param prefersEphemeralSession Whether the caller prefers to use a private authentication
|
|
session. See @c ASWebAuthenticationSession.prefersEphemeralWebBrowserSession for more.
|
|
@param callback The method called when the request has completed or failed.
|
|
@return A @c OIDExternalUserAgentSession instance which will terminate when it
|
|
receives a @c OIDExternalUserAgentSession.cancel message, or after processing a
|
|
@c OIDExternalUserAgentSession.resumeExternalUserAgentFlowWithURL: message.
|
|
*/
|
|
+ (id<OIDExternalUserAgentSession>)
|
|
authStateByPresentingAuthorizationRequest:(OIDAuthorizationRequest *)authorizationRequest
|
|
presentingViewController:(UIViewController *)presentingViewController
|
|
prefersEphemeralSession:(BOOL)prefersEphemeralSession
|
|
callback:(OIDAuthStateAuthorizationCallback)callback
|
|
API_AVAILABLE(ios(13));
|
|
|
|
+ (id<OIDExternalUserAgentSession>)
|
|
authStateByPresentingAuthorizationRequest:(OIDAuthorizationRequest *)authorizationRequest
|
|
callback:(OIDAuthStateAuthorizationCallback)callback API_AVAILABLE(ios(11)) API_UNAVAILABLE(macCatalyst)
|
|
__deprecated_msg("This method will not work on iOS 13. Use "
|
|
"authStateByPresentingAuthorizationRequest:presentingViewController:callback:");
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|
|
|
|
#endif // TARGET_OS_IOS || TARGET_OS_MACCATALYST
|