Package apple.authenticationservices

Class ASWebAuthenticationSession

  • All Implemented Interfaces:
    NSObject
    public class ASWebAuthenticationSession
extends NSObject
    ASWebAuthenticationSession An ASWebAuthenticationSession object can be used to authenticate a user with a web service, even if the web service is run by a third party. ASWebAuthenticationSession puts the user in control of whether they want to use their existing logged-in session from Safari. The app provides a URL that points to the authentication webpage. The page will be loaded in a secure view controller. From the webpage, the user can authenticate herself and grant access to the app. On completion, the service will send a callback URL with an authentication token, and this URL will be passed to the app by ASWebAuthenticationSessionCompletionHandler. The callback URL usually has a custom URL scheme. For the app to receive the callback URL, it needs to either register the custom URL scheme in its Info.plist, or set the scheme to callbackURLScheme argument in the initializer. If the user has already logged into the web service in Safari or other apps via ASWebAuthenticationSession, it is possible to share the existing login information. An alert will be presented to get the user's consent for sharing their existing login information. If the user cancels the alert, the session will be canceled, and the completion handler will be called with the error code ASWebAuthenticationSessionErrorCodeCanceledLogin. If the user taps Cancel when showing the login webpage for the web service, the session will be canceled, and the completion handler will be called with the error code ASWebAuthenticationSessionErrorCodeCanceledLogin. The app can cancel the session by calling -[ASWebAuthenticationSession cancel]. This will also dismiss the view controller that is showing the web service's login page.

    • Constructor Detail

      • ASWebAuthenticationSession

        protected ASWebAuthenticationSession​(org.moe.natj.general.Pointer peer)

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • allocWithZone

        public static java.lang.Object allocWithZone​(org.moe.natj.general.ptr.VoidPtr zone)

      • automaticallyNotifiesObserversForKey

        public static boolean automaticallyNotifiesObserversForKey​(java.lang.String key)

      • cancel

        public void cancel()
        Cancel an ASWebAuthenticationSession. If the view controller is already presented to load the webpage for authentication, it will be dismissed. Calling cancel on an already canceled session will have no effect.

      • cancelPreviousPerformRequestsWithTarget

        public static void cancelPreviousPerformRequestsWithTarget​(java.lang.Object aTarget)

      • cancelPreviousPerformRequestsWithTargetSelectorObject

        public static void cancelPreviousPerformRequestsWithTargetSelectorObject​(java.lang.Object aTarget,
                                                                         org.moe.natj.objc.SEL aSelector,
                                                                         java.lang.Object anArgument)

      • classFallbacksForKeyedArchiver

        public static NSArray<java.lang.String> classFallbacksForKeyedArchiver()

      • classForKeyedUnarchiver

        public static org.moe.natj.objc.Class classForKeyedUnarchiver()

      • debugDescription_static

        public static java.lang.String debugDescription_static()

      • description_static

        public static java.lang.String description_static()

      • hash_static

        public static long hash_static()

      • initWithURLCallbackURLSchemeCompletionHandler

        public ASWebAuthenticationSession initWithURLCallbackURLSchemeCompletionHandler​(NSURL URL,
                                                                                java.lang.String callbackURLScheme,
                                                                                ASWebAuthenticationSession.Block_initWithURLCallbackURLSchemeCompletionHandler completionHandler)
        Returns an ASWebAuthenticationSession object.
        Parameters:
        URL - the initial URL pointing to the authentication webpage. Only supports URLs with http:// or https:// schemes.
        callbackURLScheme - the custom URL scheme that the app expects in the callback URL.
        completionHandler - the completion handler which is called when the session is completed successfully or canceled by user.

      • instanceMethodSignatureForSelector

        public static NSMethodSignature instanceMethodSignatureForSelector​(org.moe.natj.objc.SEL aSelector)

      • instancesRespondToSelector

        public static boolean instancesRespondToSelector​(org.moe.natj.objc.SEL aSelector)

      • isSubclassOfClass

        public static boolean isSubclassOfClass​(org.moe.natj.objc.Class aClass)

      • keyPathsForValuesAffectingValueForKey

        public static NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey​(java.lang.String key)

      • new_objc

        public static java.lang.Object new_objc()

      • prefersEphemeralWebBrowserSession

        public boolean prefersEphemeralWebBrowserSession()
        Indicates whether this session should ask the browser for an ephemeral session. Ephemeral web browser sessions do not not share cookies or other browsing data with a user's normal browser session. This value is NO by default. Setting this property after calling -[ASWebAuthenticationSession start] has no effect.

      • presentationContextProvider

        public ASWebAuthenticationPresentationContextProviding presentationContextProvider()
        Provides context to target where in an application's UI the authorization view should be shown. A provider must be set prior to calling -start, otherwise the authorization view cannot be displayed. If deploying to iOS prior to 13.0, the desired window is inferred by the application's key window.

      • resolveClassMethod

        public static boolean resolveClassMethod​(org.moe.natj.objc.SEL sel)

      • resolveInstanceMethod

        public static boolean resolveInstanceMethod​(org.moe.natj.objc.SEL sel)

      • setPrefersEphemeralWebBrowserSession

        public void setPrefersEphemeralWebBrowserSession​(boolean value)
        Indicates whether this session should ask the browser for an ephemeral session. Ephemeral web browser sessions do not not share cookies or other browsing data with a user's normal browser session. This value is NO by default. Setting this property after calling -[ASWebAuthenticationSession start] has no effect.

      • setPresentationContextProvider_unsafe

        public void setPresentationContextProvider_unsafe​(ASWebAuthenticationPresentationContextProviding value)
        Provides context to target where in an application's UI the authorization view should be shown. A provider must be set prior to calling -start, otherwise the authorization view cannot be displayed. If deploying to iOS prior to 13.0, the desired window is inferred by the application's key window.

      • setPresentationContextProvider

        public void setPresentationContextProvider​(ASWebAuthenticationPresentationContextProviding value)
        Provides context to target where in an application's UI the authorization view should be shown. A provider must be set prior to calling -start, otherwise the authorization view cannot be displayed. If deploying to iOS prior to 13.0, the desired window is inferred by the application's key window.

      • setVersion_static

        public static void setVersion_static​(long aVersion)

      • start

        public boolean start()
        Starts the ASWebAuthenticationSession instance after it is instantiated. start can only be called once for an ASWebAuthenticationSession instance. This also means calling start on a canceled session will fail.
        Returns:
        Returns YES if the session starts successfully.

      • superclass_static

        public static org.moe.natj.objc.Class superclass_static()

      • version_static

        public static long version_static()

      • canStart

        public boolean canStart()
        Returns whether the session can be successfully started. This property returns the same value as calling -start, but without the side effect of actually starting the session.