Struct NEAppPushManager 

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

The NEAppPushManager class declares a programmatic interface to configure NEAppPushProvider.

NEAppPushManager declares methods and properties for configuring and managing life cycle of app push provider.

Instances of this class are thread safe.

See also Apple’s documentation

Implementations

impl NEAppPushManager

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

An array of Wi-Fi SSID strings. If the SSID string of current Wi-Fi network matches with one of these strings then the NEAppPushProvider is started. The upper limit of number of SSIDs is 10.

pub unsafe fn setMatchSSIDs(&self, match_ssi_ds: &NSArray<NSString>)

Setter for matchSSIDs.

pub unsafe fn matchPrivateLTENetworks( &self, ) -> Retained<NSArray<NEPrivateLTENetwork>>

An array of NEPrivateLTENetwork objects. If the properties of current private LTE network match with properties of one of these NEPrivateLTENetwork objects then the NEAppPushProvider is started. The upper limit of number of private LTE networks is 10. For private LTE networks that are not band 48, the device must be supervised in order to perform the match

pub unsafe fn setMatchPrivateLTENetworks( &self, match_private_lte_networks: &NSArray<NEPrivateLTENetwork>, )

Setter for matchPrivateLTENetworks.

pub unsafe fn providerConfiguration( &self, ) -> Retained<NSDictionary<NSString, AnyObject>>

A dictionary containing vendor-specific key-value pairs, where the data type of values must be one of the data types supported by property list. Values of user defined data type are not supported. This dictionary is passed as-is to NEAppPushProvider when is it is started or notified for other specified reasons.

pub unsafe fn setProviderConfiguration( &self, provider_configuration: &NSDictionary<NSString, AnyObject>, )

Setter for providerConfiguration.

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

A string containing the bundle identifier of the NEAppPushProvider.

pub unsafe fn setProviderBundleIdentifier( &self, provider_bundle_identifier: Option<&NSString>, )

Setter for providerBundleIdentifier.

pub unsafe fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn NEAppPushDelegate>>>

An instance of type NEAppPushDelegate that is required to receive incoming call informarion from the provider.

pub unsafe fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn NEAppPushDelegate>>, )

This is a weak property. Setter for delegate.

pub unsafe fn loadAllFromPreferencesWithCompletionHandler( completion_handler: &DynBlock<dyn Fn(*mut NSArray<NEAppPushManager>, *mut NSError)>, )

Available on crate feature block2 only.

This class method asynchronously reads all of the saved configurations and returns them as an array of NEAppPushManager objects.

Parameter completionHandler: A block that takes an array of NEAppPushManager objects. The array passed to the block may be empty if no configurations were successfully read from the disk. The NSError object passed to this block will be nil if the load operation succeeded, non-nil otherwise.

pub unsafe fn loadFromPreferencesWithCompletionHandler( &self, completion_handler: &DynBlock<dyn Fn(*mut NSError)>, )

Available on crate feature block2 only.

This method loads the saved configuration from the persistent store.

Parameter completionHandler: A block that will be called when the load operation is completed. The NSError object passed to this block will be nil if the load operation succeeded, non-nil otherwise.

pub unsafe fn removeFromPreferencesWithCompletionHandler( &self, completion_handler: &DynBlock<dyn Fn(*mut NSError)>, )

Available on crate feature block2 only.

This method removes the configuration from the persistent store.

Parameter completionHandler: A block that will be called when the remove operation is completed. The NSError object passed to this block will be nil if the remove operation succeeded, non-nil otherwise.

pub unsafe fn saveToPreferencesWithCompletionHandler( &self, completion_handler: &DynBlock<dyn Fn(*mut NSError)>, )

Available on crate feature block2 only.

This method saves the configuration in the persistent store.

Parameter completionHandler: A block that will be called when the save operation is completed. The NSError object passed to this block will be nil if the save operation succeeded, non-nil otherwise.

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

A string containing a description of the app push manager.

pub unsafe fn setLocalizedDescription( &self, localized_description: Option<&NSString>, )

Setter for localizedDescription.

pub unsafe fn isEnabled(&self) -> bool

Toggles the enabled status of the configuration. This property will be set to NO when the same app saves another configuration that overlaps with this configuration.

pub unsafe fn setEnabled(&self, enabled: bool)

Setter for isEnabled.

pub unsafe fn isActive(&self) -> bool

If set to YES, it indicates the associated configuration is in use. Use KVO to watch for changes.

impl NEAppPushManager

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 NEAppPushManager

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NEAppPushManager> for NEAppPushManager

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for NEAppPushManager

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for NEAppPushManager

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NEAppPushManager

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NEAppPushManager

const NAME: &'static str = "NEAppPushManager"

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

type Super = NSObject

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for NEAppPushManager

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NEAppPushManager

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 NEAppPushManager

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for NEAppPushManager

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 NEAppPushManager

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 NEAppPushManager

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

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

impl DowncastTarget for NEAppPushManager

impl Eq for NEAppPushManager