Struct SWHighlightCenter

Source

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

Available on crate feature SWHighlightCenter only.

Expand description

Provides the application with a priority-ordered list of universal links which have been shared with the current user.

The system decides which links should be surfaced. The app is responsible for updating its UI to reflect the latest provided list.

Implementations§

Source §

impl SWHighlightCenter

Source

pub unsafe fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn SWHighlightCenterDelegate>>>

The highlight center’s delegate

Source

pub unsafe fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn SWHighlightCenterDelegate>>, )

This is a weak property. Setter for delegate.

Source

pub unsafe fn highlights(&self) -> Retained<NSArray<SWHighlight>>

Available on crate feature SWHighlight only.

Source

pub unsafe fn highlightCollectionTitle() -> Retained<NSString>

Localized title to display with a collection of highlights

Use this string as the title for a collection of shared highlight links displayed to the user.

Source

pub unsafe fn isSystemCollaborationSupportAvailable() -> bool

Whether the current software version has full support for Messages collaboration features.

Use this property at runtime to conditionally enable Messages collaboration features in your app. This property will be permantently set to YES on a software version with full support for these features.

Source

pub unsafe fn getHighlightForURL_completionHandler( &self, url: &NSURL, completion_handler: &DynBlock<dyn Fn(mut SWHighlight, mut NSError)>, )

Available on crate features SWHighlight and block2 only.

A convenience method to get a SWHighlight for a given URL

Parameter URL: The URL used to find the SWHighlight

Parameter completionHandler: an SWHighlight if it was fetched. The completion handler will always be invoked on the main queue

Source

pub unsafe fn collaborationHighlightForIdentifier_error( &self, collaboration_identifier: &SWCollaborationIdentifier, ) -> Result<Retained<SWCollaborationHighlight>, Retained<NSError>>

Available on crate features SWCollaborationHighlight and SWHighlight and objc2-shared-with-you-core only.

Source

pub unsafe fn getCollaborationHighlightForURL_completionHandler( &self, url: &NSURL, completion_handler: &DynBlock<dyn Fn(mut SWCollaborationHighlight, mut NSError)>, )

Available on crate features SWCollaborationHighlight and SWHighlight and block2 only.

A convenience method to get an SWCollaborationHighlight for a given URL

Parameter URL: The URL used to find the SWCollaborationHighlight

Parameter completionHandler: an SWCollaborationHighlight if it was fetched. The completion handler will always be invoked on the main queue

Source

pub unsafe fn postNoticeForHighlightEvent( &self, event: &ProtocolObject<dyn SWHighlightEvent>, )

Available on crate feature SWHighlightEvent only.

Post a given event to the highlight center for display in Messages.

Parameter event: The event to add for a specific highlight

Source

pub unsafe fn clearNoticesForHighlight( &self, highlight: &SWCollaborationHighlight, )

Available on crate features SWCollaborationHighlight and SWHighlight only.

Clear notices for a given collaboration highlight in Messages.

Parameter highlight: The highlight to clear notices from.

Source

pub unsafe fn getSignedIdentityProofForCollaborationHighlight_usingData_completionHandler( &self, collaboration_highlight: &SWCollaborationHighlight, data: &NSData, completion_handler: &DynBlock<dyn Fn(mut SWSignedPersonIdentityProof, mut NSError)>, )

Available on crate features SWCollaborationHighlight and SWHighlight and block2 and objc2-shared-with-you-core only.

Method to sign passed in data with local device’s private key

Parameter data: NSData that needs to be signed

Parameter collaborationHighlight: The corresponding collaboration highlight.

Parameter completionHandler: Signed data along with proof of inclusion for merkle if signing succeeded, otherwise an error. The completion handler will always be invoked on main queue

Source §

impl SWHighlightCenter

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