Struct PTChannelManager

Source

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

Available on crate feature PTChannelManager only.

Expand description

Apple’s documentation

Implementations§

Source §

impl PTChannelManager

Source

pub unsafe fn channelManagerWithDelegate_restorationDelegate_completionHandler( delegate: &ProtocolObject<dyn PTChannelManagerDelegate>, restoration_delegate: &ProtocolObject<dyn PTChannelRestorationDelegate>, completion_handler: &DynBlock<dyn Fn(mut PTChannelManager, mut NSError)>, )

Available on crate features PTChannelManagerDelegate and PTChannelRestorationDelegate and block2 only.

You must instantiate a channel manager upon launching your app, otherwise the system will tear down channels and their ability to receive pushes. By providing a restoration delegate, you can decide whether to rejoin or leave any previously active channels that the system knows about. Once the channel restoration process is completed, you will be given the PTChannelManager instance.

Source

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

Source

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

Source

pub unsafe fn activeChannelUUID(&self) -> Option<Retained<NSUUID>>

Only one channel can be active at a time – this is the channel that will handle user events This being nonnull reflects whether the user can see this channel is active in the user interface The ephemeral push token is only usable when this is nonnull.

Source

pub unsafe fn requestJoinChannelWithUUID_descriptor( &self, channel_uuid: &NSUUID, descriptor: &PTChannelDescriptor, )

Available on crate feature PTChannelDescriptor only.

You may only join a channel in the foreground. If successful, you will receive the delegate callback channelManager:didJoinChannelWithUUID:reason: with reason PTChannelJoinReasonProgrammaticRequest. Otherwise, the delegate callback channelManager:failedToJoinChannelWithUUID:error: will be invoked if implemented.

Source

pub unsafe fn requestBeginTransmittingWithChannelUUID( &self, channel_uuid: &NSUUID, )

If successful, you will receive the delegate callback channelManager:channelUUID:didBeginTransmittingFromSource: with PTChannelTransmitRequestSourceProgrammaticRequest. Otherwise, the delegate callback channelManager:failedToBeginTransmittingInChannelWithUUID:error: will be invoked if implemented.

Source

pub unsafe fn stopTransmittingWithChannelUUID(&self, channel_uuid: &NSUUID)

If successful, you will receive the delegate callback channelManager:channelUUID:didEndTransmittingFromSource with request source PTChannelTransmitRequestSourceProgrammaticRequest. Otherwise, the delegate callback channelManager:failedToStopTransmittingInChannelWithUUID:error: will be invoked if implemented. Generally, this should always succeed, unless you are not currently transmitting or are not joined to a channel.

Source

pub unsafe fn leaveChannelWithUUID(&self, channel_uuid: &NSUUID)

If successful, you will receive the delegate callback channelManager:channelUUID:didLeaveChannelWithUUID:reason: with reason PTChannelLeaveReasonProgrammaticRequest, Otherwise, the delegate callback channelManager:failedToLeaveChannelWithUUID:error: will be invoked if implemented. Generally, this should always succeed so long as you are already joined to a channel.

Source

pub unsafe fn setChannelDescriptor_forChannelUUID_completionHandler( &self, channel_descriptor: &PTChannelDescriptor, channel_uuid: &NSUUID, completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate features PTChannelDescriptor and block2 only.

Updates the channel descriptor

Source

pub unsafe fn setActiveRemoteParticipant_forChannelUUID_completionHandler( &self, participant: Option<&PTParticipant>, channel_uuid: &NSUUID, completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate features PTParticipant and block2 only.

When receiving incoming audio from a remote participant, set the participant to a nonnull value, which will update the system user interface and block transmitting. When the user has stopped speaking, set the participant to nil.

Source

pub unsafe fn setServiceStatus_forChannelUUID_completionHandler( &self, status: PTServiceStatus, channel_uuid: &NSUUID, completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate feature block2 only.

The default value for service status is PTServiceStatusReady. If your underlying network connection is experiencing issues, set the appropriate service status. The service status will be reflected in the system user interface.

Source

pub unsafe fn setTransmissionMode_forChannelUUID_completionHandler( &self, transmission_mode: PTTransmissionMode, channel_uuid: &NSUUID, completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate feature block2 only.

The default value for transmission mode is PTTransmissionModeHalfDuplex. If your application support one of the other transmission modes set it using this function. The system user interface will be updated to reflect the transmission mode.

Source

pub unsafe fn setAccessoryButtonEventsEnabled_forChannelUUID_completionHandler( &self, enabled: bool, channel_uuid: &NSUUID, completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate feature block2 only.

The default channel behavior is to map supported accessory button events to begin/end transmission actions. If your application does not wish to map these button events to transmission actions you can disable them by setting the enabled value to false.

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