Struct ASWebAuthenticationSession

#[repr(C)]
pub struct ASWebAuthenticationSession { /* private fields */ }

Available on crate feature ASWebAuthenticationSession only.

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.

See also Apple’s documentation

Implementations

impl ASWebAuthenticationSession

pub unsafe fn initWithURL_callbackURLScheme_completionHandler( this: Allocated<Self>, url: &NSURL, callback_url_scheme: Option<&NSString>, completion_handler: ASWebAuthenticationSessionCompletionHandler, ) -> Retained<Self>

👎Deprecated: Use initWithURL:callback:completionHandler: instead

Available on crate feature block2 only.

Returns an ASWebAuthenticationSession object.

Parameter URL: the initial URL pointing to the authentication webpage. Only supports URLs with http:// or https:// schemes.

Parameter callbackURLScheme: the custom URL scheme that the app expects in the callback URL.

Parameter completionHandler: the completion handler which is called when the session is completed successfully or canceled by user.

pub unsafe fn initWithURL_callback_completionHandler( this: Allocated<Self>, url: &NSURL, callback: &ASWebAuthenticationSessionCallback, completion_handler: ASWebAuthenticationSessionCompletionHandler, ) -> Retained<Self>

Available on crate features ASWebAuthenticationSessionCallback and block2 only.

pub unsafe fn presentationContextProvider( &self, mtm: MainThreadMarker, ) -> Option<Retained<ProtocolObject<dyn ASWebAuthenticationPresentationContextProviding>>>

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.

pub unsafe fn setPresentationContextProvider( &self, presentation_context_provider: Option<&ProtocolObject<dyn ASWebAuthenticationPresentationContextProviding>>, )

This is a weak property. Setter for presentationContextProvider.

pub unsafe fn prefersEphemeralWebBrowserSession(&self) -> bool

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.

pub unsafe fn setPrefersEphemeralWebBrowserSession( &self, prefers_ephemeral_web_browser_session: bool, )

Setter for prefersEphemeralWebBrowserSession.

pub unsafe fn additionalHeaderFields( &self, ) -> Option<Retained<NSDictionary<NSString, NSString>>>

Any additional header fields to be set when loading the initial URL. All header field names must start with the “X-” prefix.

pub unsafe fn setAdditionalHeaderFields( &self, additional_header_fields: Option<&NSDictionary<NSString, NSString>>, )

Setter for additionalHeaderFields.

pub unsafe fn canStart(&self) -> bool

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.

pub unsafe fn start(&self) -> bool

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.

pub unsafe fn cancel(&self)

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.

pub unsafe fn new() -> Retained<Self>

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

Trait Implementations

impl AsRef<ASWebAuthenticationSession> for ASWebAuthenticationSession

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<AnyObject> for ASWebAuthenticationSession

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSObject> for ASWebAuthenticationSession

fn as_ref(&self) -> &NSObject

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for ASWebAuthenticationSession

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for ASWebAuthenticationSession

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for ASWebAuthenticationSession

const NAME: &'static str = "ASWebAuthenticationSession"

The name of the Objective-C class that this type represents.

type Super = NSObject

The superclass of this class.

type ThreadKind = <<ASWebAuthenticationSession as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl Debug for ASWebAuthenticationSession

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for ASWebAuthenticationSession

type Target = NSObject

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for ASWebAuthenticationSession

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for ASWebAuthenticationSession

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for ASWebAuthenticationSession

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl PartialEq for ASWebAuthenticationSession

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for ASWebAuthenticationSession

const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl DowncastTarget for ASWebAuthenticationSession

impl Eq for ASWebAuthenticationSession