ContactPickerKMP/com.devtamuno.kmp.contactpicker.contract/ContactPicker

ContactPicker

internal actual class ContactPicker(source)

Android-specific implementation of the ContactPicker contract.

This implementation utilizes the Android ContactsContract provider and the Activity Result API (ActivityResultContracts.PickContact) to enable secure and seamless contact selection.

It manages the lifecycle of the activity launcher and performs background queries to the ContentResolver to aggregate contact details like names, multiple phone numbers, emails, and avatars.

internal expect class ContactPicker(source)

An expected class that defines the contract for a platform-specific contact picker.

This class facilitates the selection of contacts from the device's native address book. Implementations are provided for different platforms (e.g., Android and iOS) to handle the specific APIs and UI flows required by each.

internal actual class ContactPicker : NSObject, CNContactPickerDelegateProtocol(source)

iOS-specific implementation of the ContactPicker contract.

This implementation leverages the native CNContactPickerViewController from the ContactsUI framework to provide a familiar and secure contact selection experience for iOS users.

It acts as both the launcher and the delegate (CNContactPickerDelegateProtocol) to handle lifecycle events and data extraction from the native CNContact objects.

Constructors

constructor()

expect constructor()

constructor()

Properties

private val contactPicker: CNContactPickerViewController

debugDescription

expect val debugDescription: String?

expect val description: String?

expect val hash: NSUInteger

onContactSelected

private lateinit var onContactSelected: (Contact?) -> Unit

private lateinit var picker: ManagedActivityResultLauncher<Void?, Uri?>

private val projection: Array<String>

Columns queried from the ContactsContract.Contacts table.

expect val superclass: ObjCClass?

Functions

expect open override fun class(): ObjCClass?

conformsToProtocol

expect open override fun conformsToProtocol(aProtocol: objcnames/classes/Protocol??): Boolean

open override fun contactPicker(picker: CNContactPickerViewController, didSelectContact: CNContact)

Invoked by the system when the user selects a specific contact.

expect open fun contactPicker(picker: CNContactPickerViewController, didSelectContactProperties: List<*>)

expect open fun contactPicker(picker: CNContactPickerViewController, didSelectContacts: List<*>)

expect open fun contactPicker(picker: CNContactPickerViewController, didSelectContactProperty: CNContactProperty)

contactPickerDidCancel

open override fun contactPickerDidCancel(picker: CNContactPickerViewController)

Invoked by the system when the user cancels the contact picker.

expect open fun copy(): Any?

debugDescription

expect open fun debugDescription(): String?

expect open override fun description(): String?

doesNotRecognizeSelector

expect open fun doesNotRecognizeSelector(aSelector: COpaquePointer?)

expect open fun finalize()

findTopMostViewController

private fun findTopMostViewController(rootViewController: UIViewController?): UIViewController?

Recursively traverses the view controller hierarchy to find the visible controller.

forwardingTargetForSelector

expect open fun forwardingTargetForSelector(aSelector: COpaquePointer?): Any?

forwardInvocation

expect open fun forwardInvocation(anInvocation: objcnames/classes/NSInvocation??)

getContactAvatar

private fun getContactAvatar(context: Context, contactId: Long): ByteArray?

Resolves the contact's photo into a ByteArray.

getContactFromUri

private fun getContactFromUri(context: Context, uri: Uri): Contact?

Extracts comprehensive contact data from the provided Uri.

private fun getEmail(context: Context, contactId: String): List<String>

Queries the ContactsContract.CommonDataKinds.Email table for all addresses associated with a contact.

getEmailAddress

private fun getEmailAddress(emailAddresses: List<*>): List<String>

Utility to extract string representations of email addresses from CNLabeledValues.

private fun getPhoneNumber(context: Context, contactId: String): List<String>

Queries the ContactsContract.CommonDataKinds.Phone table for all numbers associated with a contact.

getPhoneNumbers

private fun getPhoneNumbers(contactList: List<*>): List<String>

Utility to extract string representations of phone numbers from CNLabeledValues.

expect open override fun hash(): NSUInteger

expect open fun ~~init~~(): NSObject?

expect open override fun isEqual(object: Any?): Boolean

expect open override fun isKindOfClass(aClass: ObjCClass?): Boolean

isMemberOfClass

expect open override fun isMemberOfClass(aClass: ObjCClass?): Boolean

expect open override fun isProxy(): Boolean

launchContactPicker

actual fun launchContactPicker()

Triggers the Android system contact picker UI.

expect fun launchContactPicker()

Triggers the display of the platform-specific contact picker interface.

actual fun launchContactPicker()

Displays the native iOS contact picker.

methodForSelector

expect open fun methodForSelector(aSelector: COpaquePointer?): IMP?

methodSignatureForSelector

expect open fun methodSignatureForSelector(aSelector: COpaquePointer?): objcnames/classes/NSMethodSignature??

expect open fun mutableCopy(): Any?

performSelector

expect open override fun performSelector(aSelector: COpaquePointer?): Any?

expect open override fun performSelector(aSelector: COpaquePointer?, withObject: Any?): Any?

expect open override fun performSelector(aSelector: COpaquePointer?, withObject: Any?, _withObject: Any?): Any?

RegisterContactPicker

actual fun RegisterContactPicker(onContactSelected: (Contact?) -> Unit)

Registers the ManagedActivityResultLauncher within the Compose composition.

expect fun RegisterContactPicker(onContactSelected: (Contact?) -> Unit)

Registers the contact picker within the Compose composition.

actual fun RegisterContactPicker(onContactSelected: (Contact?) -> Unit)

Registers the callback to be invoked when a contact is selected.

respondsToSelector

expect open override fun respondsToSelector(aSelector: COpaquePointer?): Boolean

expect open override fun superclass(): ObjCClass?

private fun NSData.toByteArray(): ByteArray

Converts native NSData to a Kotlin ByteArray.

topMostViewController

private fun UIViewController.Companion.topMostViewController(): UIViewController?

Companion extension to find the currently active UIViewController in the view hierarchy.