Struct INRelevantShortcut

Source

pub struct INRelevantShortcut { /* private fields */ }

Available on crate feature INRelevantShortcut only.

Expand description

Lets you provide relevant shortcut to Siri, for display on the Siri Watch Face.

Including relevance information allows Siri to make suggestions for shortcuts that the user might be interested in but has not previously performed.

Implementations§

Source §

impl INRelevantShortcut

Source

pub unsafe fn relevanceProviders( &self, ) -> Retained<NSArray<INRelevanceProvider>>

Available on crate feature INRelevanceProvider only.

A collection of relevance information that is attached to the relevant shortcuts.

Providing additional relevance information allows Siri to suggest a shortcut that the user is interested in but has not previously performed.

pub unsafe fn setRelevanceProviders( &self, relevance_providers: &NSArray<INRelevanceProvider>, )

Available on crate feature INRelevanceProvider only.

Setter for relevanceProviders.

This is copied when set.

Source

pub unsafe fn watchTemplate(&self) -> Option<Retained<INDefaultCardTemplate>>

Available on crate feature INDefaultCardTemplate only.

Customizes the display of the relevant shortcut on the Siri watch face.

By default, the UI for the relevant shortcut can be derivied from the information provided in the INShortcut.In certain situations, it may be desirable to override this behavior and provide a custom template.

pub unsafe fn setWatchTemplate( &self, watch_template: Option<&INDefaultCardTemplate>, )

Available on crate feature INDefaultCardTemplate only.

Setter for watchTemplate.

This is copied when set.

Source

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

Links the relevant shortcut to a specific WidgetKit widget kind.

When a relevant shortcut is linked to a WidgetKit widget, it hints to the system when to show the widget in a stack.

Source

pub unsafe fn setWidgetKind(&self, widget_kind: Option<&NSString>)

Setter for widgetKind.

This is copied when set.

Source

pub unsafe fn shortcutRole(&self) -> INRelevantShortcutRole

The role of the relevant shortcut.

Provides a hint to Siri about the expected user experience. The default is INRelevantShortcutRoleAction. See also: INRelevantShortcutRole

Source

pub unsafe fn setShortcutRole(&self, shortcut_role: INRelevantShortcutRole)

Setter for shortcutRole.

Source

pub unsafe fn shortcut(&self) -> Retained<INShortcut>

Available on crate feature INShortcut only.

The shortcut that will be performed when this relevant shortcut is invoked.

pub unsafe fn initWithShortcut( this: Allocated<Self>, shortcut: &INShortcut, ) -> Retained<Self>

Available on crate feature INShortcut only.

Creates a relevant shortcut for the given shortcut.

Source §

impl INRelevantShortcut

Methods declared on superclass NSObject.

Source

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

Source

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

Methods from Deref<Target = NSObject>§

Source

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

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

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());

Source

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.

Source

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`
    }
}