Directory

Kotlin |Java

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:

The URI authority is replaced with the corresponding DIRECTORY_AUTHORITY.
The accountName= and accountType= parameters are added or replaced using the corresponding ACCOUNT_TYPE and ACCOUNT_NAME values.

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	`ACCOUNT_NAME` The account with which this directory is associated.
static String	`ACCOUNT_TYPE` The account type which this directory is associated.
static String	`CALLER_PACKAGE_PARAM_KEY` A query parameter that's passed to directory providers which indicates the client package name that has made the query requests.
static String	`CONTENT_ITEM_TYPE` The MIME type of a `CONTENT_URI` item.
static String	`CONTENT_TYPE` The MIME-type of `CONTENT_URI` providing a directory of contact directories.
static Long	`DEFAULT` _ID of the default directory, which represents locally stored contacts.
static String	`DIRECTORY_AUTHORITY` The authority of the Directory Provider.
static String	`DISPLAY_NAME` An optional name that can be used in the UI to represent this directory, e.
static Long	`ENTERPRISE_DEFAULT` _ID of the managed profile default directory, which represents locally stored contacts.
static Long	`ENTERPRISE_LOCAL_INVISIBLE` _ID of the managed profile directory that represents locally stored invisible contacts.
static String	`EXPORT_SUPPORT` One of `EXPORT_SUPPORT_NONE`, `EXPORT_SUPPORT_ANY_ACCOUNT`, `EXPORT_SUPPORT_SAME_ACCOUNT_ONLY`.
static Int	`EXPORT_SUPPORT_ANY_ACCOUNT` An `EXPORT_SUPPORT` setting that indicates that the directory allow its data copied to any contacts account.
static Int	`EXPORT_SUPPORT_NONE` An `EXPORT_SUPPORT` setting that indicates that the directory does not allow any data to be copied out of it.
static Int	`EXPORT_SUPPORT_SAME_ACCOUNT_ONLY` 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	`LOCAL_INVISIBLE` _ID of the directory that represents locally stored invisible contacts.
static String	`PACKAGE_NAME` The name of the package that owns this directory.
static String	`PHOTO_SUPPORT` One of `PHOTO_SUPPORT_NONE`, `PHOTO_SUPPORT_THUMBNAIL_ONLY`, `PHOTO_SUPPORT_FULL`.
static Int	`PHOTO_SUPPORT_FULL` An `PHOTO_SUPPORT` setting that indicates that the directory can produce thumbnails as well as full-size contact photos.
static Int	`PHOTO_SUPPORT_FULL_SIZE_ONLY` An `PHOTO_SUPPORT` setting that indicates that the directory has full-size contact photos, but cannot provide scaled thumbnails.
static Int	`PHOTO_SUPPORT_NONE` An `PHOTO_SUPPORT` setting that indicates that the directory does not provide any photos.
static Int	`PHOTO_SUPPORT_THUMBNAIL_ONLY` An `PHOTO_SUPPORT` setting that indicates that the directory can only produce small size thumbnails of contact photos.
static String	`SHORTCUT_SUPPORT` One of `SHORTCUT_SUPPORT_NONE`, `SHORTCUT_SUPPORT_DATA_ITEMS_ONLY`, `SHORTCUT_SUPPORT_FULL`.
static Int	`SHORTCUT_SUPPORT_DATA_ITEMS_ONLY` 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	`SHORTCUT_SUPPORT_FULL` An `SHORTCUT_SUPPORT` setting that indicates that the directory allow creation of shortcuts for contact as well as their constituent elements.
static Int	`SHORTCUT_SUPPORT_NONE` An `SHORTCUT_SUPPORT` setting that indicates that the directory does not allow any shortcuts created for its contacts.
static String	`TYPE_RESOURCE_ID` The type of directory captured as a resource ID in the context of the package `PACKAGE_NAME`, e.

Inherited constants

From class BaseColumns

String

_COUNT

The count of rows in a directory.

Type: INTEGER

String

_ID

The unique ID for a row.

Type: INTEGER (long)

Public methods
static Boolean	`isEnterpriseDirectoryId(directoryId: Long)` 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	`notifyDirectoryChange(resolver: ContentResolver!)` Notifies the system of a change in the list of directories handled by a particular directory provider.

Properties
static Uri!	`CONTENT_URI` The content:// style URI for this table.
static Uri!	`ENTERPRISE_CONTENT_URI` URI used for getting all directories from both the calling user and the managed profile that is linked to it.

Directory

Summary

Constants

ACCOUNT_NAME

ACCOUNT_TYPE

CALLER_PACKAGE_PARAM_KEY

CONTENT_ITEM_TYPE

CONTENT_TYPE

DEFAULT

DIRECTORY_AUTHORITY

DISPLAY_NAME

ENTERPRISE_DEFAULT

ENTERPRISE_LOCAL_INVISIBLE

EXPORT_SUPPORT

EXPORT_SUPPORT_ANY_ACCOUNT

EXPORT_SUPPORT_NONE

EXPORT_SUPPORT_SAME_ACCOUNT_ONLY

LOCAL_INVISIBLE

PACKAGE_NAME

PHOTO_SUPPORT

PHOTO_SUPPORT_FULL

PHOTO_SUPPORT_FULL_SIZE_ONLY

PHOTO_SUPPORT_NONE

PHOTO_SUPPORT_THUMBNAIL_ONLY

SHORTCUT_SUPPORT

SHORTCUT_SUPPORT_DATA_ITEMS_ONLY

SHORTCUT_SUPPORT_FULL

SHORTCUT_SUPPORT_NONE

TYPE_RESOURCE_ID

Public methods

isEnterpriseDirectoryId

isRemoteDirectoryId

notifyDirectoryChange

Properties

CONTENT_URI

ENTERPRISE_CONTENT_URI