CNContact CNContact Class

Definition

Represents a contact such as a person or business and holds their data, such as name, phone numbers, etc.

[Foundation.Register("CNContact", true)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 9, 0, ObjCRuntime.PlatformArchitecture.All, null)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.MacOSX, 10, 11, ObjCRuntime.PlatformArchitecture.Arch64, null)]
public class CNContact : Foundation.NSObject, Foundation.INSItemProviderReading, Foundation.INSItemProviderWriting, Foundation.INSMutableCopying, Foundation.INSSecureCoding, IDisposable
type CNContact = class
    inherit NSObject
    interface INSCoding
    interface INativeObject
    interface IDisposable
    interface INSCopying
    interface INSItemProviderReading
    interface INSItemProviderWriting
    interface INSMutableCopying
    interface INSSecureCoding
Inheritance
CNContactCNContact
Derived
Attributes
Implements

Constructors

CNContact() CNContact()

Default constructor, initializes a new instance of this class.

CNContact(IntPtr) CNContact(IntPtr)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

CNContact(NSCoder) CNContact(NSCoder)

A constructor that initializes the object from the data stored in the unarchiver object.

CNContact(NSObjectFlag) CNContact(NSObjectFlag)

Constructor to call on derived classes to skip initialization and merely allocate the object.

Properties

Birthday Birthday

The birthday of the Contact, in the Gregorian calendar.

Class Class Inherited from NSObject
ClassHandle ClassHandle

The handle for this class.

ContactRelations ContactRelations

An array of CNLabeledValue<ValueType> objects containing the name of the relation and a reference to the related CNContact.

ContactType ContactType

Specifies whether this is an organization or a person.

Dates Dates

An array of CNLabeledValue<ValueType> objects containing the name of the date and their value, in the Gregorian calendar.

DebugDescription DebugDescription

A developer-meaningful description of this object.

(Inherited from NSObject)
DepartmentName DepartmentName

The work department of the contact.

Description Description

Description of the object, the Objective-C version of ToString.

(Inherited from NSObject)
EmailAddresses EmailAddresses

An array of CNLabeledValue<ValueType> objects containing the label of the email and a string value.

ErrorDomain ErrorDomain

Returns the constant name of the Contacts error domain.

FamilyName FamilyName

Returns the contact's family name.

GivenName GivenName

Returns the given name of the contact.

Handle Handle

Handle (pointer) to the unmanaged object representation.

(Inherited from NSObject)
Identifier Identifier

A device-unique identifier for this contact. Persists over time on the device, but is not universally consistent.

ImageData ImageData

The profile picture for the contact.

ImageDataAvailable ImageDataAvailable

Whether ImageData holds an image.

InstantMessageAddresses InstantMessageAddresses

An array of CNLabeledValue<ValueType> objects containing the name of the IM service and a string containing the address.

IsDirectBinding IsDirectBinding Inherited from NSObject
IsProxy IsProxy Inherited from NSObject
JobTitle JobTitle

The title of the job held by the CNContact.

MiddleName MiddleName

The middle name of the CNContact.

NamePrefix NamePrefix

The name prefix of the CNContact.

NameSuffix NameSuffix

The name suffix of the CNContact.

Nickname Nickname

An affectionate name for the CNContact, like 'Code-master' or 'Mr. F#'.

NonGregorianBirthday NonGregorianBirthday

Birthday represented in a non-Gregorian calendar.

Note Note

Freeform text associated with the CNContact.

OrganizationName OrganizationName

The name of the organization associated with the CNContact.

PhoneNumbers PhoneNumbers

An array of CNLabeledValue<ValueType> objects containing the name of the phone number and the value as a CNPhoneNumber.

PhoneticFamilyName PhoneticFamilyName

The family name of the CNContact, represented as a phonetic string.

PhoneticGivenName PhoneticGivenName

The given name of the CNContact, represented as a phonetic string.

PhoneticMiddleName PhoneticMiddleName

The middle name of the CNContact, represented as a phonetic string.

PhoneticOrganizationName PhoneticOrganizationName

The organization name of the CNContact, represented as a phonetic string.

PostalAddresses PostalAddresses

An array of CNLabeledValue<ValueType> objects containing the name of the address and the value as a CNPostalAddress object.

PreviousFamilyName PreviousFamilyName

The previous family name of the CNContact (for instance, the maiden name).

PropertyNotFetchedExceptionName PropertyNotFetchedExceptionName

Used as the name of an exception thrown when attempting to read a property that has not been fetched.

ReadableTypeIdentifiers ReadableTypeIdentifiers
RetainCount RetainCount

Returns the current Objective-C retain count for the object.

(Inherited from NSObject)
Self Self Inherited from NSObject
SocialProfiles SocialProfiles

An array of CNLabeledValue<ValueType> objects containing the name of the social service and the value as a T:Contacts.CNSocialService object.

Superclass Superclass Inherited from NSObject
SuperHandle SuperHandle

Handle used to represent the methods in the base class for this NSObject.

(Inherited from NSObject)
ThumbnailImageData ThumbnailImageData

Thumbnail version of the CNContact's profile picture.

UrlAddresses UrlAddresses

An array of CNLabeledValue<ValueType> objects containing the name of the URL and a string value holding the URL address.

WritableTypeIdentifiers WritableTypeIdentifiers
WritableTypeIdentifiersForItemProvider WritableTypeIdentifiersForItemProvider
Zone Zone Inherited from NSObject

Methods

AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr) AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using NSString keyPath).   Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr) AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using string keyPath).   Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>) AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>) AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AreKeysAvailable(CNContactOptions) AreKeysAvailable(CNContactOptions)

Whether the keys specified in options are available.

AreKeysAvailable(NSArray) AreKeysAvailable(NSArray)

Whether the keys described in keyDescriptors are available.

AreKeysAvailable<T>(T[]) AreKeysAvailable<T>(T[])

Whether the keys described in keyDescriptors are available.

AwakeFromNib() AwakeFromNib()

Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib().

(Inherited from NSObject)
BeginInvokeOnMainThread(Action) BeginInvokeOnMainThread(Action) Inherited from NSObject
BeginInvokeOnMainThread(Selector, NSObject) BeginInvokeOnMainThread(Selector, NSObject)

Invokes asynchrously the specified code on the main UI thread.

(Inherited from NSObject)
Bind(NSString, NSObject, String, NSDictionary) Bind(NSString, NSObject, String, NSDictionary) Inherited from NSObject
Bind(String, NSObject, String, NSDictionary) Bind(String, NSObject, String, NSDictionary) Inherited from NSObject
BindingInfo(String) BindingInfo(String) Inherited from NSObject
BindingOptionDescriptions(String) BindingOptionDescriptions(String) Inherited from NSObject
BindingValueClass(String) BindingValueClass(String) Inherited from NSObject
CommitEditing() CommitEditing() Inherited from NSObject
CommitEditing(NSObject, Selector, IntPtr) CommitEditing(NSObject, Selector, IntPtr) Inherited from NSObject
ComparatorForName(CNContactSortOrder) ComparatorForName(CNContactSortOrder)

The sorting function for the specified sortOrder.

ConformsToProtocol(IntPtr) ConformsToProtocol(IntPtr)

Invoked to determine if this object implements the specified protocol.

(Inherited from NSObject)
Copy() Copy()

Performs a copy of the underlying Objective-C object.

(Inherited from NSObject)
Copy(NSZone) Copy(NSZone)

Performs a copy of the underlying Objective-C object.

DangerousAutorelease() DangerousAutorelease() Inherited from NSObject
DangerousRelease() DangerousRelease() Inherited from NSObject
DangerousRetain() DangerousRetain() Inherited from NSObject
DidChange(NSKeyValueChange, NSIndexSet, NSString) DidChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates a change occurred to the indexes for a to-many relationship.

(Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet) DidChange(NSString, NSKeyValueSetMutationKind, NSSet) Inherited from NSObject
DidChangeValue(String) DidChangeValue(String)

Indicates that a change occurred on the specified key.

(Inherited from NSObject)
Dispose() Dispose()

Releases the resources used by the NSObject object.

(Inherited from NSObject)
Dispose(Boolean) Dispose(Boolean)

Releases the resources used by the NSObject object.

(Inherited from NSObject)
DoesNotRecognizeSelector(Selector) DoesNotRecognizeSelector(Selector)

Indicates that this object does not recognize the specified selector.

(Inherited from NSObject)
EncodeTo(NSCoder) EncodeTo(NSCoder)

Encodes the state of the object on the provided encoder

Equals(NSObject) Equals(NSObject) Inherited from NSObject
Equals(Object) Equals(Object) Inherited from NSObject
ExposedBindings() ExposedBindings() Inherited from NSObject
GetBindingInfo(NSString) GetBindingInfo(NSString) Inherited from NSObject
GetBindingOptionDescriptions(NSString) GetBindingOptionDescriptions(NSString) Inherited from NSObject
GetBindingValueClass(NSString) GetBindingValueClass(NSString) Inherited from NSObject
GetDescriptorForAllComparatorKeys() GetDescriptorForAllComparatorKeys()

Returns the aggregate key descriptor needed to perform sorting.

GetDictionaryOfValuesFromKeys(NSString[]) GetDictionaryOfValuesFromKeys(NSString[])

Retrieves the values of the specified keys.

(Inherited from NSObject)
GetHashCode() GetHashCode()

Generates a hash code for the current instance.

(Inherited from NSObject)
GetItemProviderVisibilityForTypeIdentifier(String) GetItemProviderVisibilityForTypeIdentifier(String)
GetMethodForSelector(Selector) GetMethodForSelector(Selector) Inherited from NSObject
GetNativeField(String) GetNativeField(String) Inherited from NSObject
GetNativeHash() GetNativeHash() Inherited from NSObject
GetObject(NSData, String, NSError) GetObject(NSData, String, NSError)
GetPredicateForContacts(CNPhoneNumber) GetPredicateForContacts(CNPhoneNumber)
GetPredicateForContacts(String) GetPredicateForContacts(String)

Retrieves a predicate that filters for matchingName.

GetPredicateForContacts(String[]) GetPredicateForContacts(String[])

Retrieves a predicate that will match identifiers with Identifier.

GetPredicateForContactsInContainer(String) GetPredicateForContactsInContainer(String)

A predicate that will match all contacts in containerIdentifier.

GetPredicateForContactsInGroup(String) GetPredicateForContactsInGroup(String)

A NSPredicate that will match all contacts in the group identified by groupIdentifier.

GetPredicateForContactsMatchingEmailAddress(String) GetPredicateForContactsMatchingEmailAddress(String)
Init() Init() Inherited from NSObject
InitializeHandle(IntPtr) InitializeHandle(IntPtr) Inherited from NSObject
InitializeHandle(IntPtr, String) InitializeHandle(IntPtr, String) Inherited from NSObject
Invoke(Action, Double) Invoke(Action, Double) Inherited from NSObject
Invoke(Action, TimeSpan) Invoke(Action, TimeSpan) Inherited from NSObject
InvokeOnMainThread(Action) InvokeOnMainThread(Action) Inherited from NSObject
InvokeOnMainThread(Selector, NSObject) InvokeOnMainThread(Selector, NSObject)

Invokes synchrously the specified code on the main UI thread.

(Inherited from NSObject)
IsEqual(NSObject) IsEqual(NSObject) Inherited from NSObject
IsKeyAvailable(CNContactOptions) IsKeyAvailable(CNContactOptions)

Whether the key described in options is available for this CNContact.

IsKeyAvailable(NSString) IsKeyAvailable(NSString)

Whether the key contactKey is available for this CNContact.

IsKindOfClass(Class) IsKindOfClass(Class) Inherited from NSObject
IsMemberOfClass(Class) IsMemberOfClass(Class) Inherited from NSObject
IsUnifiedWithContact(String) IsUnifiedWithContact(String)

Whether this CNContact is unified with the specified CNContact.

LoadData(String, Action<NSData,NSError>) LoadData(String, Action<NSData,NSError>)

Implement this method to customize the loading of data by an NSItemProvider.

LoadDataAsync(String) LoadDataAsync(String)
LoadDataAsync(String, NSProgress) LoadDataAsync(String, NSProgress)
LocalizeProperty(CNContactOptions) LocalizeProperty(CNContactOptions)

Gets the localized version of the key described in options.

LocalizeProperty(NSString) LocalizeProperty(NSString)

Gets the localized value of contactKey.

MarkDirty() MarkDirty()

Promotes a regular peer object (IsDirectBinding is true) into a toggleref object.

(Inherited from NSObject)
MutableCopy() MutableCopy()

Creates a mutable copy of the specified NSObject.

(Inherited from NSObject)
MutableCopy(NSZone) MutableCopy(NSZone)

Performs a copy of the underlying Objective-C object.

ObjectDidEndEditing(NSObject) ObjectDidEndEditing(NSObject) Inherited from NSObject
ObserveValue(NSString, NSObject, NSDictionary, IntPtr) ObserveValue(NSString, NSObject, NSDictionary, IntPtr)

Indicates that the value at the specified keyPath relative to this object has changed.

(Inherited from NSObject)
PerformSelector(Selector) PerformSelector(Selector) Inherited from NSObject
PerformSelector(Selector, NSObject) PerformSelector(Selector, NSObject) Inherited from NSObject
PerformSelector(Selector, NSObject, Double) PerformSelector(Selector, NSObject, Double)

Invokes the selector on the current instance and if the obj is not null, it passes this as its single parameter.

(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double, NSString[]) PerformSelector(Selector, NSObject, Double, NSString[]) Inherited from NSObject
PerformSelector(Selector, NSObject, NSObject) PerformSelector(Selector, NSObject, NSObject) Inherited from NSObject
PerformSelector(Selector, NSThread, NSObject, Boolean) PerformSelector(Selector, NSThread, NSObject, Boolean) Inherited from NSObject
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) Inherited from NSObject
PrepareForInterfaceBuilder() PrepareForInterfaceBuilder() Inherited from NSObject
RemoveObserver(NSObject, NSString) RemoveObserver(NSObject, NSString)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, NSString, IntPtr) RemoveObserver(NSObject, NSString, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RemoveObserver(NSObject, String) RemoveObserver(NSObject, String)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr) RemoveObserver(NSObject, String, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RespondsToSelector(Selector) RespondsToSelector(Selector)

Whether this object recognizes the specified selector.

(Inherited from NSObject)
SetNativeField(String, NSObject) SetNativeField(String, NSObject) Inherited from NSObject
SetNilValueForKey(NSString) SetNilValueForKey(NSString)

Sets the value of the specified key to null.

(Inherited from NSObject)
SetValueForKey(NSObject, NSString) SetValueForKey(NSObject, NSString)

Sets the value of the property specified by the key to the specified value.

(Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString) SetValueForKeyPath(IntPtr, NSString)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

(Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString) SetValueForKeyPath(NSObject, NSString)

Sets the value of a property that can be reached using a keypath.

(Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString) SetValueForUndefinedKey(NSObject, NSString)

Indicates an attempt to write a value to an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary) SetValuesForKeysWithDictionary(NSDictionary)

Sets the values of this NSObject to those in the specified dictionary.

(Inherited from NSObject)
ToString() ToString()

Returns a string representation of the value of the current instance.

(Inherited from NSObject)
Unbind(NSString) Unbind(NSString) Inherited from NSObject
Unbind(String) Unbind(String) Inherited from NSObject
ValueForKey(NSString) ValueForKey(NSString)

Returns the value of the property associated with the specified key.

(Inherited from NSObject)
ValueForKeyPath(NSString) ValueForKeyPath(NSString)

Returns the value of a property that can be reached using a keypath.

(Inherited from NSObject)
ValueForUndefinedKey(NSString) ValueForUndefinedKey(NSString)

Indicates an attempt to read a value of an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString) WillChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates that the values of the specified indices in the specified key are about to change.

(Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet) WillChange(NSString, NSKeyValueSetMutationKind, NSSet) Inherited from NSObject
WillChangeValue(String) WillChangeValue(String)

Indicates that the value of the specified key is about to change.

(Inherited from NSObject)

Extension Methods

ObjectDidBeginEditing(NSObject, INSEditor) ObjectDidBeginEditing(NSObject, INSEditor)
ObjectDidEndEditing(NSObject, INSEditor) ObjectDidEndEditing(NSObject, INSEditor)
GetValidModes(NSObject, NSFontPanel) GetValidModes(NSObject, NSFontPanel)
ValidateToolbarItem(NSObject, NSToolbarItem) ValidateToolbarItem(NSObject, NSToolbarItem)
GetItemProviderVisibilityForTypeIdentifier(INSItemProviderWriting, String) GetItemProviderVisibilityForTypeIdentifier(INSItemProviderWriting, String)
GetWritableTypeIdentifiersForItemProvider(INSItemProviderWriting) GetWritableTypeIdentifiersForItemProvider(INSItemProviderWriting)
LoadDataAsync(INSItemProviderWriting, String) LoadDataAsync(INSItemProviderWriting, String)
LoadDataAsync(INSItemProviderWriting, String, NSProgress) LoadDataAsync(INSItemProviderWriting, String, NSProgress)
GetDebugDescription(INSObjectProtocol) GetDebugDescription(INSObjectProtocol)
AcceptsPreviewPanelControl(NSObject, QLPreviewPanel) AcceptsPreviewPanelControl(NSObject, QLPreviewPanel)
BeginPreviewPanelControl(NSObject, QLPreviewPanel) BeginPreviewPanelControl(NSObject, QLPreviewPanel)
EndPreviewPanelControl(NSObject, QLPreviewPanel) EndPreviewPanelControl(NSObject, QLPreviewPanel)
GetAccessibilityCustomRotors(NSObject) GetAccessibilityCustomRotors(NSObject)

Gets the array of UIAccessibilityCustomRotor objects appropriate for this object.

SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[]) SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])

Sets the array of UIAccessibilityCustomRotor objects appropriate for this object.

Applies to

See also