Struct WKUserNotificationInterfaceController 

pub struct WKUserNotificationInterfaceController { /* private fields */ }

Available on crate feature WKInterfaceController only.

Apple’s documentation

Implementations

impl WKUserNotificationInterfaceController

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

pub unsafe fn notificationActions( &self, ) -> Retained<NSArray<UNNotificationAction>>

Available on crate feature objc2-user-notifications only.

pub unsafe fn setNotificationActions( &self, notification_actions: &NSArray<UNNotificationAction>, )

Available on crate feature objc2-user-notifications only.

Setter for notificationActions.

This is copied when set.

pub unsafe fn didReceiveNotification(&self, notification: &UNNotification)

Available on crate feature objc2-user-notifications only.

pub unsafe fn suggestionsForResponseToActionWithIdentifier_forNotification_inputLanguage( &self, identifier: &NSString, notification: &UNNotification, input_language: &NSString, ) -> Retained<NSArray<NSString>>

Available on crate feature objc2-user-notifications only.

pub unsafe fn performNotificationDefaultAction(&self)

pub unsafe fn performDismissAction(&self)

pub unsafe fn dismissController(&self)

👎Deprecated: use performDismissAction

pub unsafe fn didReceiveNotification_withCompletion( &self, notification: &UNNotification, completion_handler: &DynBlock<dyn Fn(WKUserNotificationInterfaceType)>, )

👎Deprecated: use didReceiveNotification:

Available on crate features block2 and objc2-user-notifications only.

impl WKUserNotificationInterfaceController

Methods declared on superclass NSObject.

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

Methods from Deref<Target = WKInterfaceController>

pub unsafe fn awakeWithContext(&self, context: Option<&AnyObject>)

Safety

context should be of the correct type.

pub unsafe fn contentFrame(&self) -> CGRect

Available on crate feature objc2-core-foundation only.

pub unsafe fn crownSequencer(&self) -> Retained<WKCrownSequencer>

Available on crate feature WKCrownSequencer only.

pub unsafe fn contentSafeAreaInsets(&self) -> UIEdgeInsets

Available on crate feature objc2-ui-kit only.

pub unsafe fn systemMinimumLayoutMargins(&self) -> NSDirectionalEdgeInsets

Available on crate feature objc2-ui-kit only.

pub unsafe fn isTableScrollingHapticFeedbackEnabled(&self) -> bool

pub unsafe fn setTableScrollingHapticFeedbackEnabled( &self, table_scrolling_haptic_feedback_enabled: bool, )

Setter for isTableScrollingHapticFeedbackEnabled.

pub unsafe fn willActivate(&self)

pub unsafe fn didDeactivate(&self)

pub unsafe fn didAppear(&self)

pub unsafe fn willDisappear(&self)

pub unsafe fn pickerDidFocus(&self, picker: &WKInterfacePicker)

Available on crate features WKInterfaceObject and WKInterfacePicker only.

pub unsafe fn pickerDidResignFocus(&self, picker: &WKInterfacePicker)

Available on crate features WKInterfaceObject and WKInterfacePicker only.

pub unsafe fn pickerDidSettle(&self, picker: &WKInterfacePicker)

Available on crate features WKInterfaceObject and WKInterfacePicker only.

pub unsafe fn table_didSelectRowAtIndex( &self, table: &WKInterfaceTable, row_index: NSInteger, )

Available on crate features WKInterfaceObject and WKInterfaceTable only.

pub unsafe fn setTitle(&self, title: Option<&NSString>)

pub unsafe fn pushControllerWithName_context( &self, name: &NSString, context: Option<&AnyObject>, )

Safety

context should be of the correct type.

pub unsafe fn popController(&self)

pub unsafe fn popToRootController(&self)

pub unsafe fn scrollToObject_atScrollPosition_animated( &self, object: &WKInterfaceObject, scroll_position: WKInterfaceScrollPosition, animated: bool, )

Available on crate feature WKInterfaceObject only.

pub unsafe fn interfaceDidScrollToTop(&self)

pub unsafe fn interfaceOffsetDidScrollToTop(&self)

pub unsafe fn interfaceOffsetDidScrollToBottom(&self)

pub unsafe fn becomeCurrentPage(&self)

pub unsafe fn presentControllerWithName_context( &self, name: &NSString, context: Option<&AnyObject>, )

Safety

context should be of the correct type.

pub unsafe fn presentControllerWithNames_contexts( &self, names: &NSArray<NSString>, contexts: Option<&NSArray>, )

Safety

contexts generic should be of the correct type.

pub unsafe fn dismissController(&self)

pub unsafe fn presentTextInputControllerWithSuggestions_allowedInputMode_completion( &self, suggestions: Option<&NSArray<NSString>>, input_mode: WKTextInputMode, completion: &DynBlock<dyn Fn(*mut NSArray)>, )

Available on crate feature block2 only.

pub unsafe fn presentTextInputControllerWithSuggestionsForLanguage_allowedInputMode_completion( &self, suggestions_handler: Option<&DynBlock<dyn Fn(NonNull<NSString>) -> *mut NSArray>>, input_mode: WKTextInputMode, completion: &DynBlock<dyn Fn(*mut NSArray)>, )

Available on crate feature block2 only.

Safety

suggestions_handler block’s return must be a valid pointer or null.

pub unsafe fn dismissTextInputController(&self)

pub unsafe fn presentMediaPlayerControllerWithURL_options_completion( &self, url: &NSURL, options: Option<&NSDictionary>, completion: &DynBlock<dyn Fn(Bool, NSTimeInterval, *mut NSError)>, )

Available on crate feature block2 only.

Safety

options generic should be of the correct type.

pub unsafe fn dismissMediaPlayerController(&self)

pub unsafe fn presentAudioRecorderControllerWithOutputURL_preset_options_completion( &self, url: &NSURL, preset: WKAudioRecorderPreset, options: Option<&NSDictionary>, completion: &DynBlock<dyn Fn(Bool, *mut NSError)>, )

Available on crate feature block2 only.

Safety

options generic should be of the correct type.

pub unsafe fn dismissAudioRecorderController(&self)

pub unsafe fn contextForSegueWithIdentifier( &self, segue_identifier: &NSString, ) -> Option<Retained<AnyObject>>

pub unsafe fn contextsForSegueWithIdentifier( &self, segue_identifier: &NSString, ) -> Option<Retained<NSArray>>

pub unsafe fn contextForSegueWithIdentifier_inTable_rowIndex( &self, segue_identifier: &NSString, table: &WKInterfaceTable, row_index: NSInteger, ) -> Option<Retained<AnyObject>>

Available on crate features WKInterfaceObject and WKInterfaceTable only.

pub unsafe fn contextsForSegueWithIdentifier_inTable_rowIndex( &self, segue_identifier: &NSString, table: &WKInterfaceTable, row_index: NSInteger, ) -> Option<Retained<NSArray>>

Available on crate features WKInterfaceObject and WKInterfaceTable only.

pub unsafe fn animateWithDuration_animations( &self, duration: NSTimeInterval, animations: &DynBlock<dyn Fn()>, )

Available on crate feature block2 only.

pub unsafe fn presentAlertControllerWithTitle_message_preferredStyle_actions( &self, title: Option<&NSString>, message: Option<&NSString>, preferred_style: WKAlertControllerStyle, actions: &NSArray<WKAlertAction>, )

Available on crate feature WKAlertAction only.

pub unsafe fn dismissAddPassesController(&self)

pub unsafe fn updateUserActivity(&self, user_activity: &NSUserActivity)

pub unsafe fn invalidateUserActivity(&self)

pub unsafe fn beginGlanceUpdates(&self)

👎Deprecated: Glances are no longer supported

pub unsafe fn endGlanceUpdates(&self)

👎Deprecated: Glances are no longer supported

pub unsafe fn updateUserActivity_userInfo_webpageURL( &self, type: &NSString, user_info: Option<&NSDictionary>, webpage_url: Option<&NSURL>, )

👎Deprecated: use updateUserActivity:

Safety

user_info generic should be of the correct type.

pub unsafe fn handleUserActivity(&self, user_info: Option<&NSDictionary>)

👎Deprecated: use WKExtensionDelegate’s handleUserActivity:

Safety

user_info generic should be of the correct type.

pub unsafe fn addMenuItemWithImage_title_action( &self, image: &UIImage, title: &NSString, action: Sel, )

👎Deprecated

Available on crate feature objc2-ui-kit only.

Safety

action must be a valid selector.

pub unsafe fn addMenuItemWithImageNamed_title_action( &self, image_name: &NSString, title: &NSString, action: Sel, )

👎Deprecated

Safety

action must be a valid selector.

pub unsafe fn addMenuItemWithItemIcon_title_action( &self, item_icon: WKMenuItemIcon, title: &NSString, action: Sel, )

👎Deprecated

Safety

action must be a valid selector.

pub unsafe fn clearAllMenuItems(&self)

👎Deprecated

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<AnyObject> for WKUserNotificationInterfaceController

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for WKUserNotificationInterfaceController

fn as_ref(&self) -> &NSObject

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

impl AsRef<WKInterfaceController> for WKUserNotificationInterfaceController

fn as_ref(&self) -> &WKInterfaceController

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

impl AsRef<WKUserNotificationInterfaceController> for WKUserNotificationInterfaceController

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for WKUserNotificationInterfaceController

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for WKUserNotificationInterfaceController

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<WKInterfaceController> for WKUserNotificationInterfaceController

fn borrow(&self) -> &WKInterfaceController

Immutably borrows from an owned value.

impl ClassType for WKUserNotificationInterfaceController

const NAME: &'static str = "WKUserNotificationInterfaceController"

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

type Super = WKInterfaceController

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 WKUserNotificationInterfaceController

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

Formats the value using the given formatter.

impl Deref for WKUserNotificationInterfaceController

type Target = WKInterfaceController

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for WKUserNotificationInterfaceController

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 WKUserNotificationInterfaceController

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for WKUserNotificationInterfaceController

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 WKUserNotificationInterfaceController

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 WKUserNotificationInterfaceController

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

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

impl DowncastTarget for WKUserNotificationInterfaceController

impl Eq for WKUserNotificationInterfaceController