objc2_io_bluetooth/generated/objc2/

IOBluetoothHandsFreeDevice.rs

//! This file has been automatically generated by `objc2`'s `header-translator`.
//! DO NOT EDIT
use core::ffi::*;
use core::ptr::NonNull;
use objc2::__framework_prelude::*;
#[cfg(feature = "objc2-foundation")]
use objc2_foundation::*;

use crate::*;

extern_class!(
    /// APIs for managing a hands free device
    ///
    /// (c) 2010 by Apple Inc. All rights reserved.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/iobluetooth/iobluetoothhandsfreedevice?language=objc)
    #[unsafe(super(IOBluetoothHandsFree, NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    #[cfg(feature = "IOBluetoothHandsFree")]
    pub struct IOBluetoothHandsFreeDevice;
);

#[cfg(feature = "IOBluetoothHandsFree")]
extern_conformance!(
    unsafe impl NSObjectProtocol for IOBluetoothHandsFreeDevice {}
);

#[cfg(feature = "IOBluetoothHandsFree")]
impl IOBluetoothHandsFreeDevice {
    extern_methods!(
        #[cfg(all(feature = "IOBluetoothDevice", feature = "IOBluetoothObject"))]
        /// Create a new IOBluetoothHandsFreeDevice to act as a hands free device
        ///
        /// This will register a listener for incoming connections.
        ///
        /// Parameter `device`: An IOBluetoothDevice
        ///
        /// Parameter `inDelegate`: An object to act as delegate
        ///
        /// Returns: A newly created IOBluetoothHandsFreeDevice object on success, nil on failure
        #[unsafe(method(initWithDevice:delegate:))]
        #[unsafe(method_family = init)]
        pub unsafe fn initWithDevice_delegate(
            this: Allocated<Self>,
            device: Option<&IOBluetoothDevice>,
            delegate: Option<&AnyObject>,
        ) -> Option<Retained<Self>>;

        #[cfg(feature = "objc2-foundation")]
        /// Dial a number
        ///
        /// Calls aNumber
        ///
        /// Parameter `aNumber`: The number to call - the gateway determines acceptable formats.
        #[unsafe(method(dialNumber:))]
        #[unsafe(method_family = none)]
        pub unsafe fn dialNumber(&self, a_number: Option<&NSString>);

        /// Dial a number from memory
        ///
        /// Calls a number from a memory (or speed dial) location.
        ///
        /// Parameter `memoryLocation`: The location in memory
        #[unsafe(method(memoryDial:))]
        #[unsafe(method_family = none)]
        pub unsafe fn memoryDial(&self, memory_location: c_int);

        /// Redial a number
        ///
        /// Redials the previous number stored by the hands free gateway.
        #[unsafe(method(redial))]
        #[unsafe(method_family = none)]
        pub unsafe fn redial(&self);

        /// Hang up a call or reject an incoming call
        ///
        /// Hangs up the current call, or rejects an incoming call.
        #[unsafe(method(endCall))]
        #[unsafe(method_family = none)]
        pub unsafe fn endCall(&self);

        /// Accept an incoming call
        ///
        /// Accepts an incoming call.
        #[unsafe(method(acceptCall))]
        #[unsafe(method_family = none)]
        pub unsafe fn acceptCall(&self);

        /// Accept an incoming call on the phone
        ///
        /// Accepts an incoming call and then quickly transfer audio to the phone.
        #[unsafe(method(acceptCallOnPhone))]
        #[unsafe(method_family = none)]
        pub unsafe fn acceptCallOnPhone(&self);

        #[cfg(feature = "objc2-foundation")]
        /// Send a key press
        ///
        /// Sends a DTMF tone.
        ///
        /// Parameter `character`: A single character in the set 0-9, #,*,A-D
        #[unsafe(method(sendDTMF:))]
        #[unsafe(method_family = none)]
        pub unsafe fn sendDTMF(&self, character: Option<&NSString>);

        /// Get the subscriber number(s)
        ///
        /// Gets the subscriber number(s) stored on the gateway. Each subscriber number is returned on the delegate method handsFree:subscriberNumber.
        /// There is no guarantee that the gateway will have a subscriber number.
        #[unsafe(method(subscriberNumber))]
        #[unsafe(method_family = none)]
        pub unsafe fn subscriberNumber(&self);

        /// Get the current call list
        ///
        /// Gets the current call list (active, held, and setup in process). Each call is returned on the delegate method handsFree:currentCall.
        #[unsafe(method(currentCallList))]
        #[unsafe(method_family = none)]
        pub unsafe fn currentCallList(&self);

        /// Release all held calls
        ///
        /// Releases all held calls or sets User Determined User Busy for a waiting call.
        #[unsafe(method(releaseHeldCalls))]
        #[unsafe(method_family = none)]
        pub unsafe fn releaseHeldCalls(&self);

        /// Release all active calls
        ///
        /// Releases all active calls (if any exist) and accepts the other (held or waiting) call.
        #[unsafe(method(releaseActiveCalls))]
        #[unsafe(method_family = none)]
        pub unsafe fn releaseActiveCalls(&self);

        /// Release an active call.
        ///
        /// Releases the active call with index.
        ///
        /// Parameter `index`: Index of the call to release
        #[unsafe(method(releaseCall:))]
        #[unsafe(method_family = none)]
        pub unsafe fn releaseCall(&self, index: c_int);

        /// Place all active calls on hold
        ///
        /// Places all active calls (if any exist) on hold and accepts the other (held or waiting) call.
        #[unsafe(method(holdCall))]
        #[unsafe(method_family = none)]
        pub unsafe fn holdCall(&self);

        /// Place all other calls on hold.
        ///
        /// Places all calls on hold except call with index.
        ///
        /// Parameter `index`: Index of the call to not place on hold
        #[unsafe(method(placeAllOthersOnHold:))]
        #[unsafe(method_family = none)]
        pub unsafe fn placeAllOthersOnHold(&self, index: c_int);

        /// Add a held call to the current conversation
        ///
        /// Adds a held call to the current conversation.
        #[unsafe(method(addHeldCall))]
        #[unsafe(method_family = none)]
        pub unsafe fn addHeldCall(&self);

        /// Release all active calls
        ///
        /// Releases all active calls (if any exist) and accepts the other (held or waiting) call.
        #[unsafe(method(callTransfer))]
        #[unsafe(method_family = none)]
        pub unsafe fn callTransfer(&self);

        /// Transfer audio source to the computer.
        ///
        /// Transfers audio to the computer.
        #[unsafe(method(transferAudioToComputer))]
        #[unsafe(method_family = none)]
        pub unsafe fn transferAudioToComputer(&self);

        /// Transfer audio source to the phone.
        ///
        /// Transfers audio to the phone.
        #[unsafe(method(transferAudioToPhone))]
        #[unsafe(method_family = none)]
        pub unsafe fn transferAudioToPhone(&self);

        #[cfg(feature = "objc2-foundation")]
        /// Send an SMS to a number.
        ///
        /// Sends an SMS to aNumber with content aMessage. Currently this does not handle long SMS (>160 characters) or unicode messages.
        #[unsafe(method(sendSMS:message:))]
        #[unsafe(method_family = none)]
        pub unsafe fn sendSMS_message(
            &self,
            a_number: Option<&NSString>,
            a_message: Option<&NSString>,
        );

        #[cfg(feature = "objc2-foundation")]
        /// Send an AT command to the hands free gateway.
        ///
        /// Sends an AT command to the hands free gateway with a timeout of 10 seconds and handled by the built-in response handling.
        /// See sendAtCommand:timeout:selector:target for more details.
        ///
        /// Parameter `atCommand`: AT command to send
        #[unsafe(method(sendATCommand:))]
        #[unsafe(method_family = none)]
        pub unsafe fn sendATCommand(&self, at_command: Option<&NSString>);

        #[cfg(feature = "objc2-foundation")]
        /// Send an AT command to the hands free gateway.
        ///
        /// Sends an AT command to the hands free gateway with timeout.
        /// On command complete (OK, ERROR, TIMEOUT response or after timeout seconds) will perform selector on target.
        ///
        /// Parameter `atCommand`: AT command to send
        #[unsafe(method(sendATCommand:timeout:selector:target:))]
        #[unsafe(method_family = none)]
        pub unsafe fn sendATCommand_timeout_selector_target(
            &self,
            at_command: Option<&NSString>,
            timeout: c_float,
            selector: Option<Sel>,
            target: Option<&AnyObject>,
        );
    );
}

/// Methods declared on superclass `NSObject`.
#[cfg(feature = "IOBluetoothHandsFree")]
impl IOBluetoothHandsFreeDevice {
    extern_methods!(
        #[unsafe(method(init))]
        #[unsafe(method_family = init)]
        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;

        #[unsafe(method(new))]
        #[unsafe(method_family = new)]
        pub unsafe fn new() -> Retained<Self>;
    );
}

extern_protocol!(
    /// [Apple's documentation](https://developer.apple.com/documentation/iobluetooth/iobluetoothhandsfreedevicedelegate?language=objc)
    #[cfg(feature = "IOBluetoothHandsFree")]
    pub unsafe trait IOBluetoothHandsFreeDeviceDelegate:
        IOBluetoothHandsFreeDelegate
    {
        #[cfg(feature = "objc2-foundation")]
        /// Tells the delegate the service indicator has changed.
        ///
        /// Parameter `device`: The IOBluetoothHandsFreeDevice object
        ///
        /// Parameter `isServiceAvailable`: 0 if no service available; 1 otherwise.
        #[optional]
        #[unsafe(method(handsFree:isServiceAvailable:))]
        #[unsafe(method_family = none)]
        unsafe fn handsFree_isServiceAvailable(
            &self,
            device: Option<&IOBluetoothHandsFreeDevice>,
            is_service_available: Option<&NSNumber>,
        );

        #[cfg(feature = "objc2-foundation")]
        /// Tells the delegate the call indicator has changed.
        ///
        /// Parameter `device`: The IOBluetoothHandsFreeDevice object
        ///
        /// Parameter `isCallActive`: 0 if no call is active; 1 otherwise.
        #[optional]
        #[unsafe(method(handsFree:isCallActive:))]
        #[unsafe(method_family = none)]
        unsafe fn handsFree_isCallActive(
            &self,
            device: Option<&IOBluetoothHandsFreeDevice>,
            is_call_active: Option<&NSNumber>,
        );

        #[cfg(feature = "objc2-foundation")]
        /// Tells the delegate the call setup indicator has changed.
        ///
        /// Parameter `device`: The IOBluetoothHandsFreeDevice object
        ///
        /// Parameter `callSetupMode`: 0 if not currently in call setup.
        /// 1 if an incoming call is in call setup.
        /// 2 if an outgoing call is in call setup.
        /// 3 if the remote party is being alerted for an outgoing call.
        #[optional]
        #[unsafe(method(handsFree:callSetupMode:))]
        #[unsafe(method_family = none)]
        unsafe fn handsFree_callSetupMode(
            &self,
            device: Option<&IOBluetoothHandsFreeDevice>,
            call_setup_mode: Option<&NSNumber>,
        );

        #[cfg(feature = "objc2-foundation")]
        /// Tells the delegate the call held indicator has changed.
        ///
        /// Parameter `device`: The IOBluetoothHandsFreeDevice object
        ///
        /// Parameter `callHoldState`: 0 if no calls are held.
        /// 1 if a call is on hold and an active call exists.
        /// 2 if a call is on hold, but no active call exists.
        #[optional]
        #[unsafe(method(handsFree:callHoldState:))]
        #[unsafe(method_family = none)]
        unsafe fn handsFree_callHoldState(
            &self,
            device: Option<&IOBluetoothHandsFreeDevice>,
            call_hold_state: Option<&NSNumber>,
        );

        #[cfg(feature = "objc2-foundation")]
        /// Tells the delegate the signal indicator has changed.
        ///
        /// Parameter `device`: The IOBluetoothHandsFreeDevice object
        ///
        /// Parameter `signalStrength`: 0-5 where 0 represents a weak signal.
        #[optional]
        #[unsafe(method(handsFree:signalStrength:))]
        #[unsafe(method_family = none)]
        unsafe fn handsFree_signalStrength(
            &self,
            device: Option<&IOBluetoothHandsFreeDevice>,
            signal_strength: Option<&NSNumber>,
        );

        #[cfg(feature = "objc2-foundation")]
        /// Tells the delegate the roam indicator has changed.
        ///
        /// Parameter `device`: The IOBluetoothHandsFreeDevice object
        ///
        /// Parameter `isRoaming`: 0 if not roaming; 1 otherwise.
        #[optional]
        #[unsafe(method(handsFree:isRoaming:))]
        #[unsafe(method_family = none)]
        unsafe fn handsFree_isRoaming(
            &self,
            device: Option<&IOBluetoothHandsFreeDevice>,
            is_roaming: Option<&NSNumber>,
        );

        #[cfg(feature = "objc2-foundation")]
        /// Tells the delegate the battery charge indicator has changed.
        ///
        /// Parameter `device`: The IOBluetoothHandsFreeDevice object
        ///
        /// Parameter `batteryCharge`: 0-5 where 0 represents a low battery charge.
        #[optional]
        #[unsafe(method(handsFree:batteryCharge:))]
        #[unsafe(method_family = none)]
        unsafe fn handsFree_batteryCharge(
            &self,
            device: Option<&IOBluetoothHandsFreeDevice>,
            battery_charge: Option<&NSNumber>,
        );

        #[cfg(feature = "objc2-foundation")]
        /// Tells the delegate of an incoming call
        ///
        /// Parameter `device`: The IOBluetoothHandsFreeDevice object
        ///
        /// Parameter `number`: The remote caller's phone number
        #[optional]
        #[unsafe(method(handsFree:incomingCallFrom:))]
        #[unsafe(method_family = none)]
        unsafe fn handsFree_incomingCallFrom(
            &self,
            device: Option<&IOBluetoothHandsFreeDevice>,
            number: Option<&NSString>,
        );

        #[cfg(feature = "objc2-foundation")]
        /// Tells the delegate of a ring alert
        ///
        /// Parameter `device`: The IOBluetoothHandsFreeDevice object
        ///
        /// Parameter `ringAttempt`: The number or ring alerts received
        #[optional]
        #[unsafe(method(handsFree:ringAttempt:))]
        #[unsafe(method_family = none)]
        unsafe fn handsFree_ringAttempt(
            &self,
            device: Option<&IOBluetoothHandsFreeDevice>,
            ring_attempt: Option<&NSNumber>,
        );

        #[cfg(feature = "objc2-foundation")]
        /// Tells the delegate of a current call.
        ///
        /// Parameter `device`: The IOBluetoothHandsFreeDevice object
        ///
        /// Parameter `currentCall`: A dictionary representing a call. See "Hands free current call dictionary keys" for the keys and their values.
        #[optional]
        #[unsafe(method(handsFree:currentCall:))]
        #[unsafe(method_family = none)]
        unsafe fn handsFree_currentCall(
            &self,
            device: Option<&IOBluetoothHandsFreeDevice>,
            current_call: Option<&NSDictionary>,
        );

        #[cfg(feature = "objc2-foundation")]
        /// Tells the delegate a subscriber number.
        ///
        /// Parameter `device`: The IOBluetoothHandsFreeDevice object
        ///
        /// Parameter `subscriberNumber`: A subscriber number. Note that a gateway may have multiple subscriber numbers in which case this will be called for each number.
        #[optional]
        #[unsafe(method(handsFree:subscriberNumber:))]
        #[unsafe(method_family = none)]
        unsafe fn handsFree_subscriberNumber(
            &self,
            device: Option<&IOBluetoothHandsFreeDevice>,
            subscriber_number: Option<&NSString>,
        );

        #[cfg(feature = "objc2-foundation")]
        /// Tells the delegate an incoming SMS has arrived.
        ///
        /// Parameter `device`: The IOBluetoothHandsFreeDevice object
        ///
        /// Parameter `incomingSMS`: A dictionary representing an SMS. See "Hands free SMS dictionary keys" for the keys and their values.
        #[optional]
        #[unsafe(method(handsFree:incomingSMS:))]
        #[unsafe(method_family = none)]
        unsafe fn handsFree_incomingSMS(
            &self,
            device: Option<&IOBluetoothHandsFreeDevice>,
            sms: Option<&NSDictionary>,
        );

        #[cfg(feature = "objc2-foundation")]
        /// Tells the delegate an unknown result code was received. Use this to add support additional response codes.
        /// If a developer needs to change the handling of an implemented result code, they must use a subclass and override processResultCode:(NSString *)resultCode.
        ///
        /// Parameter `device`: The IOBluetoothHandsFreeDevice object
        ///
        /// Parameter `unhandledResultCode`: The result code.  "/r/n" are stripped from the begining and end of the result code.
        #[optional]
        #[unsafe(method(handsFree:unhandledResultCode:))]
        #[unsafe(method_family = none)]
        unsafe fn handsFree_unhandledResultCode(
            &self,
            device: Option<&IOBluetoothHandsFreeDevice>,
            result_code: Option<&NSString>,
        );
    }
);