native.* — Address Book

Type CoronaProvider
Revision 2016.3002
Keywords native, showPopup, address, contacts
Platforms iOS

Overview

The Address Book plugin enables you to access a user's address book and contacts via the native.showPopup() API.

Gotchas

You must include the following keys/descriptions in the plist table of build.settings. When the system prompts the user to allow access, the associated description is displayed as part of the alert. Note that these descriptions can be customized to your preference and they can even be localized (guide).

settings =
{
    iphone =
    {
        plist =
        {
            NSContactsUsageDescription = "This app would like to access your contacts.",
        },
    },
}

Functions

Project Settings

To use this plugin, add an entry into the plugins table of build.settings. When added, the build server will integrate the plugin during the build phase.

settings =
{
    plugins =
    {
        ["CoronaProvider.native.popup.addressbook"] =
        {
            publisherId = "com.coronalabs",
            supportedPlatforms = { iphone=true }
        },
    },
}

Support