Struct CKNotificationInfo 

pub struct CKNotificationInfo { /* private fields */ }

Available on crate feature CKSubscription only.

The payload of a push notification delivered in the UIApplication application:didReceiveRemoteNotification:delegate method contains information about the firing subscription.

Use

 +[CKNotification notificationFromRemoteNotificationDictionary:]

to parse that payload. On tvOS, alerts, badges, sounds, and categories are not handled in push notifications. However, CKSubscriptions remain available to help you avoid polling the server.

See also Apple’s documentation

Implementations

impl CKNotificationInfo

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

Optional alert string to display in a push notification.

pub unsafe fn setAlertBody(&self, alert_body: Option<&NSString>)

Setter for alertBody.

This is copied when set.

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

Instead of a raw alert string, you may optionally specify a key for a localized string in your app’s Localizable.strings file.

pub unsafe fn setAlertLocalizationKey( &self, alert_localization_key: Option<&NSString>, )

Setter for alertLocalizationKey.

This is copied when set.

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

Available on crate feature CKRecord only.

A list of field names to take from the matching record that is used as substitution variables in a formatted alert string.

pub unsafe fn setAlertLocalizationArgs( &self, alert_localization_args: Option<&NSArray<CKRecordFieldKey>>, )

Available on crate feature CKRecord only.

Setter for alertLocalizationArgs.

This is copied when set.

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

Optional title of the alert to display in a push notification.

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

Setter for title.

This is copied when set.

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

Instead of a raw title string, you may optionally specify a key for a localized string in your app’s Localizable.strings file.

pub unsafe fn setTitleLocalizationKey( &self, title_localization_key: Option<&NSString>, )

Setter for titleLocalizationKey.

This is copied when set.

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

Available on crate feature CKRecord only.

A list of field names to take from the matching record that is used as substitution variables in a formatted title string.

pub unsafe fn setTitleLocalizationArgs( &self, title_localization_args: Option<&NSArray<CKRecordFieldKey>>, )

Available on crate feature CKRecord only.

Setter for titleLocalizationArgs.

This is copied when set.

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

Optional subtitle of the alert to display in a push notification.

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

Setter for subtitle.

This is copied when set.

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

Instead of a raw subtitle string, you may optionally specify a key for a localized string in your app’s Localizable.strings file.

pub unsafe fn setSubtitleLocalizationKey( &self, subtitle_localization_key: Option<&NSString>, )

Setter for subtitleLocalizationKey.

This is copied when set.

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

Available on crate feature CKRecord only.

A list of field names to take from the matching record that is used as substitution variables in a formatted subtitle string.

pub unsafe fn setSubtitleLocalizationArgs( &self, subtitle_localization_args: Option<&NSArray<CKRecordFieldKey>>, )

Available on crate feature CKRecord only.

Setter for subtitleLocalizationArgs.

This is copied when set.

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

A key for a localized string to be used as the alert action in a modal style notification.

pub unsafe fn setAlertActionLocalizationKey( &self, alert_action_localization_key: Option<&NSString>, )

Setter for alertActionLocalizationKey.

This is copied when set.

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

The name of an image in your app bundle to be used as the launch image when launching in response to the notification.

pub unsafe fn setAlertLaunchImage(&self, alert_launch_image: Option<&NSString>)

Setter for alertLaunchImage.

This is copied when set.

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

The name of a sound file in your app bundle to play upon receiving the notification.

pub unsafe fn setSoundName(&self, sound_name: Option<&NSString>)

Setter for soundName.

This is copied when set.

pub unsafe fn desiredKeys(&self) -> Option<Retained<NSArray<CKRecordFieldKey>>>

Available on crate feature CKRecord only.

A list of keys from the matching record to include in the notification payload.

Only some keys are allowed. The value types associated with those keys on the server must be one of these classes:

• CKReference
• CLLocation
• NSDate
• NSNumber
• NSString

pub unsafe fn setDesiredKeys( &self, desired_keys: Option<&NSArray<CKRecordFieldKey>>, )

Available on crate feature CKRecord only.

Setter for desiredKeys.

This is copied when set.

pub unsafe fn shouldBadge(&self) -> bool

Indicates that the notification should increment the app’s badge count. Default value is NO.

pub unsafe fn setShouldBadge(&self, should_badge: bool)

Setter for shouldBadge.

pub unsafe fn shouldSendContentAvailable(&self) -> bool

Indicates that the notification should be sent with the “content-available” flag to allow for background downloads in the application.

Default value is NO.

pub unsafe fn setShouldSendContentAvailable( &self, should_send_content_available: bool, )

Setter for shouldSendContentAvailable.

pub unsafe fn shouldSendMutableContent(&self) -> bool

Indicates that the notification should be sent with the “mutable-content” flag to allow a Notification Service app extension to modify or replace the push payload.

Default value is NO.

pub unsafe fn setShouldSendMutableContent( &self, should_send_mutable_content: bool, )

Setter for shouldSendMutableContent.

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

Optional property for the category to be sent with the push when this subscription fires.

Categories allow you to present custom actions to the user on your push notifications.

See: UIMutableUserNotificationCategory

pub unsafe fn setCategory(&self, category: Option<&NSString>)

Setter for category.

This is copied when set.

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

Optional property specifying a field name to take from the matching record whose value is used as the apns-collapse-id header.

See: APNs Notification API documentation

pub unsafe fn setCollapseIDKey(&self, collapse_id_key: Option<&NSString>)

Setter for collapseIDKey.

This is copied when set.

impl CKNotificationInfo

Methods declared on superclass NSObject.

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

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

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 CKNotificationInfo

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CKNotificationInfo> for CKNotificationInfo

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for CKNotificationInfo

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for CKNotificationInfo

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for CKNotificationInfo

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for CKNotificationInfo

const NAME: &'static str = "CKNotificationInfo"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<CKNotificationInfo 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 CKNotificationInfo

type Result = CKNotificationInfo

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

impl Debug for CKNotificationInfo

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

Formats the value using the given formatter.

impl Deref for CKNotificationInfo

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for CKNotificationInfo

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 CKNotificationInfo

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for CKNotificationInfo

unsafe fn encodeWithCoder(&self, coder: &NSCoder)

where Self: Sized + Message,

Safety

unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>

where Self: Sized + Message,

Safety

impl NSCopying for CKNotificationInfo

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 NSObjectProtocol for CKNotificationInfo

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 CKNotificationInfo

fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for CKNotificationInfo

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 CKNotificationInfo

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

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

impl DowncastTarget for CKNotificationInfo

impl Eq for CKNotificationInfo