Struct UNNotificationSound

#[repr(C)]
pub struct UNNotificationSound {
    pub ptr: Id<Object>,
}

The sound played upon delivery of a notification.

Fields

ptr: Id<Object>

The raw pointer to the Objective-C object.

Implementations

impl UNNotificationSound

pub fn default_sound() -> UNNotificationSound

Returns an object representing the default sound for notifications.

pub fn sound_named(name: UNNotificationSoundName) -> Self

Creates a sound object that represents a custom sound file.

pub fn default_critical_sound() -> UNNotificationSound

The default sound used for critical alerts.

pub fn default_critical_sound_with_audio_volume(volume: c_float) -> Self

Creates a sound object that plays the default critical alert sound at the volume you specify.

pub fn critical_sound_named(name: UNNotificationSoundName) -> Self

Creates a custom sound object for critical alerts.

pub fn critical_sound_named_with_audio_volume( name: UNNotificationSoundName, volume: c_float, ) -> Self

Creates a custom sound object for critical alerts with the volume you specify.

pub fn default_ringtone_sound() -> UNNotificationSound

pub fn ringtone_sound_named(name: UNNotificationSoundName) -> Self

Methods from Deref<Target = Object>

pub fn class(&self) -> &Class

Returns the class of self.

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T

where T: Encode,

Returns a reference to the ivar of self with the given name. Panics if self has no ivar with the given name. Unsafe because the caller must ensure that the ivar is actually of type T.

pub unsafe fn get_mut_ivar<T>(&mut self, name: &str) -> &mut T

where T: Encode,

Returns a mutable reference to the ivar of self with the given name. Panics if self has no ivar with the given name. Unsafe because the caller must ensure that the ivar is actually of type T.

pub unsafe fn set_ivar<T>(&mut self, name: &str, value: T)

where T: Encode,

Sets the value of the ivar of self with the given name. Panics if self has no ivar with the given name. Unsafe because the caller must ensure that the ivar is actually of type T.

Trait Implementations

impl Clone for UNNotificationSound

fn clone(&self) -> Self

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UNNotificationSound

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for UNNotificationSound

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for UNNotificationSound

fn deref_mut(&mut self) -> &mut Object

Mutably dereferences the value.

impl Display for UNNotificationSound

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Encode for UNNotificationSound

fn encode() -> Encoding

Returns the Objective-C type encoding for Self.

impl FromId for UNNotificationSound

unsafe fn from_id(ptr: id) -> Self

Returns Self representation of the object.

impl Hash for UNNotificationSound

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IUNNotificationSound for UNNotificationSound

fn p_default_sound() -> UNNotificationSound

Returns an object representing the default sound for notifications.

fn m_sound_named(name: UNNotificationSoundName) -> Self

where Self: Sized + FromId,

Creates a sound object that represents a custom sound file.

fn p_default_critical_sound() -> UNNotificationSound

The default sound used for critical alerts.

fn m_default_critical_sound_with_audio_volume(volume: c_float) -> Self

where Self: Sized + FromId,

Creates a sound object that plays the default critical alert sound at the volume you specify.

fn m_critical_sound_named(name: UNNotificationSoundName) -> Self

where Self: Sized + FromId,

Creates a custom sound object for critical alerts.

fn m_critical_sound_named_with_audio_volume( name: UNNotificationSoundName, volume: c_float, ) -> Self

where Self: Sized + FromId,

Creates a custom sound object for critical alerts with the volume you specify.

fn p_default_ringtone_sound() -> UNNotificationSound

fn m_ringtone_sound_named(name: UNNotificationSoundName) -> Self

where Self: Sized + FromId,

impl PNSObject for UNNotificationSound

fn m_class<'a>() -> &'a Class

Returns the class object for the receiver’s class.

fn m_self(&self) -> id

Returns the receiver.

fn m_new() -> Self

where Self: Sized + FromId,

Allocates a new instance of the receiving class, sends it an init message, and returns the initialized object.

fn m_alloc() -> Self

where Self: Sized + FromId,

Returns a new instance of the receiving class.

fn m_initialize()

Initializes the class before it receives its first message.

fn ip_superclass<'a>() -> Option<&'a Class>

Returns the class object for the receiver’s superclass.

fn m_is_equal(&self, object: &Self) -> bool

Returns a Boolean value that indicates whether the receiver and a given object are equal.

fn p_hash(&self) -> UInt

Returns an integer that can be used as a table address in a hash table structure.

fn m_is_kind_of_class(&self, class: Class) -> bool

Returns a Boolean value that indicates whether the receiver is an instance of given class or an instance of any class that inherits from that class.

fn m_is_member_of_class(&self, class: Class) -> bool

Returns a Boolean value that indicates whether the receiver is an instance of a given class.

fn m_responds_to_selector(&self, selector: Sel) -> bool

Returns a Boolean value that indicates whether the receiver implements or inherits a method that can respond to a specified message.

fn m_conforms_to_protocol(&self, protocol: Protocol) -> bool

Returns a Boolean value that indicates whether the receiver conforms to a given protocol.

fn p_description(&self) -> NSString

A textual representation of the receiver.

fn p_debug_description(&self) -> NSString

A textual representation of the receiver to use with a debugger.

fn m_perform_selector(&self, selector: Sel) -> id

Sends a specified message to the receiver and returns the result of the message.

fn m_perform_selector_with_object(&self, selector: Sel, with_object: id) -> id

Sends a message to the receiver with an object as the argument.

fn m_is_proxy(&self) -> bool

Returns a Boolean value that indicates whether the receiver does not descend from NSObject.

impl ToId for UNNotificationSound

fn to_id(self) -> id

Returns id representation of the object.