apple.contacts

Class CNContact

java.lang.Object

org.moe.natj.general.NativeObject

org.moe.natj.objc.ObjCObject

apple.NSObject

apple.contacts.CNContact

All Implemented Interfaces:

NSCoding, NSCopying, NSItemProviderReading, NSItemProviderWriting, NSMutableCopying, NSSecureCoding, NSObject

Direct Known Subclasses:

CNMutableContact

public class CNContact
extends NSObject
implements NSCopying, NSMutableCopying, NSSecureCoding, NSItemProviderReading, NSItemProviderWriting

An immutable value object representing a contact.

CNContact is thread safe.

If using a CNContact instance where you are not certain of the keys that were fetched, use isKeyAvailable: or areKeysAvailable:. If these return NO you need to refetch the contact by the contact identifier with the keys you want to fetch. Accessing a property that was not fetched will throw CNContactPropertyNotFetchedExceptionName.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CNContact.Block_comparatorForNameSortOrder_ret

Nested classes/interfaces inherited from class apple.NSObject

NSObject.Function_instanceMethodForSelector_ret, NSObject.Function_methodForSelector_ret

Nested classes/interfaces inherited from interface apple.foundation.protocol.NSItemProviderWriting

NSItemProviderWriting.Block_loadDataWithTypeIdentifierForItemProviderCompletionHandler

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CNContact(org.moe.natj.general.Pointer peer)

Method Summary

Modifier and Type	Method and Description
long	_itemProviderVisibilityForRepresentationWithTypeIdentifier_static(java.lang.String typeIdentifier)
CNContact	_objectWithItemProviderDataTypeIdentifierError(NSData data, java.lang.String typeIdentifier, org.moe.natj.general.ptr.Ptr<NSError> outError)
NSArray<java.lang.String>	_readableTypeIdentifiersForItemProvider()
boolean	_supportsSecureCoding() This property must return YES on all classes that allow secure coding.
NSArray<java.lang.String>	_writableTypeIdentifiersForItemProvider_static()
static boolean	accessInstanceVariablesDirectly()
static CNContact	alloc()
static CNContact	allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)
boolean	areKeysAvailable(NSArray<?> keyDescriptors) Returns YES if the values for the keys specified by all the descriptors were fetched.
static boolean	automaticallyNotifiesObserversForKey(java.lang.String key)
NSDateComponents	birthday() The Gregorian birthday.
static void	cancelPreviousPerformRequestsWithTarget(java.lang.Object aTarget)
static void	cancelPreviousPerformRequestsWithTargetSelectorObject(java.lang.Object aTarget, org.moe.natj.objc.SEL aSelector, java.lang.Object anArgument)
static NSArray<java.lang.String>	classFallbacksForKeyedArchiver()
static org.moe.natj.objc.Class	classForKeyedUnarchiver()
static CNContact.Block_comparatorForNameSortOrder_ret	comparatorForNameSortOrder(long sortOrder) The contact comparator for a given sort order.
NSArray<? extends CNLabeledValue<CNContactRelation>>	contactRelations()
long	contactType()
java.lang.Object	copyWithZone(org.moe.natj.general.ptr.VoidPtr zone)
NSArray<? extends CNLabeledValue<NSDateComponents>>	dates() Other Gregorian dates (anniversaries, etc).
static java.lang.String	debugDescription_static()
java.lang.String	departmentName()
static java.lang.String	description_static()
static CNKeyDescriptor	descriptorForAllComparatorKeys() Use to fetch all contact keys required for the contact sort comparator.
NSArray<? extends CNLabeledValue<java.lang.String>>	emailAddresses()
void	encodeWithCoder(NSCoder coder)
java.lang.String	familyName()
java.lang.String	givenName()
static long	hash_static()
java.lang.String	identifier() The identifier is unique among contacts on the device.
NSData	imageData()
boolean	imageDataAvailable()
CNContact	init()
CNContact	initWithCoder(NSCoder coder) NS_DESIGNATED_INITIALIZER
static NSObject.Function_instanceMethodForSelector_ret	instanceMethodForSelector(org.moe.natj.objc.SEL aSelector)
static NSMethodSignature	instanceMethodSignatureForSelector(org.moe.natj.objc.SEL aSelector)
static boolean	instancesRespondToSelector(org.moe.natj.objc.SEL aSelector)
NSArray<? extends CNLabeledValue<CNInstantMessageAddress>>	instantMessageAddresses()
boolean	isKeyAvailable(java.lang.String key) Returns YES if the value for the specified key was fetched.
static boolean	isSubclassOfClass(org.moe.natj.objc.Class aClass)
boolean	isUnifiedWithContactWithIdentifier(java.lang.String contactIdentifier) Unification Returns YES if the receiver was fetched as a unified contact and includes the contact having contactIdentifier in its unification
static long	itemProviderVisibilityForRepresentationWithTypeIdentifier_static(java.lang.String typeIdentifier)
long	itemProviderVisibilityForRepresentationWithTypeIdentifier(java.lang.String typeIdentifier)
java.lang.String	jobTitle()
static NSSet<java.lang.String>	keyPathsForValuesAffectingValueForKey(java.lang.String key)
NSProgress	loadDataWithTypeIdentifierForItemProviderCompletionHandler(java.lang.String typeIdentifier, NSItemProviderWriting.Block_loadDataWithTypeIdentifierForItemProviderCompletionHandler completionHandler) One of writableTypeIdentifiersForItemProvider
static java.lang.String	localizedStringForKey(java.lang.String key) Returns a user displayable property name.
java.lang.String	middleName()
java.lang.Object	mutableCopyWithZone(org.moe.natj.general.ptr.VoidPtr zone)
java.lang.String	namePrefix()
java.lang.String	nameSuffix()
static CNContact	new_objc()
java.lang.String	nickname()
NSDateComponents	nonGregorianBirthday() The alternate birthday (Lunisolar).
java.lang.String	note()
static CNContact	objectWithItemProviderDataTypeIdentifierError(NSData data, java.lang.String typeIdentifier, org.moe.natj.general.ptr.Ptr<NSError> outError)
java.lang.String	organizationName()
NSArray<? extends CNLabeledValue<CNPhoneNumber>>	phoneNumbers()
java.lang.String	phoneticFamilyName()
java.lang.String	phoneticGivenName()
java.lang.String	phoneticMiddleName()
java.lang.String	phoneticOrganizationName()
NSArray<? extends CNLabeledValue<CNPostalAddress>>	postalAddresses()
static NSPredicate	predicateForContactsInContainerWithIdentifier(java.lang.String containerIdentifier)
static NSPredicate	predicateForContactsInGroupWithIdentifier(java.lang.String groupIdentifier)
static NSPredicate	predicateForContactsMatchingEmailAddress(java.lang.String emailAddress) Fetch contacts matching an email address.
static NSPredicate	predicateForContactsMatchingName(java.lang.String name) To fetch contacts matching a name.
static NSPredicate	predicateForContactsMatchingPhoneNumber(CNPhoneNumber phoneNumber) Fetch contacts matching a phone number.
static NSPredicate	predicateForContactsWithIdentifiers(NSArray<java.lang.String> identifiers) To fetch contacts matching contact identifiers.
java.lang.String	previousFamilyName()
static NSArray<java.lang.String>	readableTypeIdentifiersForItemProvider()
static boolean	resolveClassMethod(org.moe.natj.objc.SEL sel)
static boolean	resolveInstanceMethod(org.moe.natj.objc.SEL sel)
static void	setVersion_static(long aVersion)
NSArray<? extends CNLabeledValue<CNSocialProfile>>	socialProfiles()
static org.moe.natj.objc.Class	superclass_static()
static boolean	supportsSecureCoding()
NSData	thumbnailImageData()
NSArray<? extends CNLabeledValue<java.lang.String>>	urlAddresses()
static long	version_static()
static NSArray<java.lang.String>	writableTypeIdentifiersForItemProvider_static()
NSArray<java.lang.String>	writableTypeIdentifiersForItemProvider()

Methods inherited from class apple.NSObject

accessibilityActivate, accessibilityActivationPoint, accessibilityAssistiveTechnologyFocusedIdentifiers, accessibilityAttributedHint, accessibilityAttributedLabel, accessibilityAttributedUserInputLabels, accessibilityAttributedValue, accessibilityContainerType, accessibilityCustomActions, accessibilityCustomRotors, accessibilityDecrement, accessibilityDragSourceDescriptors, accessibilityDropPointDescriptors, accessibilityElementAtIndex, accessibilityElementCount, accessibilityElementDidBecomeFocused, accessibilityElementDidLoseFocus, accessibilityElementIsFocused, accessibilityElements, accessibilityElementsHidden, accessibilityFrame, accessibilityHint, accessibilityIncrement, accessibilityLabel, accessibilityLanguage, accessibilityNavigationStyle, accessibilityPath, accessibilityPerformEscape, accessibilityPerformMagicTap, accessibilityRespondsToUserInteraction, accessibilityScroll, accessibilityTextualContext, accessibilityTraits, accessibilityUserInputLabels, accessibilityValue, accessibilityViewIsModal, addObserverForKeyPathOptionsContext, attemptRecoveryFromErrorOptionIndex, attemptRecoveryFromErrorOptionIndexDelegateDidRecoverSelectorContextInfo, autoContentAccessingProxy, awakeAfterUsingCoder, awakeFromNib, class_objc, classForCoder, classForKeyedArchiver, copy, dealloc, debugDescription, description, dictionaryWithValuesForKeys, didChangeValueForKey, didChangeValueForKeyWithSetMutationUsingObjects, didChangeValuesAtIndexesForKey, doesNotRecognizeSelector, fileManagerShouldProceedAfterError, fileManagerWillProcessPath, finalize_objc, forwardingTargetForSelector, forwardInvocation, hash, indexOfAccessibilityElement, isAccessibilityElement, isEqual, isKindOfClass, isMemberOfClass, isProxy, methodForSelector, methodSignatureForSelector, mutableArrayValueForKey, mutableArrayValueForKeyPath, mutableCopy, mutableOrderedSetValueForKey, mutableOrderedSetValueForKeyPath, mutableSetValueForKey, mutableSetValueForKeyPath, observationInfo, observeValueForKeyPathOfObjectChangeContext, performSelector, performSelectorInBackgroundWithObject, performSelectorOnMainThreadWithObjectWaitUntilDone, performSelectorOnMainThreadWithObjectWaitUntilDoneModes, performSelectorOnThreadWithObjectWaitUntilDone, performSelectorOnThreadWithObjectWaitUntilDoneModes, performSelectorWithObject, performSelectorWithObjectAfterDelay, performSelectorWithObjectAfterDelayInModes, performSelectorWithObjectWithObject, prepareForInterfaceBuilder, provideImageDataBytesPerRowOrigin_Size_UserInfo, removeObserverForKeyPath, removeObserverForKeyPathContext, replacementObjectForCoder, replacementObjectForKeyedArchiver, respondsToSelector, self, setAccessibilityActivationPoint, setAccessibilityAttributedHint, setAccessibilityAttributedLabel, setAccessibilityAttributedUserInputLabels, setAccessibilityAttributedValue, setAccessibilityContainerType, setAccessibilityCustomActions, setAccessibilityCustomRotors, setAccessibilityDragSourceDescriptors, setAccessibilityDropPointDescriptors, setAccessibilityElements, setAccessibilityElementsHidden, setAccessibilityFrame, setAccessibilityHint, setAccessibilityLabel, setAccessibilityLanguage, setAccessibilityNavigationStyle, setAccessibilityPath, setAccessibilityRespondsToUserInteraction, setAccessibilityTextualContext, setAccessibilityTraits, setAccessibilityUserInputLabels, setAccessibilityValue, setAccessibilityViewIsModal, setIsAccessibilityElement, setNilValueForKey, setObservationInfo, setShouldGroupAccessibilityChildren, setValueForKey, setValueForKeyPath, setValueForUndefinedKey, setValuesForKeysWithDictionary, shouldGroupAccessibilityChildren, superclass, validateValueForKeyError, validateValueForKeyPathError, valueForKey, valueForKeyPath, valueForUndefinedKey, willChangeValueForKey, willChangeValueForKeyWithSetMutationUsingObjects, willChangeValuesAtIndexesForKey

Methods inherited from class org.moe.natj.objc.ObjCObject

equals, toString

Methods inherited from class org.moe.natj.general.NativeObject

finalize, getPeer, getPeerPointer

Methods inherited from class java.lang.Object

clone, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CNContact

protected CNContact(org.moe.natj.general.Pointer peer)

Method Detail

accessInstanceVariablesDirectly

public static boolean accessInstanceVariablesDirectly()

alloc

public static CNContact alloc()

allocWithZone

public static CNContact allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)

automaticallyNotifiesObserversForKey

public static boolean automaticallyNotifiesObserversForKey(java.lang.String key)

cancelPreviousPerformRequestsWithTarget

public static void cancelPreviousPerformRequestsWithTarget(java.lang.Object aTarget)

cancelPreviousPerformRequestsWithTargetSelectorObject

public static void cancelPreviousPerformRequestsWithTargetSelectorObject(java.lang.Object aTarget,
                                                                         org.moe.natj.objc.SEL aSelector,
                                                                         java.lang.Object anArgument)

classFallbacksForKeyedArchiver

public static NSArray<java.lang.String> classFallbacksForKeyedArchiver()

classForKeyedUnarchiver

public static org.moe.natj.objc.Class classForKeyedUnarchiver()

comparatorForNameSortOrder

public static CNContact.Block_comparatorForNameSortOrder_ret comparatorForNameSortOrder(long sortOrder)

The contact comparator for a given sort order.

debugDescription_static

public static java.lang.String debugDescription_static()

description_static

public static java.lang.String description_static()

descriptorForAllComparatorKeys

public static CNKeyDescriptor descriptorForAllComparatorKeys()

Use to fetch all contact keys required for the contact sort comparator.

hash_static

public static long hash_static()

instanceMethodForSelector

public static NSObject.Function_instanceMethodForSelector_ret instanceMethodForSelector(org.moe.natj.objc.SEL aSelector)

instanceMethodSignatureForSelector

public static NSMethodSignature instanceMethodSignatureForSelector(org.moe.natj.objc.SEL aSelector)

instancesRespondToSelector

public static boolean instancesRespondToSelector(org.moe.natj.objc.SEL aSelector)

isSubclassOfClass

public static boolean isSubclassOfClass(org.moe.natj.objc.Class aClass)

keyPathsForValuesAffectingValueForKey

public static NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey(java.lang.String key)

localizedStringForKey

public static java.lang.String localizedStringForKey(java.lang.String key)

Returns a user displayable property name.

new_objc

public static CNContact new_objc()

predicateForContactsInContainerWithIdentifier

public static NSPredicate predicateForContactsInContainerWithIdentifier(java.lang.String containerIdentifier)

predicateForContactsInGroupWithIdentifier

public static NSPredicate predicateForContactsInGroupWithIdentifier(java.lang.String groupIdentifier)

predicateForContactsMatchingName

public static NSPredicate predicateForContactsMatchingName(java.lang.String name)

To fetch contacts matching a name.

The name can contain any number of words.

predicateForContactsWithIdentifiers

public static NSPredicate predicateForContactsWithIdentifiers(NSArray<java.lang.String> identifiers)

To fetch contacts matching contact identifiers.

resolveClassMethod

public static boolean resolveClassMethod(org.moe.natj.objc.SEL sel)

resolveInstanceMethod

public static boolean resolveInstanceMethod(org.moe.natj.objc.SEL sel)

setVersion_static

public static void setVersion_static(long aVersion)

superclass_static

public static org.moe.natj.objc.Class superclass_static()

supportsSecureCoding

public static boolean supportsSecureCoding()

version_static

public static long version_static()

areKeysAvailable

public boolean areKeysAvailable(NSArray<?> keyDescriptors)

Returns YES if the values for the keys specified by all the descriptors were fetched.

birthday

public NSDateComponents birthday()

The Gregorian birthday.

contactRelations

public NSArray<? extends CNLabeledValue<CNContactRelation>> contactRelations()

contactType

public long contactType()

copyWithZone

public java.lang.Object copyWithZone(org.moe.natj.general.ptr.VoidPtr zone)

Specified by:

copyWithZone in interface NSCopying

dates

public NSArray<? extends CNLabeledValue<NSDateComponents>> dates()

Other Gregorian dates (anniversaries, etc).

departmentName

public java.lang.String departmentName()

emailAddresses

public NSArray<? extends CNLabeledValue<java.lang.String>> emailAddresses()

encodeWithCoder

public void encodeWithCoder(NSCoder coder)

Specified by:

encodeWithCoder in interface NSCoding

familyName

public java.lang.String familyName()

givenName

public java.lang.String givenName()

identifier

public java.lang.String identifier()

The identifier is unique among contacts on the device. It can be saved and used for fetching contacts next application launch.

imageData

public NSData imageData()

imageDataAvailable

public boolean imageDataAvailable()

init

public CNContact init()

Overrides:

init in class NSObject

initWithCoder

public CNContact initWithCoder(NSCoder coder)

Description copied from interface: NSCoding

NS_DESIGNATED_INITIALIZER

Specified by:

initWithCoder in interface NSCoding

instantMessageAddresses

public NSArray<? extends CNLabeledValue<CNInstantMessageAddress>> instantMessageAddresses()

isKeyAvailable

public boolean isKeyAvailable(java.lang.String key)

Returns YES if the value for the specified key was fetched.

isUnifiedWithContactWithIdentifier

public boolean isUnifiedWithContactWithIdentifier(java.lang.String contactIdentifier)

Unification Returns YES if the receiver was fetched as a unified contact and includes the contact having contactIdentifier in its unification

jobTitle

public java.lang.String jobTitle()

middleName

public java.lang.String middleName()

mutableCopyWithZone

public java.lang.Object mutableCopyWithZone(org.moe.natj.general.ptr.VoidPtr zone)

Specified by:

mutableCopyWithZone in interface NSMutableCopying

namePrefix

public java.lang.String namePrefix()

nameSuffix

public java.lang.String nameSuffix()

nickname

public java.lang.String nickname()

nonGregorianBirthday

public NSDateComponents nonGregorianBirthday()

The alternate birthday (Lunisolar).

note

public java.lang.String note()

organizationName

public java.lang.String organizationName()

phoneNumbers

public NSArray<? extends CNLabeledValue<CNPhoneNumber>> phoneNumbers()

phoneticFamilyName

public java.lang.String phoneticFamilyName()

phoneticGivenName

public java.lang.String phoneticGivenName()

phoneticMiddleName

public java.lang.String phoneticMiddleName()

phoneticOrganizationName

public java.lang.String phoneticOrganizationName()

postalAddresses

public NSArray<? extends CNLabeledValue<CNPostalAddress>> postalAddresses()

previousFamilyName

public java.lang.String previousFamilyName()

socialProfiles

public NSArray<? extends CNLabeledValue<CNSocialProfile>> socialProfiles()

_supportsSecureCoding

public boolean _supportsSecureCoding()

Description copied from interface: NSSecureCoding

This property must return YES on all classes that allow secure coding. Subclasses of classes that adopt NSSecureCoding and override initWithCoder: must also override this method and return YES. The Secure Coding Guide should be consulted when writing methods that decode data.

Specified by:

_supportsSecureCoding in interface NSSecureCoding

thumbnailImageData

public NSData thumbnailImageData()

urlAddresses

public NSArray<? extends CNLabeledValue<java.lang.String>> urlAddresses()

itemProviderVisibilityForRepresentationWithTypeIdentifier_static

public static long itemProviderVisibilityForRepresentationWithTypeIdentifier_static(java.lang.String typeIdentifier)

_itemProviderVisibilityForRepresentationWithTypeIdentifier_static

public long _itemProviderVisibilityForRepresentationWithTypeIdentifier_static(java.lang.String typeIdentifier)

Specified by:

_itemProviderVisibilityForRepresentationWithTypeIdentifier_static in interface NSItemProviderWriting

itemProviderVisibilityForRepresentationWithTypeIdentifier

public long itemProviderVisibilityForRepresentationWithTypeIdentifier(java.lang.String typeIdentifier)

loadDataWithTypeIdentifierForItemProviderCompletionHandler

public NSProgress loadDataWithTypeIdentifierForItemProviderCompletionHandler(java.lang.String typeIdentifier,
                                                                             NSItemProviderWriting.Block_loadDataWithTypeIdentifierForItemProviderCompletionHandler completionHandler)

Description copied from interface: NSItemProviderWriting

One of writableTypeIdentifiersForItemProvider

Specified by:

loadDataWithTypeIdentifierForItemProviderCompletionHandler in interface NSItemProviderWriting

objectWithItemProviderDataTypeIdentifierError

public static CNContact objectWithItemProviderDataTypeIdentifierError(NSData data,
                                                                      java.lang.String typeIdentifier,
                                                                      org.moe.natj.general.ptr.Ptr<NSError> outError)

_objectWithItemProviderDataTypeIdentifierError

public CNContact _objectWithItemProviderDataTypeIdentifierError(NSData data,
                                                                java.lang.String typeIdentifier,
                                                                org.moe.natj.general.ptr.Ptr<NSError> outError)

Specified by:

_objectWithItemProviderDataTypeIdentifierError in interface NSItemProviderReading

readableTypeIdentifiersForItemProvider

public static NSArray<java.lang.String> readableTypeIdentifiersForItemProvider()

_readableTypeIdentifiersForItemProvider

public NSArray<java.lang.String> _readableTypeIdentifiersForItemProvider()

Specified by:

_readableTypeIdentifiersForItemProvider in interface NSItemProviderReading

writableTypeIdentifiersForItemProvider_static

public static NSArray<java.lang.String> writableTypeIdentifiersForItemProvider_static()

_writableTypeIdentifiersForItemProvider_static

public NSArray<java.lang.String> _writableTypeIdentifiersForItemProvider_static()

Specified by:

_writableTypeIdentifiersForItemProvider_static in interface NSItemProviderWriting

writableTypeIdentifiersForItemProvider

public NSArray<java.lang.String> writableTypeIdentifiersForItemProvider()

predicateForContactsMatchingEmailAddress

public static NSPredicate predicateForContactsMatchingEmailAddress(java.lang.String emailAddress)

Fetch contacts matching an email address.

Use this predicate to find the contact(s) which contain the specified email address. The search is not case-sensitive.

Parameters:

emailAddress - The email address to search for. Do not include a scheme (e.g., "mailto:").

predicateForContactsMatchingPhoneNumber

public static NSPredicate predicateForContactsMatchingPhoneNumber(CNPhoneNumber phoneNumber)

Fetch contacts matching a phone number.

If the predicate and contact differ in their use or presence of country codes, a best effort will be made to match results; however, inexact matches are not guaranteed.

Parameters:

phoneNumber - A @c CNPhoneNumber representing the phone number to search for. Do not include a scheme (e.g., "tel:").