Struct SWCollaborationMetadata

Source

pub struct SWCollaborationMetadata { /* private fields */ }

Available on crate feature SWCollaborationMetadata only.

Expand description

Apple’s documentation

Implementations§

Source §

impl SWCollaborationMetadata

Source

pub unsafe fn collaborationIdentifier( &self, ) -> Retained<SWCollaborationIdentifier>

Globally unique identifier for the item represented by this metadata.

This identifier is unique across platforms and shares of the same item.

Source

pub unsafe fn localIdentifier(&self) -> Retained<SWLocalCollaborationIdentifier>

Locally unique identifier for the item represented by this metadata.

Use this identifier to uniquely identify this metadata before a collaborationIdentifier can be created

Source

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

Title of the content.

Title of the collaboration if provided by the app which owns the collaboration item.

Source

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

Setter for title.

This is copied when set.

Source

pub unsafe fn defaultShareOptions( &self, ) -> Option<Retained<SWCollaborationShareOptions>>

Available on crate feature SWCollaborationShareOptions only.

The collaboration options that this content supports (updated).

Source

pub unsafe fn setDefaultShareOptions( &self, default_share_options: Option<&SWCollaborationShareOptions>, )

Available on crate feature SWCollaborationShareOptions only.

Setter for defaultShareOptions.

This is copied when set.

Source

pub unsafe fn userSelectedShareOptions( &self, ) -> Option<Retained<SWCollaborationShareOptions>>

Available on crate feature SWCollaborationShareOptions only.

The collaboration options that the user selected when sending the invite (updated).

Source

pub unsafe fn setUserSelectedShareOptions( &self, user_selected_share_options: Option<&SWCollaborationShareOptions>, )

Available on crate feature SWCollaborationShareOptions only.

Setter for userSelectedShareOptions.

This is copied when set.

Source

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

The handle of the person initiating the collaboration, e.g. an email address or phone number.

Set by the initiating application to allow the user to confirm the handle being used before beginning collaboration. Value will not be transmitted to recipients, and will be nil when not initiating collaboration.

Source

pub unsafe fn setInitiatorHandle(&self, initiator_handle: Option<&NSString>)

Setter for initiatorHandle.

This is copied when set.

Source

pub unsafe fn initiatorNameComponents( &self, ) -> Option<Retained<NSPersonNameComponents>>

The name of the person initiating the collaboration.

Set by the initiating application to allow the user to confirm the name being used before beginning collaboration. Value will not be transmitted to recipients, and will be nil when not initiating collaboration.

Source

pub unsafe fn setInitiatorNameComponents( &self, initiator_name_components: Option<&NSPersonNameComponents>, )

Setter for initiatorNameComponents.

Source

pub unsafe fn initWithLocalIdentifier( this: Allocated<Self>, local_identifier: &SWLocalCollaborationIdentifier, ) -> Retained<Self>

Source

pub unsafe fn initWithCollaborationIdentifier( this: Allocated<Self>, collaboration_identifier: &SWCollaborationIdentifier, ) -> Retained<Self>

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