Struct CXCallDirectoryExtensionContext

Source

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

Available on crate feature CXCallDirectoryExtensionContext only.

Expand description

Apple’s documentation

Implementations§

Source §

impl CXCallDirectoryExtensionContext

Source

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

Source

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

This is a weak property. Setter for delegate.

Source

pub unsafe fn isIncremental(&self) -> bool

Whether the request should provide incremental data.

If this is called at the beginning of the request (before any entries have been added or removed) and the result is YES, then the request must only provide an “incremental” set of entries, i.e. only add or remove entries relative to the last time data was loaded for the extension. Otherwise, if this method is not called OR is called and returns NO, then the request must provide a “complete” set of entries, adding the full list of entries from scratch (and removing none), regardless of whether data has ever been successfully loaded in the past.

Source

pub unsafe fn addBlockingEntryWithNextSequentialPhoneNumber( &self, phone_number: CXCallDirectoryPhoneNumber, )

Available on crate feature CXCallDirectory only.

Source

pub unsafe fn removeBlockingEntryWithPhoneNumber( &self, phone_number: CXCallDirectoryPhoneNumber, )

Available on crate feature CXCallDirectory only.

Remove blocking entry with the specified phone number.

May only be used when -isIncremental returns YES, indicating that the request should provide incremental entries and thus may use this API to remove a previously-added blocking entry.

Parameter phoneNumber: The blocking entry phone number to remove.

Source

pub unsafe fn removeAllBlockingEntries(&self)

Remove all currently-stored blocking entries.

May only be used when -isIncremental returns YES, indicating that the request should provide incremental entries and thus may use this API to remove all previously-added blocking entries.

Source

pub unsafe fn addIdentificationEntryWithNextSequentialPhoneNumber_label( &self, phone_number: CXCallDirectoryPhoneNumber, label: &NSString, )

Available on crate feature CXCallDirectory only.

Source

pub unsafe fn removeIdentificationEntryWithPhoneNumber( &self, phone_number: CXCallDirectoryPhoneNumber, )

Available on crate feature CXCallDirectory only.

Remove identification entry with the specified phone number.

May only be used when -isIncremental returns YES, indicating that the request should provide incremental entries and thus may use this API to remove a previously-added identification entry. Removes all identification entries with the specified phone number, even if multiple identification entries with different labels are present for a single phone number.

Parameter phoneNumber: The identification entry phone number to remove.

Source

pub unsafe fn removeAllIdentificationEntries(&self)

Remove all currently-stored identification entries.

May only be used when -isIncremental returns YES, indicating that the request should provide incremental entries and thus may use this API to remove all previously-added identification entries.

Source

pub unsafe fn completeRequestWithCompletionHandler( &self, completion: Option<&DynBlock<dyn Fn(Bool)>>, )

Available on crate feature block2 only.

Source

pub unsafe fn completeRequestReturningItems_completionHandler( &self, items: Option<&NSArray>, completion_handler: Option<&DynBlock<dyn Fn(Bool)>>, )

Available on crate feature block2 only.

Source §

impl CXCallDirectoryExtensionContext

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 = NSExtensionContext>§

Source

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

Source

pub unsafe fn cancelRequestWithError(&self, error: &NSError)

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