Struct MSConversation

Source

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

Available on crate feature MSConversation only.

Expand description

Apple’s documentation

Implementations§

Source §

impl MSConversation

Source

pub unsafe fn localParticipantIdentifier(&self) -> Retained<NSUUID>

A NSUUID that identifies conversation participant on this device.

This NSUUID that identifies conversation participant on this device, this value will be stable while the extension is enabled. If the extension is disabled and re-enabled or the containing App is removed and re-installed this value will change.

Source

pub unsafe fn remoteParticipantIdentifiers(&self) -> Retained<NSArray<NSUUID>>

A NSArray of NSUUID instances, each uniquely identifies a remote participant in the conversation.

Each NSUUID identifies the a remote participant in the conversation scoped to this device. These values will be stable while the extension is enabled. If the extension is disabled and re-enabled or the containing App is removed and re-installed these values will change.

Source

pub unsafe fn selectedMessage(&self) -> Option<Retained<MSMessage>>

Available on crate feature MSMessage only.

An MSMessage instance that may be edited and returned to Messages

If the extension has been invoked in response to the user interacting with a message in the conversation transcript this property will contain the message. Otherwise this property will be nil. The message object provided may be saved to the file system. Later, this saved object may be loaded, modified and staged for sending.

Source

pub unsafe fn insertMessage_completionHandler( &self, message: &MSMessage, completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate features MSMessage and block2 only.

Stages the provided MSMessage object for sending.

This method inserts a MSMessage object into the Messages input field, Subsequent calls to this method will replace any existing message on the input field. If the message was successfully inserted on the input field, the completion handler will be called with a nil error parameter otherwise the error parameter will be populated with an NSError object describing the failure. Calling this method when the presentation context is MSMessagesAppPresentationContextMedia will result in the completion handler getting called with an error object whose error code is MSMessageErrorCodeAPIUnavailableInPresentationContext.

Parameter message: The MSMessage instance describing the message to be sent.

Parameter completionHandler: A completion handler called when the message has been staged or if there was an error.

Source

pub unsafe fn insertSticker_completionHandler( &self, sticker: &MSSticker, completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate features MSSticker and block2 only.

The sticker is inserted into the Messages.app input field.

Parameter sticker: The sticker to be inserted.

Parameter completionHandler: A completion handler called when the insert is complete.

Source

pub unsafe fn insertText_completionHandler( &self, text: &NSString, completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate feature block2 only.

The NSString instance provided in the text parameter is inserted into the Messages.app input field.

Calling this method when the presentation context is MSMessagesAppPresentationContextMedia will result in the completion handler getting called with an error object whose error code is MSMessageErrorCodeAPIUnavailableInPresentationContext.

Parameter text: The text to be inserted.

Parameter completionHandler: A completion handler called when the insert is complete.

Source

pub unsafe fn insertAttachment_withAlternateFilename_completionHandler( &self, url: &NSURL, filename: Option<&NSString>, completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate feature block2 only.

The NSURL instance provided in the URL parameter is inserted into the Messages.app input field. This must be a file URL.

Calling this method when the presentation context is MSMessagesAppPresentationContextMedia will result in the completion handler getting called with an error object whose error code is MSMessageErrorCodeAPIUnavailableInPresentationContext if the attachment type is not an image type supported by MSSticker.

Parameter URL: The URL to the media file to be inserted.

Parameter filename: If you supply a string here, the message UI uses it for the attachment. Use an alternate filename to better describe the attachment or to make the name more readable.

Parameter completionHandler: A completion handler called when the insert is complete.

Source

pub unsafe fn sendMessage_completionHandler( &self, message: &MSMessage, completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate features MSMessage and block2 only.

Start sending a message

This method begins sending the provided MSMessage. The app must be visible and have had a recent touch interaction since either last launch or last send to succeed. If the message started sending successfully, the completion handler will be called with a nil error parameter. Otherwise the error parameter will be populated with an NSError object describing the failure. Calling this method when the presentation context is MSMessagesAppPresentationContextMedia will result in the completion handler getting called with an error object whose error code is MSMessageErrorCodeAPIUnavailableInPresentationContext.

Parameter message: The MSMessage instance describing the message to be sent.

Parameter completionHandler: A completion handler called when the message has been staged or if there was an error.

Source

pub unsafe fn sendSticker_completionHandler( &self, sticker: &MSSticker, completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate features MSSticker and block2 only.

Start sending a sticker

Calling this method when the presentation context is MSMessagesAppPresentationContextMedia will result in the completion handler getting called with an error object whose error code is MSMessageErrorCodeAPIUnavailableInPresentationContext.

Parameter sticker: The sticker to be inserted.

Parameter completionHandler: A completion handler called when the insert is complete.

Source

pub unsafe fn sendText_completionHandler( &self, text: &NSString, completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate feature block2 only.

Start sending text

This method begins sending the provided NSString. The app must be visible and have had a recent touch interaction since either last launch or last send to succeed. If the message started sending successfully, the completion handler will be called with a nil error parameter. Otherwise the error parameter will be populated with an NSError object describing the failure. Calling this method when the presentation context is MSMessagesAppPresentationContextMedia will result in the completion handler getting called with an error object whose error code is MSMessageErrorCodeAPIUnavailableInPresentationContext.

Parameter text: The text to be inserted.

Parameter completionHandler: A completion handler called when the insert is complete.

Source

pub unsafe fn sendAttachment_withAlternateFilename_completionHandler( &self, url: &NSURL, filename: Option<&NSString>, completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate feature block2 only.

Start sending a file located at the provided URL. This must be a file URL.

This method begins sending the file at the provided file URL. The app must be visible and have had a recent touch interaction since either last launch or last send to succeed. If the message started sending successfully, the completion handler will be called with a nil error parameter. Otherwise the error parameter will be populated with an NSError object describing the failure. Calling this method when the presentation context is MSMessagesAppPresentationContextMedia will result in the completion handler getting called with an error object whose error code is MSMessageErrorCodeAPIUnavailableInPresentationContext.

Parameter URL: The URL to the media file to be inserted.

Parameter filename: If you supply a string here, the message UI uses it for the attachment. Use an alternate filename to better describe the attachment or to make the name more readable.

Parameter completionHandler: A completion handler called when the insert is complete.

Source §

impl MSConversation

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