Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 43251338 authored by Dave Santoro's avatar Dave Santoro
Browse files

API modifications to handle profiles in Contacts. 

The user's profile is represented as a single Contact, comprised of
Raw Contacts which may be contributed from any accounts the user has on the
system.

Two new permissions have been added: READ_PROFILE and WRITE_PROFILE.  These are
required for reading or writing any contact data that is designated as part of
the user's profile.

Contact queries can include the user's profile data by setting the
include_profile URI parameter to 1 (this requires READ_PROFILE access).  By
default, the user's profile data will not be included in any Contact queries.

Change-Id: I25616f59622dbb157032c9c435064eb36af6e8e1
parent 31bc2f92

api/current.txt

+11 −0
Original line number Diff line number Diff line
@@ -78,6 +78,7 @@ package android { 
    field public static final java.lang.String READ_INPUT_STATE = "android.permission.READ_INPUT_STATE";

    field public static final java.lang.String READ_LOGS = "android.permission.READ_LOGS";

    field public static final java.lang.String READ_PHONE_STATE = "android.permission.READ_PHONE_STATE";

    field public static final java.lang.String READ_PROFILE = "android.permission.READ_PROFILE";

    field public static final java.lang.String READ_SMS = "android.permission.READ_SMS";

    field public static final java.lang.String READ_SYNC_SETTINGS = "android.permission.READ_SYNC_SETTINGS";

    field public static final java.lang.String READ_SYNC_STATS = "android.permission.READ_SYNC_STATS";
@@ -121,6 +122,7 @@ package android { 
    field public static final java.lang.String WRITE_EXTERNAL_STORAGE = "android.permission.WRITE_EXTERNAL_STORAGE";

    field public static final java.lang.String WRITE_GSERVICES = "android.permission.WRITE_GSERVICES";

    field public static final java.lang.String WRITE_HISTORY_BOOKMARKS = "com.android.browser.permission.WRITE_HISTORY_BOOKMARKS";

    field public static final java.lang.String WRITE_PROFILE = "android.permission.WRITE_PROFILE";

    field public static final java.lang.String WRITE_SECURE_SETTINGS = "android.permission.WRITE_SECURE_SETTINGS";

    field public static final java.lang.String WRITE_SETTINGS = "android.permission.WRITE_SETTINGS";

    field public static final java.lang.String WRITE_SMS = "android.permission.WRITE_SMS";
@@ -15195,6 +15197,7 @@ package android.provider { 
    field public static final android.net.Uri AUTHORITY_URI;

    field public static final java.lang.String CALLER_IS_SYNCADAPTER = "caller_is_syncadapter";

    field public static final java.lang.String DIRECTORY_PARAM_KEY = "directory";

    field public static final java.lang.String INCLUDE_PROFILE = "include_profile";

    field public static final java.lang.String LIMIT_PARAM_KEY = "limit";

  }










@@ -15494,6 +15497,7 @@ package android.provider {













    field public static final java.lang.String DISPLAY_NAME = "display_name";















    field public static final java.lang.String HAS_PHONE_NUMBER = "has_phone_number";















    field public static final java.lang.String IN_VISIBLE_GROUP = "in_visible_group";













    field public static final java.lang.String IS_USER_PROFILE = "is_user_profile";















    field public static final java.lang.String LOOKUP_KEY = "lookup";















    field public static final java.lang.String PHOTO_ID = "photo_id";















    field public static final java.lang.String PHOTO_THUMBNAIL_URI = "photo_thumb_uri";










@@ -15677,6 +15681,12 @@ package android.provider {













    field public static final java.lang.String PROTOCOL = "protocol";















  }



























  public static final class ContactsContract.Profile implements android.provider.BaseColumns android.provider.ContactsContract.ContactNameColumns android.provider.ContactsContract.ContactOptionsColumns android.provider.ContactsContract.ContactStatusColumns android.provider.ContactsContract.ContactsColumns {













    field public static final android.net.Uri CONTENT_RAW_CONTACTS_URI;













    field public static final android.net.Uri CONTENT_URI;













    field public static final android.net.Uri CONTENT_VCARD_URI;













  }



























  public static final class ContactsContract.QuickContact {















    ctor public ContactsContract.QuickContact();















    method public static void showQuickContact(android.content.Context, android.view.View, android.net.Uri, int, java.lang.String[]);










@@ -15712,6 +15722,7 @@ package android.provider {













    field public static final java.lang.String CONTACT_ID = "contact_id";















    field public static final java.lang.String DELETED = "deleted";















    field public static final java.lang.String RAW_CONTACT_IS_READ_ONLY = "raw_contact_is_read_only";













    field public static final java.lang.String RAW_CONTACT_IS_USER_PROFILE = "raw_contact_is_user_profile";















  }





























  public static final class ContactsContract.RawContactsEntity implements android.provider.BaseColumns android.provider.ContactsContract.DataColumns android.provider.ContactsContract.RawContactsColumns {

























core/java/android/provider/ContactsContract.java



+108
−3




























Original line number
Diff line number
Diff line








@@ -121,6 +121,17 @@ public final class ContactsContract {













     */















    public static final String CALLER_IS_SYNCADAPTER = "caller_is_syncadapter";





























    /**













     * An optional URI parameter for selection queries that instructs the













     * provider to include the user's personal profile contact entry (if any)













     * in the contact results.  If present, the user's profile will always be













     * the first entry returned.  The default value is false.













     *













     * Specifying this parameter will result in a security error if the calling













     * application does not have android.permission.READ_PROFILE permission.













     */













    public static final String INCLUDE_PROFILE = "include_profile";





























    /**















     * A query parameter key used to specify the package that is requesting a query.















     * This is used for restricting data based on package name.










@@ -763,11 +774,17 @@ public final class ContactsContract {













        public static final String PHOTO_THUMBNAIL_URI = "photo_thumb_uri";































        /**













         * Lookup value that reflects the {@link Groups#GROUP_VISIBLE} state of













         * any {@link CommonDataKinds.GroupMembership} for this contact.













         * Flag that reflects the {@link Groups#GROUP_VISIBLE} state of any













         * {@link CommonDataKinds.GroupMembership} for this contact.















         */















        public static final String IN_VISIBLE_GROUP = "in_visible_group";





























        /**













         * Flag that reflects whether this contact represents the user's













         * personal profile entry.













         */













        public static final String IS_USER_PROFILE = "is_user_profile";





























        /**















         * An indicator of whether this contact has at least one phone number. "1" if there is















         * at least one phone number, "0" otherwise.










@@ -1285,7 +1302,7 @@ public final class ContactsContract {













         * Base {@link Uri} for referencing multiple {@link Contacts} entry,















         * created by appending {@link #LOOKUP_KEY} using















         * {@link Uri#withAppendedPath(Uri, String)}. The lookup keys have to be













         * encoded and joined with the colon (":") seperator. The resulting string













         * encoded and joined with the colon (":") separator. The resulting string















         * has to be encoded again. Provides















         * {@link OpenableColumns} columns when queried, or returns the















         * referenced contact formatted as a vCard when opened through










@@ -1738,6 +1755,88 @@ public final class ContactsContract {













        }















    }





























    /**













     * <p>













     * Constants for the user's profile data, which is represented as a single contact on













     * the device that represents the user.  The profile contact is not aggregated













     * together automatically in the same way that normal contacts are; instead, each













     * account on the device may contribute a single raw contact representing the user's













     * personal profile data from that source.













     * </p>













     * <p>













     * Access to the profile entry through these URIs (or incidental access to parts of













     * the profile if retrieved directly via ID) requires additional permissions beyond













     * the read/write contact permissions required by the provider.  Querying for profile













     * data requires android.permission.READ_PROFILE permission, and inserting or













     * updating profile data requires android.permission.WRITE_PROFILE permission.













     * </p>













     * <h3>Operations</h3>













     * <dl>













     * <dt><b>Insert</b></dt>













     * <dd>The user's profile entry cannot be created explicitly (attempting to do so













     * will throw an exception). When a raw contact is inserted into the profile, the













     * provider will check for the existence of a profile on the device.  If one is













     * found, the raw contact's {@link RawContacts#CONTACT_ID} column gets the _ID of













     * the profile Contact. If no match is found, the profile Contact is created and













     * its _ID is put into the {@link RawContacts#CONTACT_ID} column of the newly













     * inserted raw contact.</dd>













     * <dt><b>Update</b></dt>













     * <dd>The profile Contact has the same update restrictions as Contacts in general,













     * but requires the android.permission.WRITE_PROFILE permission.</dd>













     * <dt><b>Delete</b></dt>













     * <dd>The profile Contact cannot be explicitly deleted.  It will be removed













     * automatically if all of its constituent raw contact entries are deleted.</dd>













     * <dt><b>Query</b></dt>













     * <dd>













     * <ul>













     * <li>The {@link #CONTENT_URI} for profiles behaves in much the same way as













     * retrieving a contact by ID, except that it will only ever return the user's













     * profile contact.













     * </li>













     * <li>













     * The profile contact supports all of the same sub-paths as an individual contact













     * does - the content of the profile contact can be retrieved as entities or













     * data rows.  Similarly, specific raw contact entries can be retrieved by appending













     * the desired raw contact ID within the profile.













     * </li>













     * </ul>













     * </dd>













     * </dl>













     */













    public static final class Profile implements BaseColumns, ContactsColumns,













            ContactOptionsColumns, ContactNameColumns, ContactStatusColumns {













        /**













         * This utility class cannot be instantiated













         */













        private Profile() {













        }



























        /**













         * The content:// style URI for this table, which requests the contact entry













         * representing the user's personal profile data.













         */













        public static final Uri CONTENT_URI = Uri.withAppendedPath(AUTHORITY_URI, "profile");



























        /**













         * {@link Uri} for referencing the user's profile {@link Contacts} entry,













         * Provides {@link OpenableColumns} columns when queried, or returns the













         * user's profile contact formatted as a vCard when opened through













         * {@link ContentResolver#openAssetFileDescriptor(Uri, String)}.













         */













        public static final Uri CONTENT_VCARD_URI = Uri.withAppendedPath(CONTENT_URI,













                "as_vcard");



























        /**













         * {@link Uri} for referencing the raw contacts that make up the user's profile













         * {@link Contacts} entry.  An individual raw contact entry within the profile













         * can be addressed by appending the raw contact ID.  The entities or data within













         * that specific raw contact can be requested by appending the entity or data













         * path as well.













         */













        public static final Uri CONTENT_RAW_CONTACTS_URI = Uri.withAppendedPath(CONTENT_URI,













                "raw_contacts");













    }





























    protected interface RawContactsColumns {















        /**















         * A reference to the {@link ContactsContract.Contacts#_ID} that this










@@ -1806,6 +1905,12 @@ public final class ContactsContract {













         * <P>Type: INTEGER</P>















         */















        public static final String RAW_CONTACT_IS_READ_ONLY = "raw_contact_is_read_only";



























        /**













         * Flag that reflects whether this raw contact belongs to the user's













         * personal profile entry.













         */













        public static final String RAW_CONTACT_IS_USER_PROFILE = "raw_contact_is_user_profile";















    }































    /**

































core/res/AndroidManifest.xml



+16
−0




























Original line number
Diff line number
Diff line








@@ -217,6 +217,22 @@













        android:label="@string/permlab_writeContacts"















        android:description="@string/permdesc_writeContacts" />











































    <!-- Allows an application to read the user's personal profile data. -->













    <permission android:name="android.permission.READ_PROFILE"













        android:permissionGroup="android.permission-group.PERSONAL_INFO"













        android:protectionLevel="dangerous"













        android:label="@string/permlab_readProfile"













        android:description="@string/permdesc_readProfile" />



























    <!-- Allows an application to write (but not read) the user's













         personal profile data. -->













    <permission android:name="android.permission.WRITE_PROFILE"













        android:permissionGroup="android.permission-group.PERSONAL_INFO"













        android:protectionLevel="dangerous"













        android:label="@string/permlab_writeProfile"













        android:description="@string/permdesc_writeProfile" />





























    <!-- Allows an application to read the user's calendar data. -->















    <permission android:name="android.permission.READ_CALENDAR"















        android:permissionGroup="android.permission-group.PERSONAL_INFO"

































core/res/res/values/strings.xml



+14
−0




























Original line number
Diff line number
Diff line








@@ -901,6 +901,20 @@













        contact (address) data stored on your phone. Malicious















        applications can use this to erase or modify your contact data.</string>





























    <!-- Title of an application permission, listed so the user can choose whether they want to allow the application to do this. -->













    <string name="permlab_readProfile">read profile data</string>













    <!-- Description of an application permission, listed so the user can choose whether they want to allow the application to do this. -->













    <string name="permdesc_readProfile" product="default">Allows an application to read all













        of your personal profile information. Malicious applications can use this to identify













        you and send your personal information to other people.</string>



























    <!-- Title of an application permission, listed so the user can choose whether they want to allow the application to do this. -->













    <string name="permlab_writeProfile">write profile data</string>













    <!-- Description of an application permission, listed so the user can choose whether they want to allow the application to do this. -->













    <string name="permdesc_writeProfile" product="default">Allows an application to modify













        your personal profile information. Malicious applications can use this to erase or













        modify your profile data.</string>





























    <!-- Title of an application permission, listed so the user can choose whether they want to allow the application to do this. -->















    <string name="permlab_readCalendar">read calendar events</string>















    <!-- Description of an application permission, listed so the user can choose whether they want to allow the application to do this. -->