ContactsContract.Directory Class

Reference

Definition

Namespace:: Android.Provider

Assembly:: Mono.Android.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A Directory represents a contacts corpus, e.

[Android.Runtime.Register("android/provider/ContactsContract$Directory", DoNotGenerateAcw=true)]
public sealed class ContactsContract.Directory : Java.Lang.Object

[<Android.Runtime.Register("android/provider/ContactsContract$Directory", DoNotGenerateAcw=true)>]
type ContactsContract.Directory = class
    inherit Object

Inheritance: Object

Object
ContactsContract.Directory

Attributes: RegisterAttribute

Remarks

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 ContactsContract.Contacts#CONTENT_FILTER_URI 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 CommonDataKinds.Email.CONTENT_FILTER_URI and CommonDataKinds.Phone#CONTENT_FILTER_URI 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: <ul> <li>The URI authority is replaced with the corresponding #DIRECTORY_AUTHORITY.</li> <li>The accountName= and accountType= parameters are added or replaced using the corresponding #ACCOUNT_TYPE and #ACCOUNT_NAME values.</li> </ul>

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;
            }

</p>

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

It always has at least these two rows: <ul> <li> The local directory. It has Directory#_ID Directory._ID = Directory#DEFAULT Directory.DEFAULT. This directory can be used to access locally stored contacts. The same can be achieved by omitting the directory= parameter altogether. </li> <li> The local invisible contacts. The corresponding directory ID is Directory#LOCAL_INVISIBLE Directory.LOCAL_INVISIBLE. </li> </ul>

Custom Directories are discovered by the Contacts Provider following this procedure: <ul> <li>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.

</li> <li> Then Contacts Provider sends a Directory#CONTENT_URI 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. </li> <li>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. </li> </ul> </p>

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.

Java documentation for android.provider.ContactsContract.Directory.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Fields

AccountName	The account with which this directory is associated.
AccountType	The account type which this directory is associated.
CallerPackageParamKey	A query parameter that's passed to directory providers which indicates the client package name that has made the query requests.
ContentItemType	The MIME type of a `#CONTENT_URI` item.
ContentType	The MIME-type of `#CONTENT_URI` providing a directory of contact directories.
Default	_ID of the default directory, which represents locally stored contacts.
DirectoryAuthority	The authority of the Directory Provider.
DisplayName	An optional name that can be used in the UI to represent this directory, e.
EnterpriseDefault	_ID of the managed profile default directory, which represents locally stored contacts.
EnterpriseLocalInvisible	_ID of the managed profile directory that represents locally stored invisible contacts.
ExportSupport	One of `#EXPORT_SUPPORT_NONE`, `#EXPORT_SUPPORT_ANY_ACCOUNT`, `#EXPORT_SUPPORT_SAME_ACCOUNT_ONLY`.
ExportSupportAnyAccount	Obsolete. An `#EXPORT_SUPPORT` setting that indicates that the directory allow its data copied to any contacts account.
ExportSupportNone	Obsolete. An `#EXPORT_SUPPORT` setting that indicates that the directory does not allow any data to be copied out of it.
ExportSupportSameAccountOnly	Obsolete. An `#EXPORT_SUPPORT` setting that indicates that the directory allow its data copied only to the account specified by `#ACCOUNT_TYPE`/`#ACCOUNT_NAME`.
LocalInvisible	_ID of the directory that represents locally stored invisible contacts.
PackageName	The name of the package that owns this directory.
PhotoSupport	One of `#PHOTO_SUPPORT_NONE`, `#PHOTO_SUPPORT_THUMBNAIL_ONLY`, `#PHOTO_SUPPORT_FULL`.
PhotoSupportFull	Obsolete. An `#PHOTO_SUPPORT` setting that indicates that the directory can produce thumbnails as well as full-size contact photos.
PhotoSupportFullSizeOnly	Obsolete. An `#PHOTO_SUPPORT` setting that indicates that the directory has full-size contact photos, but cannot provide scaled thumbnails.
PhotoSupportNone	Obsolete. An `#PHOTO_SUPPORT` setting that indicates that the directory does not provide any photos.
PhotoSupportThumbnailOnly	Obsolete. An `#PHOTO_SUPPORT` setting that indicates that the directory can only produce small size thumbnails of contact photos.
ShortcutSupport	One of `#SHORTCUT_SUPPORT_NONE`, `#SHORTCUT_SUPPORT_DATA_ITEMS_ONLY`, `#SHORTCUT_SUPPORT_FULL`.
ShortcutSupportDataItemsOnly	Obsolete. 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.
ShortcutSupportFull	Obsolete. An `#SHORTCUT_SUPPORT` setting that indicates that the directory allow creation of shortcuts for contact as well as their constituent elements.
ShortcutSupportNone	Obsolete. An `#SHORTCUT_SUPPORT` setting that indicates that the directory does not allow any shortcuts created for its contacts.
TypeResourceId	The type of directory captured as a resource ID in the context of the package `#PACKAGE_NAME`, e.

Properties

Class	Returns the runtime class of this `Object`. (Inherited from Object)
ContentUri	The content:// style URI for this table.
EnterpriseContentUri	URI used for getting all directories from both the calling user and the managed profile that is linked to it.
Handle	The handle to the underlying Android instance. (Inherited from Object)
JniIdentityHashCode	(Inherited from Object)
JniPeerMembers
PeerReference	(Inherited from Object)
ThresholdClass	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object)
ThresholdType	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object)

Methods

Clone()	Creates and returns a copy of this object. (Inherited from Object)
Dispose()	(Inherited from Object)
Dispose(Boolean)	(Inherited from Object)
Equals(Object)	Indicates whether some other object is "equal to" this one. (Inherited from Object)
GetHashCode()	Returns a hash code value for the object. (Inherited from Object)
IsEnterpriseDirectoryId(Int64)	Return TRUE if a directory ID is from the contacts provider on the enterprise profile.
IsRemoteDirectoryId(Int64)	Return TRUE if it is a remote stored directory.
JavaFinalize()	Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object)
Notify()	Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object)
NotifyAll()	Wakes up all threads that are waiting on this object's monitor. (Inherited from Object)
NotifyDirectoryChange(ContentResolver)	Notifies the system of a change in the list of directories handled by a particular directory provider.
SetHandle(IntPtr, JniHandleOwnership)	Sets the Handle property. (Inherited from Object)
ToArray<T>()	(Inherited from Object)
ToString()	Returns a string representation of the object. (Inherited from Object)
UnregisterFromRuntime()	(Inherited from Object)
Wait()	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object)
Wait(Int64, Int32)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)
Wait(Int64)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)

Explicit Interface Implementations

IJavaPeerable.Disposed()	(Inherited from Object)
IJavaPeerable.DisposeUnlessReferenced()	(Inherited from Object)
IJavaPeerable.Finalized()	(Inherited from Object)
IJavaPeerable.JniManagedPeerState	(Inherited from Object)
IJavaPeerable.SetJniIdentityHashCode(Int32)	(Inherited from Object)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)	(Inherited from Object)
IJavaPeerable.SetPeerReference(JniObjectReference)	(Inherited from Object)

Extension Methods

JavaCast<TResult>(IJavaObject)	Performs an Android runtime-checked type conversion.
JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable)

Applies to

Partager via