Struct CKNotification 

pub struct CKNotification { /* private fields */ }

Available on crate feature CKNotification only.

Pushes from CloudKit servers contain both CloudKit-specific and APS-specific information. APS-specific information includes elements like alerts, badges, sounds, categories, etc. When receiving a push from CloudKit servers, the push may be delivered via multiple API flows. The flow(s) chosen will depend on the type of push requested (e.g. via the CKSubscription that triggered it and its configured notificationInfo).

Pushes with UI elements (alerts, badges, sounds): These pushes are delivered via the UserNotifications framework, in the form of a UNNotification Applications should use the UserNotifications framework to interact with the UI elements of this push. Applications may create a CKNotification from a UNNotification in their UNUserNotificationCenterDelegate:

func userNotificationCenter(_ center: UNUserNotificationCenter, willPresent notification: UNNotification) async -> UNNotificationPresentationOptions { let ckNotification = CKNotification(fromRemoteNotificationDictionary: notification.request.content.userInfo) }

Pushes with content-available: These pushes are delivered via an application delegate, in the form of a remote notification. For example: UIApplicationDelegate.application(_:didReceiveRemoteNotification:) async Applications do not need to interact with any UI element in the push payload argument, that’s intended to be handled via the UserNotifications flow (a push with both UI elements and content-available will be delivered via both API flows) Applications may create a CKNotification from the remote notification in their UIApplicationDelegate:

func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable : Any]) async -> UIBackgroundFetchResult { let ckNotification = CKNotification(fromRemoteNotificationDictionary: userInfo) }

See also Apple’s documentation

Implementations

impl CKNotification

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

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

pub unsafe fn notificationFromRemoteNotificationDictionary( notification_dictionary: &NSDictionary, ) -> Option<Retained<Self>>

Safety

notification_dictionary generic should be of the correct type.

pub unsafe fn notificationType(&self) -> CKNotificationType

When you instantiate a CKNotification from a remote notification dictionary, you will get back a concrete subclass defined below. Use notificationType to avoid as? or -isKindOfClass: checks.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn notificationID(&self) -> Option<Retained<CKNotificationID>>

This property is not atomic.

Safety

This might not be thread-safe.

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

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn subscriptionOwnerUserRecordID( &self, ) -> Option<Retained<CKRecordID>>

Available on crate feature CKRecordID only.

The user recordID of the owner of the subscription for which this notification was generated

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn isPruned(&self) -> bool

Whether or not the notification fully represents what the server wanted to send.

Push notifications have a limited size. In some cases, CloudKit servers may not be able to send you a full CKNotification’s worth of info in one push. In those cases, isPruned returns true. The order in which properties are dropped from a push notification is defined in each CKNotification subclass below.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn subscriptionID(&self) -> Option<Retained<CKSubscriptionID>>

Available on crate feature CKSubscription only.

The ID of the subscription that caused this notification to fire.

This property is not atomic.

Safety

This might not be thread-safe.

impl CKNotification

DeprecatedAPSProperties.

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

👎Deprecated: Interact with UI elements of a CloudKit-server-generated push message via UserNotifications.framework

This property is not atomic.

Safety

This might not be thread-safe.

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

👎Deprecated: Interact with UI elements of a CloudKit-server-generated push message via UserNotifications.framework

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn alertLocalizationArgs( &self, ) -> Option<Retained<NSArray<NSString>>>

👎Deprecated: Interact with UI elements of a CloudKit-server-generated push message via UserNotifications.framework

This property is not atomic.

Safety

This might not be thread-safe.

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

👎Deprecated: Interact with UI elements of a CloudKit-server-generated push message via UserNotifications.framework

This property is not atomic.

Safety

This might not be thread-safe.

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

👎Deprecated: Interact with UI elements of a CloudKit-server-generated push message via UserNotifications.framework

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn titleLocalizationArgs( &self, ) -> Option<Retained<NSArray<NSString>>>

👎Deprecated: Interact with UI elements of a CloudKit-server-generated push message via UserNotifications.framework

This property is not atomic.

Safety

This might not be thread-safe.

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

👎Deprecated: Interact with UI elements of a CloudKit-server-generated push message via UserNotifications.framework

This property is not atomic.

Safety

This might not be thread-safe.

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

👎Deprecated: Interact with UI elements of a CloudKit-server-generated push message via UserNotifications.framework

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn subtitleLocalizationArgs( &self, ) -> Option<Retained<NSArray<NSString>>>

👎Deprecated: Interact with UI elements of a CloudKit-server-generated push message via UserNotifications.framework

This property is not atomic.

Safety

This might not be thread-safe.

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

👎Deprecated: Interact with UI elements of a CloudKit-server-generated push message via UserNotifications.framework

This property is not atomic.

Safety

This might not be thread-safe.

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

👎Deprecated: Interact with UI elements of a CloudKit-server-generated push message via UserNotifications.framework

This property is not atomic.

Safety

This might not be thread-safe.

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

👎Deprecated: Interact with UI elements of a CloudKit-server-generated push message via UserNotifications.framework

This property is not atomic.

Safety

This might not be thread-safe.

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

👎Deprecated: Interact with UI elements of a CloudKit-server-generated push message via UserNotifications.framework

This property is not atomic.

Safety

This might not be thread-safe.

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

👎Deprecated: Interact with UI elements of a CloudKit-server-generated push message via UserNotifications.framework

This property is not atomic.

Safety

This might not be thread-safe.

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 CKNotification

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CKNotification> for CKDatabaseNotification

fn as_ref(&self) -> &CKNotification

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

impl AsRef<CKNotification> for CKNotification

fn as_ref(&self) -> &Self

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

impl AsRef<CKNotification> for CKQueryNotification

fn as_ref(&self) -> &CKNotification

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

impl AsRef<CKNotification> for CKRecordZoneNotification

fn as_ref(&self) -> &CKNotification

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

impl AsRef<NSObject> for CKNotification

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for CKNotification

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CKNotification> for CKDatabaseNotification

fn borrow(&self) -> &CKNotification

Immutably borrows from an owned value.

impl Borrow<CKNotification> for CKQueryNotification

fn borrow(&self) -> &CKNotification

Immutably borrows from an owned value.

impl Borrow<CKNotification> for CKRecordZoneNotification

fn borrow(&self) -> &CKNotification

Immutably borrows from an owned value.

impl Borrow<NSObject> for CKNotification

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for CKNotification

const NAME: &'static str = "CKNotification"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<CKNotification 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 Debug for CKNotification

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

Formats the value using the given formatter.

impl Deref for CKNotification

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for CKNotification

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 CKNotification

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for CKNotification

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 PartialEq for CKNotification

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 CKNotification

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

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

impl DowncastTarget for CKNotification

impl Eq for CKNotification

impl Send for CKNotification

impl Sync for CKNotification