Struct UNMutableNotificationContent

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

Available on crate feature UNNotificationContent only.

Apple’s documentation

Implementations

impl UNMutableNotificationContent

pub unsafe fn attachments(&self) -> Retained<NSArray<UNNotificationAttachment>>

Available on crate feature UNNotificationAttachment only.

pub unsafe fn setAttachments( &self, attachments: &NSArray<UNNotificationAttachment>, )

Available on crate feature UNNotificationAttachment only.

Setter for attachments.

pub unsafe fn badge(&self) -> Option<Retained<NSNumber>>

pub unsafe fn setBadge(&self, badge: Option<&NSNumber>)

Setter for badge.

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

pub unsafe fn setBody(&self, body: &NSString)

Setter for body.

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

pub unsafe fn setCategoryIdentifier(&self, category_identifier: &NSString)

Setter for categoryIdentifier.

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

pub unsafe fn setLaunchImageName(&self, launch_image_name: &NSString)

Setter for launchImageName.

pub unsafe fn sound(&self) -> Option<Retained<UNNotificationSound>>

Available on crate feature UNNotificationSound only.

pub unsafe fn setSound(&self, sound: Option<&UNNotificationSound>)

Available on crate feature UNNotificationSound only.

Setter for sound.

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

pub unsafe fn setSubtitle(&self, subtitle: &NSString)

Setter for subtitle.

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

pub unsafe fn setThreadIdentifier(&self, thread_identifier: &NSString)

Setter for threadIdentifier.

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

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

Setter for title.

pub unsafe fn userInfo(&self) -> Retained<NSDictionary>

pub unsafe fn setUserInfo(&self, user_info: &NSDictionary)

Setter for userInfo.

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

👎Deprecated: summaryArgument is ignored

The argument to be inserted in the summary for this notification.

pub unsafe fn setSummaryArgument(&self, summary_argument: &NSString)

👎Deprecated: summaryArgument is ignored

Setter for summaryArgument.

pub unsafe fn summaryArgumentCount(&self) -> NSUInteger

👎Deprecated: summaryArgumentCount is ignored

A number that indicates how many items in the summary are represented in the summary. For example if a podcast app sends one notification for 3 new episodes in a show, the argument should be the name of the show and the count should be 3. Default is 1 and cannot be 0.

pub unsafe fn setSummaryArgumentCount(&self, summary_argument_count: NSUInteger)

👎Deprecated: summaryArgumentCount is ignored

Setter for summaryArgumentCount.

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

pub unsafe fn setTargetContentIdentifier( &self, target_content_identifier: Option<&NSString>, )

Setter for targetContentIdentifier.

pub unsafe fn interruptionLevel(&self) -> UNNotificationInterruptionLevel

pub unsafe fn setInterruptionLevel( &self, interruption_level: UNNotificationInterruptionLevel, )

Setter for interruptionLevel.

pub unsafe fn relevanceScore(&self) -> c_double

pub unsafe fn setRelevanceScore(&self, relevance_score: c_double)

Setter for relevanceScore.

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

pub unsafe fn setFilterCriteria(&self, filter_criteria: Option<&NSString>)

Setter for filterCriteria.

impl UNMutableNotificationContent

Methods declared on superclass NSObject.

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

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

Methods from Deref<Target = UNNotificationContent>

pub unsafe fn attachments(&self) -> Retained<NSArray<UNNotificationAttachment>>

Available on crate feature UNNotificationAttachment only.

pub unsafe fn badge(&self) -> Option<Retained<NSNumber>>

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

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

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

pub unsafe fn sound(&self) -> Option<Retained<UNNotificationSound>>

Available on crate feature UNNotificationSound only.

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

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

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

pub unsafe fn userInfo(&self) -> Retained<NSDictionary>

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

👎Deprecated: summaryArgument is ignored

The argument to be inserted in the summary for this notification.

pub unsafe fn summaryArgumentCount(&self) -> NSUInteger

👎Deprecated: summaryArgumentCount is ignored

A number that indicates how many items in the summary are represented in the summary. For example if a podcast app sends one notification for 3 new episodes in a show, the argument should be the name of the show and the count should be 3. Default is 1 and cannot be 0.

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

pub unsafe fn interruptionLevel(&self) -> UNNotificationInterruptionLevel

pub unsafe fn relevanceScore(&self) -> c_double

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

pub unsafe fn contentByUpdatingWithProvider_error( &self, provider: &ProtocolObject<dyn UNNotificationContentProviding>, ) -> Result<Retained<UNNotificationContent>, Retained<NSError>>

Contextualizes your UNNotificationContent object with other Apple SDK objects conforming to UNNotificationContentProviding. This will specialize the notification and decorate its look and behavior accordingly. For example, the notification will be treated as a message with an avatar and be promoted to the top of notification center if the object passed in is a valid INSendMessageIntent <UNNotificationContentProviding

. This throws an error with a UNErrorCode found in UNError.h if the UNNotificationContentProviding object is invalid. A valid UNNotificationContent result should not be mutated and be passed directly to UNUserNotificationCenter.

This should be called in the UNNotificationServiceExtension in didReceiveNotificationRequest:withContentHandler: and the returned UNNotificationContent should be passed to the contentHandler for incoming push notifications.

Methods from Deref<Target = NSObject>

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

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

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

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.

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

Trait Implementations

impl AsRef<AnyObject> for UNMutableNotificationContent

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSObject> for UNMutableNotificationContent

fn as_ref(&self) -> &NSObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<UNMutableNotificationContent> for UNMutableNotificationContent

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<UNNotificationContent> for UNMutableNotificationContent

fn as_ref(&self) -> &UNNotificationContent

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for UNMutableNotificationContent

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for UNMutableNotificationContent

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<UNNotificationContent> for UNMutableNotificationContent

fn borrow(&self) -> &UNNotificationContent

Immutably borrows from an owned value.

impl ClassType for UNMutableNotificationContent

const NAME: &'static str = "UNMutableNotificationContent"

The name of the Objective-C class that this type represents.

type Super = UNNotificationContent

The superclass of this class.

type ThreadKind = <<UNMutableNotificationContent as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl CopyingHelper for UNMutableNotificationContent

type Result = UNNotificationContent

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl Debug for UNMutableNotificationContent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for UNMutableNotificationContent

type Target = UNNotificationContent

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for UNMutableNotificationContent

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for UNMutableNotificationContent

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl MutableCopyingHelper for UNMutableNotificationContent

type Result = UNMutableNotificationContent

The mutable counterpart of the type, or Self if the type has no mutable counterpart.

impl NSCopying for UNMutableNotificationContent

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

impl NSMutableCopying for UNMutableNotificationContent

fn mutableCopy(&self) -> Retained<Self::Result>

where Self: Sized + Message + MutableCopyingHelper,

Returns a new instance that’s a mutable copy of the receiver.

unsafe fn mutableCopyWithZone( &self, zone: *mut NSZone, ) -> Retained<Self::Result>

where Self: Sized + Message + MutableCopyingHelper,

Returns a new instance that’s a mutable copy of the receiver.

impl NSObjectProtocol for UNMutableNotificationContent

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl NSSecureCoding for UNMutableNotificationContent

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for UNMutableNotificationContent

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for UNMutableNotificationContent

const ENCODING_REF: Encoding = <UNNotificationContent as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl DowncastTarget for UNMutableNotificationContent

impl Eq for UNMutableNotificationContent

impl NSCoding for UNMutableNotificationContent