IT. Expert System.

Android Reference

ContactsContract.Directory


android.provider

Class ContactsContract.Directory

  • All Implemented Interfaces:
    BaseColumns
    Enclosing class:
    ContactsContract


    public static final class ContactsContract.Directory
    extends Object
    implements BaseColumns
    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(android.content.ContentResolver) 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 AccountManager). If the account is later removed, the corresponding directory rows are automatically removed from the Contacts Provider.

    • Field Detail

      • CONTENT_URI

        public static final Uri CONTENT_URI
        The content:// style URI for this table. Requests to this URI can be performed on the UI thread because they are always unblocking.
      • DEFAULT

        public static final long DEFAULT
        _ID of the default directory, which represents locally stored contacts.
        See Also:
        Constant Field Values
      • LOCAL_INVISIBLE

        public static final long LOCAL_INVISIBLE
        _ID of the directory that represents locally stored invisible contacts.
        See Also:
        Constant Field Values
      • PACKAGE_NAME

        public static final String PACKAGE_NAME
        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

        See Also:
        Constant Field Values
      • TYPE_RESOURCE_ID

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

        TYPE: INTEGER

        See Also:
        Constant Field Values
      • DISPLAY_NAME

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

        TYPE: text

        See Also:
        Constant Field Values
      • DIRECTORY_AUTHORITY

        public static final String DIRECTORY_AUTHORITY

        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

        See Also:
        Constant Field Values
      • ACCOUNT_TYPE

        public static final String ACCOUNT_TYPE
        The account type which this directory is associated.

        TYPE: text

        See Also:
        Constant Field Values
      • ACCOUNT_NAME

        public static final String ACCOUNT_NAME
        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

        See Also:
        Constant Field Values
      • EXPORT_SUPPORT_NONE

        public static final int EXPORT_SUPPORT_NONE
        An EXPORT_SUPPORT setting that indicates that the directory does not allow any data to be copied out of it.
        See Also:
        Constant Field Values
      • EXPORT_SUPPORT_ANY_ACCOUNT

        public static final int EXPORT_SUPPORT_ANY_ACCOUNT
        An EXPORT_SUPPORT setting that indicates that the directory allow its data copied to any contacts account.
        See Also:
        Constant Field Values
      • SHORTCUT_SUPPORT_NONE

        public static final int SHORTCUT_SUPPORT_NONE
        An SHORTCUT_SUPPORT setting that indicates that the directory does not allow any shortcuts created for its contacts.
        See Also:
        Constant Field Values
      • SHORTCUT_SUPPORT_DATA_ITEMS_ONLY

        public static final 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.
        See Also:
        Constant Field Values
      • SHORTCUT_SUPPORT_FULL

        public static final 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.
        See Also:
        Constant Field Values
      • PHOTO_SUPPORT_NONE

        public static final int PHOTO_SUPPORT_NONE
        An PHOTO_SUPPORT setting that indicates that the directory does not provide any photos.
        See Also:
        Constant Field Values
      • PHOTO_SUPPORT_THUMBNAIL_ONLY

        public static final int PHOTO_SUPPORT_THUMBNAIL_ONLY
        An PHOTO_SUPPORT setting that indicates that the directory can only produce small size thumbnails of contact photos.
        See Also:
        Constant Field Values
      • PHOTO_SUPPORT_FULL_SIZE_ONLY

        public static final 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.
        See Also:
        Constant Field Values
      • PHOTO_SUPPORT_FULL

        public static final int PHOTO_SUPPORT_FULL
        An PHOTO_SUPPORT setting that indicates that the directory can produce thumbnails as well as full-size contact photos.
        See Also:
        Constant Field Values
    • Method Detail

      • notifyDirectoryChange

        public static void notifyDirectoryChange(ContentResolver resolver)
        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.


Content

Android Reference

Java basics

Java Enterprise Edition (EE)

Java Standard Edition (SE)

SQL

HTML

PHP

CSS

Java Script

MYSQL

JQUERY

VBS

REGEX

C

C++

C#

Design patterns

RFC (standard status)

RFC (proposed standard status)

RFC (draft standard status)

RFC (informational status)

RFC (experimental status)

RFC (best current practice status)

RFC (historic status)

RFC (unknown status)

IT dictionary

License.
All information of this service is derived from the free sources and is provided solely in the form of quotations. This service provides information and interfaces solely for the familiarization (not ownership) and under the "as is" condition.
Copyright 2016 © ELTASK.COM. All rights reserved.
Site is optimized for mobile devices.
Downloads: 666 / . Delta: 0.02593 с