Struct CNContact

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

An immutable object that stores information about a single contact, such as the contact’s first name, phone numbers, and addresses.

Fields

ptr: Id<Object>

The raw pointer to the Objective-C object.

Implementations

impl CNContact

pub fn identifier(&self) -> NSString

A value that uniquely identifies a contact on the device.

pub fn contact_type(&self) -> CNContactType

An enum identifying the contact type.

pub fn name_prefix(&self) -> NSString

The name prefix of the contact.

pub fn given_name(&self) -> NSString

The given name of the contact.

pub fn middle_name(&self) -> NSString

The middle name of the contact.

pub fn family_name(&self) -> NSString

A string for the previous family name of the contact.

pub fn previous_family_name(&self) -> NSString

A string for the previous family name of the contact.

pub fn name_suffix(&self) -> NSString

The name suffix of the contact.

pub fn nickname(&self) -> NSString

The nickname of the contact.

pub fn phonetic_given_name(&self) -> NSString

The phonetic given name of the contact.

pub fn phonetic_middle_name(&self) -> NSString

The phonetic middle name of the contact.

pub fn phonetic_family_name(&self) -> NSString

The phonetic family name of the contact.

pub fn job_title(&self) -> NSString

The contact’s job title.

pub fn department_name(&self) -> NSString

The name of the department associated with the contact.

pub fn organization_name(&self) -> NSString

The name of the organization associated with the contact.

pub fn phonetic_organization_name(&self) -> NSString

The phonetic name of the organization associated with the contact.

pub fn postal_addresses(&self) -> NSArray<CNLabeledValue<CNPostalAddress>>

An array of labeled postal addresses for a contact.

pub fn email_addresses(&self) -> NSArray<CNLabeledValue<NSString>>

An array of labeled email addresses for the contact.

pub fn url_addresses(&self) -> NSArray<CNLabeledValue<NSString>>

An array of labeled URL addresses for a contact.

pub fn phone_numbers(&self) -> NSArray<CNLabeledValue<CNPhoneNumber>>

An array of labeled phone numbers for a contact.

pub fn social_profiles(&self) -> NSArray<CNLabeledValue<CNSocialProfile>>

An array of labeled social profiles for a contact.

pub fn birthday(&self) -> Option<NSDateComponents>

A date component for the Gregorian birthday of the contact.

pub fn non_gregorian_birthday(&self) -> Option<NSDateComponents>

A date component for the non-Gregorian birthday of the contact.

pub fn dates(&self) -> NSArray<CNLabeledValue<NSDateComponents>>

An array containing labeled Gregorian dates.

pub fn note(&self) -> NSString

A string containing notes for the contact.

pub fn image_data(&self) -> Option<NSData>

The profile picture of a contact.

pub fn thumbnail_image_data(&self) -> Option<NSData>

The thumbnail version of the contact’s profile picture.

pub fn image_data_available(&self) -> bool

A Boolean indicating whether a contact has a profile picture.

pub fn contact_relations(&self) -> NSArray<CNLabeledValue<CNContactRelation>>

An array of labeled relations for the contact.

pub fn instant_messaging_addresses( &self, ) -> NSArray<CNLabeledValue<CNInstantMessageAddress>>

An array of labeled IM addresses for the contact.

pub fn localized_string_for_key(property: NSString) -> NSString

Returns a string containing the localized contact property name.

pub fn descriptor_for_all_comparator_keys() -> id

Fetches all the keys required for the contact sort comparator.

pub fn comparator_for_name_sort_order( sort_order: CNContactSortOrder, ) -> NSComparator

Returns a comparator to sort contacts with the specified order.

pub fn is_unified_with_contact_with_identifier( &self, identifier: NSString, ) -> bool

Returns a Boolean indicating whether the current contact is a unified contact and includes a contact with the specified identifier.

pub fn is_key_available(&self, key: NSString) -> bool

Determines whether the contact property value for the specified key is fetched.

pub fn are_keys_available(&self, key_descriptors: NSArray<id>) -> bool

Determines whether all contact property values for the specified keys are fetched.

pub fn predicate_for_contacts_matching_name(name: NSString) -> NSPredicate

Returns a predicate to find the contacts matching the specified name.

pub fn predicate_for_contacts_with_identifiers( identifiers: NSArray<String>, ) -> NSPredicate

Returns a predicate to find the contacts matching the specified identifiers.

pub fn predicate_for_contacts_in_group_with_identifier( group: NSString, ) -> NSPredicate

Returns a predicate to find the contacts that are members in the specified group.

pub fn predicate_for_contacts_in_container_with_identifier( container: NSString, ) -> NSPredicate

Returns a predicate to find the contacts in the specified container.

pub fn predicate_for_contacts_matching_phone_number( phone_number: CNPhoneNumber, ) -> NSPredicate

Returns a predicate to find the contacts whose phone number matches the specified value.

pub fn predicate_for_contacts_matching_email_address( email_address: NSString, ) -> NSPredicate

Returns a predicate to find the contacts whose email address matches the specified value.

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 CNContact

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 CNContact

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

Formats the value using the given formatter.

impl Deref for CNContact

type Target = Object

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for CNContact

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

Mutably dereferences the value.

impl Display for CNContact

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

Formats the value using the given formatter.

impl Encode for CNContact

fn encode() -> Encoding

Returns the Objective-C type encoding for Self.

impl FromId for CNContact

unsafe fn from_id(ptr: id) -> Self

Returns Self representation of the object.

impl Hash for CNContact

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 ICNContact for CNContact

fn p_identifier(&self) -> NSString

A value that uniquely identifies a contact on the device.

fn p_contact_type(&self) -> CNContactType

An enum identifying the contact type.

fn p_name_prefix(&self) -> NSString

The name prefix of the contact.

fn p_given_name(&self) -> NSString

The given name of the contact.

fn p_middle_name(&self) -> NSString

The middle name of the contact.

fn p_family_name(&self) -> NSString

A string for the previous family name of the contact.

fn p_previous_family_name(&self) -> NSString

A string for the previous family name of the contact.

fn p_name_suffix(&self) -> NSString

The name suffix of the contact.

fn p_nickname(&self) -> NSString

The nickname of the contact.

fn p_phonetic_given_name(&self) -> NSString

The phonetic given name of the contact.

fn p_phonetic_middle_name(&self) -> NSString

The phonetic middle name of the contact.

fn p_phonetic_family_name(&self) -> NSString

The phonetic family name of the contact.

fn p_job_title(&self) -> NSString

The contact’s job title.

fn p_department_name(&self) -> NSString

The name of the department associated with the contact.

fn p_organization_name(&self) -> NSString

The name of the organization associated with the contact.

fn p_phonetic_organization_name(&self) -> NSString

The phonetic name of the organization associated with the contact.

fn p_postal_addresses(&self) -> NSArray<CNLabeledValue<CNPostalAddress>>

An array of labeled postal addresses for a contact.

fn p_email_addresses(&self) -> NSArray<CNLabeledValue<NSString>>

An array of labeled email addresses for the contact.

fn p_url_addresses(&self) -> NSArray<CNLabeledValue<NSString>>

An array of labeled URL addresses for a contact.

fn p_phone_numbers(&self) -> NSArray<CNLabeledValue<CNPhoneNumber>>

An array of labeled phone numbers for a contact.

fn p_social_profiles(&self) -> NSArray<CNLabeledValue<CNSocialProfile>>

An array of labeled social profiles for a contact.

fn p_birthday(&self) -> Option<NSDateComponents>

A date component for the Gregorian birthday of the contact.

fn p_non_gregorian_birthday(&self) -> Option<NSDateComponents>

A date component for the non-Gregorian birthday of the contact.

fn p_dates(&self) -> NSArray<CNLabeledValue<NSDateComponents>>

An array containing labeled Gregorian dates.

fn p_note(&self) -> NSString

A string containing notes for the contact.

fn p_image_data(&self) -> Option<NSData>

The profile picture of a contact.

fn p_thumbnail_image_data(&self) -> Option<NSData>

The thumbnail version of the contact’s profile picture.

fn p_image_data_available(&self) -> bool

A Boolean indicating whether a contact has a profile picture.

fn p_contact_relations(&self) -> NSArray<CNLabeledValue<CNContactRelation>>

An array of labeled relations for the contact.

fn p_instant_messaging_addresses( &self, ) -> NSArray<CNLabeledValue<CNInstantMessageAddress>>

An array of labeled IM addresses for the contact.

fn m_localized_string_for_key(property: NSString) -> NSString

Returns a string containing the localized contact property name.

fn m_descriptor_for_all_comparator_keys() -> id

Fetches all the keys required for the contact sort comparator.

fn m_comparator_for_name_sort_order( sort_order: CNContactSortOrder, ) -> NSComparator

Returns a comparator to sort contacts with the specified order.

fn m_is_unified_with_contact_with_identifier( &self, identifier: NSString, ) -> bool

Returns a Boolean indicating whether the current contact is a unified contact and includes a contact with the specified identifier.

fn m_is_key_available(&self, key: NSString) -> bool

Determines whether the contact property value for the specified key is fetched.

fn m_are_keys_available(&self, key_descriptors: NSArray<id>) -> bool

Determines whether all contact property values for the specified keys are fetched.

fn m_predicate_for_contacts_matching_name(name: NSString) -> NSPredicate

Returns a predicate to find the contacts matching the specified name.

fn m_predicate_for_contacts_with_identifiers( identifiers: NSArray<String>, ) -> NSPredicate

Returns a predicate to find the contacts matching the specified identifiers.

fn m_predicate_for_contacts_in_group_with_identifier( group: NSString, ) -> NSPredicate

Returns a predicate to find the contacts that are members in the specified group.

fn m_predicate_for_contacts_in_container_with_identifier( container: NSString, ) -> NSPredicate

Returns a predicate to find the contacts in the specified container.

fn m_predicate_for_contacts_matching_phone_number( phone_number: CNPhoneNumber, ) -> NSPredicate

Returns a predicate to find the contacts whose phone number matches the specified value.

fn m_predicate_for_contacts_matching_email_address( email_address: NSString, ) -> NSPredicate

Returns a predicate to find the contacts whose email address matches the specified value.

impl PNSObject for CNContact

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 CNContact

fn to_id(self) -> id

Returns id representation of the object.