Added in API level 11

Directory

class Directory : BaseColumns
kotlin.Any
   ↳ android.provider.ContactsContract.Directory

A Directory represents a contacts corpus, e.g. Local contacts, Google Apps Global Address List or Corporate Global Address List.

A Directory is implemented as a content provider with its unique authority and the same API as the main Contacts Provider. However, there is no expectation that every directory provider will implement this Contract in its entirety. If a directory provider does not have an implementation for a specific request, it should throw an UnsupportedOperationException.

The most important use case for Directories is search. A Directory provider is expected to support at least Contacts.CONTENT_FILTER_URI. If a Directory provider wants to participate in email and phone lookup functionalities, it should also implement CommonDataKinds.Email.CONTENT_FILTER_URI and CommonDataKinds.Phone.CONTENT_FILTER_URI.

A directory provider should return NULL for every projection field it does not recognize, rather than throwing an exception. This way it will not be broken if ContactsContract is extended with new fields in the future.

The client interacts with a directory via Contacts Provider by supplying an optional directory= query parameter.

When the Contacts Provider receives the request, it transforms the URI and forwards the request to the corresponding directory content provider. The URI is transformed in the following fashion:

Clients should send directory requests to Contacts Provider and let it forward them to the respective providers rather than constructing directory provider URIs by themselves. This level of indirection allows Contacts Provider to implement additional system-level features and optimizations. Access to Contacts Provider is protected by the READ_CONTACTS permission, but access to the directory provider is protected by BIND_DIRECTORY_SEARCH. This permission was introduced at the API level 17, for previous platform versions the provider should perform the following check to make sure the call is coming from the ContactsProvider:

private boolean isCallerAllowed() {
    PackageManager pm = getContext().getPackageManager();
    for (String packageName: pm.getPackagesForUid(Binder.getCallingUid())) {
      if (packageName.equals("com.android.providers.contacts")) {
        return true;
      }
    }
    return false;
  }
  

The Directory table is read-only and is maintained by the Contacts Provider automatically.

It always has at least these two rows:

  • The local directory. It has Directory._ID = Directory.DEFAULT. This directory can be used to access locally stored contacts. The same can be achieved by omitting the directory= parameter altogether.
  • The local invisible contacts. The corresponding directory ID is Directory.LOCAL_INVISIBLE.

Custom Directories are discovered by the Contacts Provider following this procedure:

  • It finds all installed content providers with meta data identifying them as directory providers in AndroidManifest.xml: <meta-data android:name="android.content.ContactDirectory" android:value="true" />

    This tag should be placed inside the corresponding content provider declaration.

  • Then Contacts Provider sends a Directory.CONTENT_URI query to each of the directory authorities. A directory provider must implement this query and return a list of directories. Each directory returned by the provider must have a unique combination for the ACCOUNT_NAME and ACCOUNT_TYPE columns (nulls are allowed). Since directory IDs are assigned automatically, the _ID field will not be part of the query projection.
  • Contacts Provider compiles directory lists received from all directory providers into one, assigns each individual directory a globally unique ID and stores all directory records in the Directory table.

Contacts Provider automatically interrogates newly installed or replaced packages. Thus simply installing a package containing a directory provider is sufficient to have that provider registered. A package supplying a directory provider does not have to contain launchable activities.

Every row in the Directory table is automatically associated with the corresponding package (apk). If the package is later uninstalled, all corresponding directory rows are automatically removed from the Contacts Provider.

When the list of directories handled by a directory provider changes (for instance when the user adds a new Directory account), the directory provider should call notifyDirectoryChange to notify the Contacts Provider of the change. In response, the Contacts Provider will requery the directory provider to obtain the new list of directories.

A directory row can be optionally associated with an existing account (see android.accounts.AccountManager). If the account is later removed, the corresponding directory rows are automatically removed from the Contacts Provider.

Summary

Constants
static String

The account with which this directory is associated.

static String

The account type which this directory is associated.

static String

A query parameter that's passed to directory providers which indicates the client package name that has made the query requests.

static String

The MIME type of a CONTENT_URI item.

static String

The MIME-type of CONTENT_URI providing a directory of contact directories.

static Long

_ID of the default directory, which represents locally stored contacts.

static String

The authority of the Directory Provider.

static String

An optional name that can be used in the UI to represent this directory, e.

static Long

_ID of the managed profile default directory, which represents locally stored contacts.

static Long

_ID of the managed profile directory that represents locally stored invisible contacts.

static String

One of EXPORT_SUPPORT_NONE, EXPORT_SUPPORT_ANY_ACCOUNT, EXPORT_SUPPORT_SAME_ACCOUNT_ONLY.

static Int

An EXPORT_SUPPORT setting that indicates that the directory allow its data copied to any contacts account.

static Int

An EXPORT_SUPPORT setting that indicates that the directory does not allow any data to be copied out of it.

static Int

An EXPORT_SUPPORT setting that indicates that the directory allow its data copied only to the account specified by ACCOUNT_TYPE/ACCOUNT_NAME.

static Long

_ID of the directory that represents locally stored invisible contacts.

static String

The name of the package that owns this directory.

static String

One of PHOTO_SUPPORT_NONE, PHOTO_SUPPORT_THUMBNAIL_ONLY, PHOTO_SUPPORT_FULL.

static Int

An PHOTO_SUPPORT setting that indicates that the directory can produce thumbnails as well as full-size contact photos.

static Int

An PHOTO_SUPPORT setting that indicates that the directory has full-size contact photos, but cannot provide scaled thumbnails.

static Int

An PHOTO_SUPPORT setting that indicates that the directory does not provide any photos.

static Int

An PHOTO_SUPPORT setting that indicates that the directory can only produce small size thumbnails of contact photos.

static String

One of SHORTCUT_SUPPORT_NONE, SHORTCUT_SUPPORT_DATA_ITEMS_ONLY, SHORTCUT_SUPPORT_FULL.

static Int

An SHORTCUT_SUPPORT setting that indicates that the directory allow creation of shortcuts for data items like email, phone or postal address, but not the entire contact.

static Int

An SHORTCUT_SUPPORT setting that indicates that the directory allow creation of shortcuts for contact as well as their constituent elements.

static Int

An SHORTCUT_SUPPORT setting that indicates that the directory does not allow any shortcuts created for its contacts.

static String

The type of directory captured as a resource ID in the context of the package PACKAGE_NAME, e.

Inherited constants
Public methods
static Boolean

Return TRUE if a directory ID is from the contacts provider on the enterprise profile.

static Boolean
isRemoteDirectoryId(directoryId: Long)

Return TRUE if it is a remote stored directory.

static Unit

Notifies the system of a change in the list of directories handled by a particular directory provider.

Properties
static Uri!

The content:// style URI for this table.

static Uri!

URI used for getting all directories from both the calling user and the managed profile that is linked to it.

Constants

ACCOUNT_NAME

Added in API level 11
static val ACCOUNT_NAME: String

The account with which this directory is associated. If the account is later removed, the directories it owns are automatically removed from this table.

TYPE: text

Value: "accountName"

ACCOUNT_TYPE

Added in API level 11
static val ACCOUNT_TYPE: String

The account type which this directory is associated.

TYPE: text

Value: "accountType"

CALLER_PACKAGE_PARAM_KEY

Added in API level 26
static val CALLER_PACKAGE_PARAM_KEY: String

A query parameter that's passed to directory providers which indicates the client package name that has made the query requests.

Value: "callerPackage"

CONTENT_ITEM_TYPE

Added in API level 11
static val CONTENT_ITEM_TYPE: String

The MIME type of a CONTENT_URI item.

Value: "vnd.android.cursor.item/contact_directory"

CONTENT_TYPE

Added in API level 11
static val CONTENT_TYPE: String

The MIME-type of CONTENT_URI providing a directory of contact directories.

Value: "vnd.android.cursor.dir/contact_directories"

DEFAULT

Added in API level 11
static val DEFAULT: Long

_ID of the default directory, which represents locally stored contacts. This is only supported by ContactsContract.Contacts#CONTENT_URI and ContactsContract.Contacts#CONTENT_FILTER_URI. Other URLs do not support the concept of "visible" or "invisible" contacts.

Value: 0L

DIRECTORY_AUTHORITY

Added in API level 11
static val DIRECTORY_AUTHORITY: String

The authority of the Directory Provider. Contacts Provider will use this authority to forward requests to the directory provider. A directory provider can leave this column empty - Contacts Provider will fill it in.

Clients of this API should not send requests directly to this authority. All directory requests must be routed through Contacts Provider.

TYPE: text

Value: "authority"

DISPLAY_NAME

Added in API level 11
static val DISPLAY_NAME: String

An optional name that can be used in the UI to represent this directory, e.g. "Acme Corp"

TYPE: text

Value: "displayName"

ENTERPRISE_DEFAULT

Added in API level 24
static val ENTERPRISE_DEFAULT: Long

_ID of the managed profile default directory, which represents locally stored contacts.

Value: 1000000000L

ENTERPRISE_LOCAL_INVISIBLE

Added in API level 24
static val ENTERPRISE_LOCAL_INVISIBLE: Long

_ID of the managed profile directory that represents locally stored invisible contacts.

Value: 1000000001L

EXPORT_SUPPORT

Added in API level 11
static val EXPORT_SUPPORT: String

One of EXPORT_SUPPORT_NONE, EXPORT_SUPPORT_ANY_ACCOUNT, EXPORT_SUPPORT_SAME_ACCOUNT_ONLY. This is the expectation the directory has for data exported from it. Clients must obey this setting.

Value: "exportSupport"

EXPORT_SUPPORT_ANY_ACCOUNT

Added in API level 11
static val EXPORT_SUPPORT_ANY_ACCOUNT: Int

An EXPORT_SUPPORT setting that indicates that the directory allow its data copied to any contacts account.

Value: 2

EXPORT_SUPPORT_NONE

Added in API level 11
static val EXPORT_SUPPORT_NONE: Int

An EXPORT_SUPPORT setting that indicates that the directory does not allow any data to be copied out of it.

Value: 0

EXPORT_SUPPORT_SAME_ACCOUNT_ONLY

Added in API level 11
static val EXPORT_SUPPORT_SAME_ACCOUNT_ONLY: Int

An EXPORT_SUPPORT setting that indicates that the directory allow its data copied only to the account specified by ACCOUNT_TYPE/ACCOUNT_NAME.

Value: 1

LOCAL_INVISIBLE

Added in API level 11
static val LOCAL_INVISIBLE: Long

_ID of the directory that represents locally stored invisible contacts.

Value: 1L

PACKAGE_NAME

Added in API level 11
static val PACKAGE_NAME: String

The name of the package that owns this directory. Contacts Provider fill it in with the name of the package containing the directory provider. If the package is later uninstalled, the directories it owns are automatically removed from this table.

TYPE: TEXT

Value: "packageName"

PHOTO_SUPPORT

Added in API level 11
static val PHOTO_SUPPORT: String

One of PHOTO_SUPPORT_NONE, PHOTO_SUPPORT_THUMBNAIL_ONLY, PHOTO_SUPPORT_FULL. This is a feature flag indicating the extent to which the directory supports contact photos.

Value: "photoSupport"

PHOTO_SUPPORT_FULL

Added in API level 11
static val PHOTO_SUPPORT_FULL: Int

An PHOTO_SUPPORT setting that indicates that the directory can produce thumbnails as well as full-size contact photos.

Value: 3

PHOTO_SUPPORT_FULL_SIZE_ONLY

Added in API level 11
static val PHOTO_SUPPORT_FULL_SIZE_ONLY: Int

An PHOTO_SUPPORT setting that indicates that the directory has full-size contact photos, but cannot provide scaled thumbnails.

Value: 2

PHOTO_SUPPORT_NONE

Added in API level 11
static val PHOTO_SUPPORT_NONE: Int

An PHOTO_SUPPORT setting that indicates that the directory does not provide any photos.

Value: 0

PHOTO_SUPPORT_THUMBNAIL_ONLY

Added in API level 11
static val PHOTO_SUPPORT_THUMBNAIL_ONLY: Int

An PHOTO_SUPPORT setting that indicates that the directory can only produce small size thumbnails of contact photos.

Value: 1

SHORTCUT_SUPPORT

Added in API level 11
static val SHORTCUT_SUPPORT: String

One of SHORTCUT_SUPPORT_NONE, SHORTCUT_SUPPORT_DATA_ITEMS_ONLY, SHORTCUT_SUPPORT_FULL. This is the expectation the directory has for shortcuts created for its elements. Clients must obey this setting.

Value: "shortcutSupport"

SHORTCUT_SUPPORT_DATA_ITEMS_ONLY

Added in API level 11
static val SHORTCUT_SUPPORT_DATA_ITEMS_ONLY: Int

An SHORTCUT_SUPPORT setting that indicates that the directory allow creation of shortcuts for data items like email, phone or postal address, but not the entire contact.

Value: 1

SHORTCUT_SUPPORT_FULL

Added in API level 11
static val SHORTCUT_SUPPORT_FULL: Int

An SHORTCUT_SUPPORT setting that indicates that the directory allow creation of shortcuts for contact as well as their constituent elements.

Value: 2

SHORTCUT_SUPPORT_NONE

Added in API level 11
static val SHORTCUT_SUPPORT_NONE: Int

An SHORTCUT_SUPPORT setting that indicates that the directory does not allow any shortcuts created for its contacts.

Value: 0

TYPE_RESOURCE_ID

Added in API level 11
static val TYPE_RESOURCE_ID: String

The type of directory captured as a resource ID in the context of the package PACKAGE_NAME, e.g. "Corporate Directory"

TYPE: INTEGER

Value: "typeResourceId"

Public methods

isEnterpriseDirectoryId

Added in API level 24
static fun isEnterpriseDirectoryId(directoryId: Long): Boolean

Return TRUE if a directory ID is from the contacts provider on the enterprise profile.

isRemoteDirectoryId

Added in API level 24
static fun isRemoteDirectoryId(directoryId: Long): Boolean

Return TRUE if it is a remote stored directory.

notifyDirectoryChange

Added in API level 11
static fun notifyDirectoryChange(resolver: ContentResolver!): Unit

Notifies the system of a change in the list of directories handled by a particular directory provider. The Contacts provider will turn around and send a query to the directory provider for the full list of directories, which will replace the previous list.

Properties

CONTENT_URI

Added in API level 11
static val CONTENT_URI: Uri!

The content:// style URI for this table. Requests to this URI can be performed on the UI thread because they are always unblocking.

ENTERPRISE_CONTENT_URI

Added in API level 24
static val ENTERPRISE_CONTENT_URI: Uri!

URI used for getting all directories from both the calling user and the managed profile that is linked to it.

It supports the same semantics as CONTENT_URI and returns the same columns.
If the device has no managed profile that is linked to the calling user, it behaves in the exact same way as CONTENT_URI.
If there is a managed profile linked to the calling user, it will return merged results from both.

Note: this query returns the calling user results before the managed profile results, and this order is not affected by the sorting parameter.