Skip to content

Repository files navigation

AddressBookKit

VersionLicensePlatformLanguage

Requirements

iOS 8.0 or above

Installation

AddressBookKit is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod"AddressBookKit"

or

Copy AddressBookKit.swift and AddressBookDataType.swift into your project.

Usage

Ask for Contacts permission

AddressBookKit.requestPermission{[weak self](success)->Voidinif success {
// Success, read address book here...
// Example:
letphoneNumbers=AddressBookKit.plainContacts(.PhoneNumber)}else{
// No Permission
}}

AddressBookKit.plainContacts() will returns an array of PlainContact. Example:

letphoneNumbers=AddressBookKit.plainContacts(.PhoneNumber)letemails=AddressBookKit.plainContacts(.Email)

AddressBookKit.groupedContacts() will returns an array of GroupedContact. Example:

letphoneNumbers=AddressBookKit.groupedContacts([.PhoneNumber])letemails=AddressBookKit.groupedContacts([.Email])letphonesAndEmails=AddressBookKit.groupedContacts([.PhoneNumber,.Email])

What is PlainContact?

VaribleTypeDescription
firstNameString?First Name
middleNameString?Middle Name
lastNameString?Last Name
fullNameStringFull Name
valueStringA String representing phone number or email

What is GroupedContact?

VaribleTypeDescription
firstNameString?First Name
middleNameString?Middle Name
lastNameString?Last Name
fullNameStringFull Name
phoneNumbers[String]An array of phone numbers in this contact
emails[String]An array of Emails in this contact

Author

Kenneth Tsang, kenneth.tsang@me.com

License

AddressBookKit is available under the MIT license. See the LICENSE file for more info.

About

The most simple way to get device's phone book in Swift.

Resources

Stars

6 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages