Struct NEHotspotHelper

Source

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

Expand description

The NEHotspotHelper class allows an application to register itself as a HotspotHelper.

Implementations§

Source §

impl NEHotspotHelper

Source

pub unsafe fn registerWithOptions_queue_handler( options: Option<&NSDictionary<NSString, NSObject>>, queue: &DispatchQueue, handler: NEHotspotHelperHandler, ) -> bool

Available on crate features block2 and dispatch2 only.

Register the application as a HotspotHelper.

Once this API is invoked successfully, the application becomes eligible to be launched in the background and participate in various hotspot related functions.

This function should be called once when the application starts up. Invoking it again will have no effect and result in FALSE being returned.

The ‘options’ dictionary may be nil, or contain the single property kNEHotspotHelperOptionDisplayName.

Parameter options: If not nil, ‘options’ is an NSDictionary containing kNEHotspotHelperOption* keys (currently just kNEHotspotHelperOptionDisplayName).

Parameter queue: The dispatch_queue_t to invoke the handle block on.

Parameter handler: The NEHotspotHelperHandler block to execute to process helper commands.

Returns: YES if the registration was successful, NO otherwise.

Note: Notes

Note: 1 The application’s Info.plist MUST include a UIBackgroundModes array containing ‘network-authentication’.

Note: 2 The application MUST set ‘com.apple.developer.networking.HotspotHelper’ as one of its entitlements. The value of the entitlement is a boolean value true.

Source

pub unsafe fn logoff(network: &NEHotspotNetwork) -> bool

Terminate the authentication session.

The application invokes this method when it wants to logoff from the current network. Invoking this method causes an NEHotspotHelperCommand of type kNEHotspotHelperCommandTypeLogoff to be issued to the application’s ‘handler’ block (see +[NEHotspotHelper registerWithOptions:queue:handler]).

‘network’ must correspond to the currently associated Wi-Fi network i.e. it must have come from the NEHotspotHelperCommand’s ‘network’ property or from the +[NEHotspotHelper supportedInterfaces] method.

Returns: YES if the logoff command was successfully queued, NO otherwise.

Note: Notes

Note: 1 The application MUST NOT actually logoff from the network until it receives the command to logoff.

Note: 2 After the application invokes -[NEHotspotHelperResponse deliver] indicating kNEHotspotHelperResultSuccess, the Wi-Fi network is disassociated.

Source

pub unsafe fn supportedNetworkInterfaces() -> Option<Retained<NSArray>>

Return the list of network interfaces managed by the HotspotHelper infrastructure.

Each network interface is represented by an NEHotspotNetwork object. Currently, the returned array contains exactly one NEHotspotNetwork object representing the Wi-Fi interface.

The main purpose of this method is to allow a HotspotHelper to provide accurate status in its UI at times when it has not been given a command to process. This method coupled with -[NEHotspotNetwork isChosenHelper] allows the application to know whether it is the one that is handling the current network.

Returns: nil if no network interfaces are being managed, non-nil NSArray of NEHotspotNetwork objects otherwise.

Source §

impl NEHotspotHelper

Methods declared on superclass NSObject.

Source

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

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