Struct ASAccountAuthenticationModificationViewController

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

Available on crate feature ASAccountAuthenticationModificationViewController only.

Implementations

impl ASAccountAuthenticationModificationViewController

pub unsafe fn extensionContext( &self, ) -> Retained<ASAccountAuthenticationModificationExtensionContext>

Available on macOS and crate feature ASAccountAuthenticationModificationExtensionContext only.

pub unsafe fn convertAccountToSignInWithAppleWithoutUserInteractionForServiceIdentifier_existingCredential_userInfo( &self, service_identifier: &ASCredentialServiceIdentifier, existing_credential: &ASPasswordCredential, user_info: Option<&NSDictionary>, )

Available on macOS and crate feature ASCredentialServiceIdentifier and crate feature ASPasswordCredential only.

This method will be called when a user initiates a Sign in with Apple upgrade request.

Parameter serviceIdentifier: The service identifier of the credential the user wishes to upgrade.

Parameter existingCredential: The current password-based credential of the account for the upgrade.

Parameter userInfo: For upgrades invoked within the extension’s containing app, any information the app wants to pass to the extension, most likely to help authorize the upgrade.

This method will be called to begin a Sign in with Apple upgrade request and will not present any extension UI. If extension UI needs to be shown, this initial request should be canceled with the ASExtensionErrorCodeUserCanceled error code. The existingCredential parameter will have an empty password for in-app upgrades. The extension should check if a user is already logged in by checking a data container shared with its containing app.

pub unsafe fn prepareInterfaceToConvertAccountToSignInWithAppleForServiceIdentifier_existingCredential_userInfo( &self, service_identifier: &ASCredentialServiceIdentifier, existing_credential: &ASPasswordCredential, user_info: Option<&NSDictionary>, )

Available on macOS and crate feature ASCredentialServiceIdentifier and crate feature ASPasswordCredential only.

This method will be called when a Sign in with Apple upgrade request requires user interaction.

Parameter serviceIdentifier: The service identifier of the credential the user wishes to upgrade.

Parameter existingCredential: The current password-based credential of the account for the upgrade.

Parameter userInfo: For upgrades invoked within the extension’s containing app, any information the app wants to pass to the extension, most likely to help authorize the upgrade.

This method will be called when the initial request is canceled with the ASExtensionErrorCodeUserCanceled error code. The implementation of this method should do any work necessary to prepare to present the extension UI. Once it finishes, the system will present the extension UI. The existingCredential parameter will have an empty password for in-app upgrades. The extension should check if a user is already logged in by checking state in a data container shared with its containing app.

pub unsafe fn changePasswordWithoutUserInteractionForServiceIdentifier_existingCredential_newPassword_userInfo( &self, service_identifier: &ASCredentialServiceIdentifier, existing_credential: &ASPasswordCredential, new_password: &NSString, user_info: Option<&NSDictionary>, )

Available on macOS and crate feature ASCredentialServiceIdentifier and crate feature ASPasswordCredential only.

This method will be called when a user initiates a strong password upgrade request.

Parameter serviceIdentifier: The service identifier of the credential the user wishes to upgrade.

Parameter existingCredential: The current password-based credential of the account for the upgrade.

Parameter newPassword: A strong password generated by the system to be used for the upgrade.

Parameter userInfo: For upgrades invoked within the extension’s containing app, any information the app wants to pass to the extension, most likely to help authorize the upgrade.

Password rules for generating the newPassword parameter can be specified with the ASAccountAuthenticationModificationSupportsUpgradeToSignInWithApple key in the extension’s Info.plist. This method will be called to begin a strong password upgrade request and will not present any extension UI. If extension UI needs to be shown, this initial request should be canceled with the ASExtensionErrorCodeUserCanceled error code. The existingCredential parameter will have an empty password for in-app upgrades. The extension should check if a user is already logged in by checking a data container shared with its containing app.

pub unsafe fn prepareInterfaceToChangePasswordForServiceIdentifier_existingCredential_newPassword_userInfo( &self, service_identifier: &ASCredentialServiceIdentifier, existing_credential: &ASPasswordCredential, new_password: &NSString, user_info: Option<&NSDictionary>, )

Available on macOS and crate feature ASCredentialServiceIdentifier and crate feature ASPasswordCredential only.

This method will be called when a strong password upgrade request requires user interaction.

Parameter serviceIdentifier: The service identifier of the credential the user wishes to upgrade.

Parameter existingCredential: The current password-based credential of the account for the upgrade.

Parameter newPassword: A strong password generated by the system to be used for the upgrade.

Parameter userInfo: For upgrades invoked within the extension’s containing app, any information the app wants to pass to the extension, most likely to help authorize the upgrade.

This method will be called when the initial request is canceled with the ASExtensionErrorCodeUserCanceled error code. The implementation of this method should do any work necessary to prepare to present the extension UI. Once it finishes, the system will present the extension UI. Password rules for generating the newPassword parameter can be specified with the ASAccountAuthenticationModificationSupportsUpgradeToSignInWithApple key in the extension’s Info.plist. The existingCredential parameter will have an empty password for in-app upgrades. The extension should check if a user is already logged in by checking state in a data container shared with its containing app.

pub unsafe fn cancelRequest(&self)

Available on macOS only.

This method will be called when the user taps the system-provided “Cancel” button shown above extension UI.

Extension UI will be dismissed as soon as this method is called. The default implementation simply cancels the request with the ASExtensionErrorCodeUserCanceled error code. Override this method to do any cleanup work before the request is canceled. The implementation of this method should still cancel the request with the ASExtensionErrorCodeUserCanceled error code once the cleanup work is completed. If the request is not canceled in 10 seconds, the system will cancel the request.

impl ASAccountAuthenticationModificationViewController

Methods declared on superclass NSViewController.

pub unsafe fn initWithNibName_bundle( this: Allocated<Self>, nib_name_or_nil: Option<&NSNibName>, nib_bundle_or_nil: Option<&NSBundle>, ) -> Retained<Self>

Available on macOS only.

pub unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>

Available on macOS only.

impl ASAccountAuthenticationModificationViewController

Methods declared on superclass NSResponder.

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

Available on macOS only.

impl ASAccountAuthenticationModificationViewController

Methods declared on superclass NSObject.

pub unsafe fn new(mtm: MainThreadMarker) -> Retained<Self>

Available on macOS only.

Methods from Deref<Target = ASViewController>

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<ASAccountAuthenticationModificationViewController> for ASAccountAuthenticationModificationViewController

fn as_ref(&self) -> &Self

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

impl AsRef<AnyObject> for ASAccountAuthenticationModificationViewController

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for ASAccountAuthenticationModificationViewController

fn as_ref(&self) -> &ASViewController

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

impl Borrow<AnyObject> for ASAccountAuthenticationModificationViewController

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for ASAccountAuthenticationModificationViewController

fn borrow(&self) -> &ASViewController

Immutably borrows from an owned value.

impl ClassType for ASAccountAuthenticationModificationViewController

const NAME: &'static str = "ASAccountAuthenticationModificationViewController"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = dyn MainThreadOnly

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 ASAccountAuthenticationModificationViewController

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

Formats the value using the given formatter.

impl Deref for ASAccountAuthenticationModificationViewController

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for ASAccountAuthenticationModificationViewController

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 ASAccountAuthenticationModificationViewController

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for ASAccountAuthenticationModificationViewController

unsafe fn encodeWithCoder(&self, coder: &NSCoder)

where Self: Sized + Message,

unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>

where Self: Sized + Message,

impl NSEditor for ASAccountAuthenticationModificationViewController

unsafe fn discardEditing(&self)

where Self: Sized + Message,

unsafe fn commitEditing(&self) -> bool

where Self: Sized + Message,

unsafe fn commitEditingWithDelegate_didCommitSelector_contextInfo( &self, delegate: Option<&AnyObject>, did_commit_selector: Option<Sel>, context_info: *mut c_void, )

where Self: Sized + Message,

unsafe fn commitEditingAndReturnError(&self) -> Result<(), Retained<NSError>>

where Self: Sized + Message,

impl NSObjectProtocol for ASAccountAuthenticationModificationViewController

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 NSSeguePerforming for ASAccountAuthenticationModificationViewController

unsafe fn prepareForSegue_sender( &self, segue: &NSStoryboardSegue, sender: Option<&AnyObject>, )

where Self: Sized + Message,

unsafe fn performSegueWithIdentifier_sender( &self, identifier: &NSString, sender: Option<&AnyObject>, )

where Self: Sized + Message,

unsafe fn shouldPerformSegueWithIdentifier_sender( &self, identifier: &NSString, sender: Option<&AnyObject>, ) -> bool

where Self: Sized + Message,

impl NSUserInterfaceItemIdentification for ASAccountAuthenticationModificationViewController

unsafe fn identifier(&self) -> Option<Retained<NSString>>

where Self: Sized + Message,

unsafe fn setIdentifier(&self, identifier: Option<&NSString>)

where Self: Sized + Message,

Setter for identifier.

impl PartialEq for ASAccountAuthenticationModificationViewController

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 ASAccountAuthenticationModificationViewController

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

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

impl DowncastTarget for ASAccountAuthenticationModificationViewController

impl Eq for ASAccountAuthenticationModificationViewController