Struct MSMessage

Source

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

Available on crate feature MSMessage only.

Expand description

The MSMessage encapsulates the data to be transferred to remote devices.

Implementations§

Source §

impl MSMessage

Source

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

Initializes a new message that is not part of a session.

Source

pub unsafe fn initWithSession( this: Allocated<Self>, session: &MSSession, ) -> Retained<Self>

Available on crate feature MSSession only.

Initializes a message with a session.

See: insertMessage:completionHandler:

Parameter session: The session that new message will join.

A message initialized with a session will be updated and moved to the bottom of the conversation transcript when another message created with the same session is sent.

Source

pub unsafe fn session(&self) -> Option<Retained<MSSession>>

Available on crate feature MSSession only.

An MSSession that identifies the session that message belongs to.

Source

pub unsafe fn isPending(&self) -> bool

A BOOL representing whether the message is a pending message or is a message that has been sent/received.

This value starts as YES when creating an MSMessage for sending. After calling -[MSConversation insertMessage:completionHandler:], isPending still returns YES until -[MSMessagesAppViewController didStartSendingMessage:conversation] is called. This property is useful for knowing if the selectedMessage of -[MSMessagesAppViewController activeConversation] represents an unsent message.

Source

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

A NSUUID instance that identifies the participant that sent the message.

This NSUUID identifies the message’s sender. This value is scoped to the current device and will be different on all devices that participate in the conversation.

Source

pub unsafe fn layout(&self) -> Option<Retained<MSMessageLayout>>

Available on crate feature MSMessageLayout only.

A subclass of MSMessageLayout.

The MSMessageLayout subclass will be used to construct UI representing the message in the conversation transcript.

Source

pub unsafe fn setLayout(&self, layout: Option<&MSMessageLayout>)

Available on crate feature MSMessageLayout only.

Setter for layout.

Source

pub unsafe fn URL(&self) -> Option<Retained<NSURL>>

A HTTP(S) or data URL used to encode data to be transferred in message.

This URL should encode any data that is to be delivered to the extension running on the recipient’s device(s). When no app exists on the receiving device that can consume the message, if this URL is a HTTP(S) url, it will be loaded in a web browser.

Source

pub unsafe fn setURL(&self, url: Option<&NSURL>)

Setter for URL.

Source

pub unsafe fn shouldExpire(&self) -> bool

A Boolean value that indicates whether the messages should expire after being read.

YES if the message should expire after it is read. Expired messages will be deleted a short time after being read by the receiver. The user may opt to keep the message. This property defaults to NO.

Source

pub unsafe fn setShouldExpire(&self, should_expire: bool)

Setter for shouldExpire.

Source

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

A localized string describing the message.

This string should provide a succinct description of the message. This will be used by the Accessibility Speech feature when speaking the message for users with disabilities.

Source

pub unsafe fn setAccessibilityLabel( &self, accessibility_label: Option<&NSString>, )

Setter for accessibilityLabel.

Source

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

A localized string describing the message.

This string should provide a succinct description of the message. This will be used to provide a summary of the message in the UI.

Source

pub unsafe fn setSummaryText(&self, summary_text: Option<&NSString>)

Setter for summaryText.

Source

pub unsafe fn error(&self) -> Option<Retained<NSError>>

An error object that indicates why a message failed to send.

This value is nil if the message is has not yet been sent, is still sending or has been sent successfully.

Source

pub unsafe fn setError(&self, error: Option<&NSError>)

Setter for error.

Source §

impl MSMessage

Methods declared on superclass NSObject.

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