Struct CXProvider

Source

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

Available on crate feature CXProvider only.

Expand description

Apple’s documentation

Implementations§

Source §

impl CXProvider

Source

pub unsafe fn initWithConfiguration( this: Allocated<Self>, configuration: &CXProviderConfiguration, ) -> Retained<Self>

Available on crate feature CXProviderConfiguration only.

Initialize a new provider instance with the supplied configuration

Source

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

Source

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

Source

pub unsafe fn setDelegate_queue( &self, delegate: Option<&ProtocolObject<dyn CXProviderDelegate>>, queue: Option<&DispatchQueue>, )

Available on crate feature dispatch2 only.

Set delegate and optional queue for delegate callbacks to be performed on. A nil queue implies that delegate callbacks should happen on the main queue. The delegate is stored weakly

Source

pub unsafe fn reportNewIncomingCallWithUUID_update_completion( &self, uuid: &NSUUID, update: &CXCallUpdate, completion: &DynBlock<dyn Fn(*mut NSError)>, )

Available on crate features CXCallUpdate and block2 only.

Report a new incoming call to the system.

If completion is invoked with a non-nil error, the incoming call has been disallowed by the system and will not be displayed, so the provider should not proceed with the call.

Completion block will be called on delegate queue, if specified, otherwise on a private serial queue.

Source

pub unsafe fn reportCallWithUUID_updated( &self, uuid: &NSUUID, update: &CXCallUpdate, )

Available on crate feature CXCallUpdate only.

Report an update to call information.

Source

pub unsafe fn reportCallWithUUID_endedAtDate_reason( &self, uuid: &NSUUID, date_ended: Option<&NSDate>, ended_reason: CXCallEndedReason, )

Report that a call ended. A nil value for dateEnded results in the ended date being set to now.

Source

pub unsafe fn reportOutgoingCallWithUUID_startedConnectingAtDate( &self, uuid: &NSUUID, date_started_connecting: Option<&NSDate>, )

Report that an outgoing call started connecting. A nil value for dateStartedConnecting results in the started connecting date being set to now.

Source

pub unsafe fn reportOutgoingCallWithUUID_connectedAtDate( &self, uuid: &NSUUID, date_connected: Option<&NSDate>, )

Report that an outgoing call connected. A nil value for dateConnected results in the connected date being set to now.

Source

pub unsafe fn reportNewIncomingVoIPPushPayload_completion( dictionary_payload: &NSDictionary, completion: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate feature block2 only.

From within a Notification Service Extension, request the containing application be launched to handle an incoming VoIP call. The application’s PKPushRegistryDelegate must handle the push upon launch.

Source

pub unsafe fn configuration(&self) -> Retained<CXProviderConfiguration>

Available on crate feature CXProviderConfiguration only.

The receiver’s current configuration.

Source

pub unsafe fn setConfiguration(&self, configuration: &CXProviderConfiguration)

Available on crate feature CXProviderConfiguration only.

Setter for configuration.

Source

pub unsafe fn invalidate(&self)

Invalidate the receiver. All existing calls will be marked as ended in failure. The provider must be invalidated before it is deallocated.

Source

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

Available on crate feature CXTransaction only.

List of all transactions that are incomplete.

Source

pub unsafe fn pendingCallActionsOfClass_withCallUUID( &self, call_action_class: &AnyClass, call_uuid: &NSUUID, ) -> Retained<NSArray<CXCallAction>>

Available on crate features CXAction and CXCallAction only.

Returns subset of call actions contained in any transaction in -pendingTransactions of the specified class and with the specified call UUID.

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