summaryrefslogtreecommitdiffstats
path: root/core/java/android/content
diff options
context:
space:
mode:
authorNicolas Falliere <nicof@google.com>2012-06-18 17:45:40 -0700
committerAndroid Git Automerger <android-git-automerger@android.com>2012-06-18 17:45:40 -0700
commit4d2bef3f850e75744ade93f95615c7cb4a7fefa0 (patch)
treec00ce4871ecaf2faaea01375120850043185510a /core/java/android/content
parent3eda1903c709904da9a1668b0ba9c46f13cd9f80 (diff)
parent277c09f6c16c4adfd50407e2fa4dbf61a0e06e55 (diff)
downloadframeworks_base-4d2bef3f850e75744ade93f95615c7cb4a7fefa0.zip
frameworks_base-4d2bef3f850e75744ade93f95615c7cb4a7fefa0.tar.gz
frameworks_base-4d2bef3f850e75744ade93f95615c7cb4a7fefa0.tar.bz2
am 277c09f6: am 56bb344c: Merge "Added or fixed doctrings for required permissions." into jb-dev
* commit '277c09f6c16c4adfd50407e2fa4dbf61a0e06e55': Added or fixed doctrings for required permissions.
Diffstat (limited to 'core/java/android/content')
-rw-r--r--core/java/android/content/ContentResolver.java30
-rw-r--r--core/java/android/content/Context.java6
2 files changed, 36 insertions, 0 deletions
diff --git a/core/java/android/content/ContentResolver.java b/core/java/android/content/ContentResolver.java
index 34b5a30..0a5a26a 100644
--- a/core/java/android/content/ContentResolver.java
+++ b/core/java/android/content/ContentResolver.java
@@ -1415,6 +1415,8 @@ public abstract class ContentResolver {
/**
* Check if the provider should be synced when a network tickle is received
+ * <p>This method requires the caller to hold the permission
+ * {@link android.Manifest.permission#READ_SYNC_SETTINGS}.
*
* @param account the account whose setting we are querying
* @param authority the provider whose setting we are querying
@@ -1430,6 +1432,8 @@ public abstract class ContentResolver {
/**
* Set whether or not the provider is synced when it receives a network tickle.
+ * <p>This method requires the caller to hold the permission
+ * {@link android.Manifest.permission#WRITE_SYNC_SETTINGS}.
*
* @param account the account whose setting we are querying
* @param authority the provider whose behavior is being controlled
@@ -1461,6 +1465,9 @@ public abstract class ContentResolver {
* {@link #SYNC_EXTRAS_EXPEDITED}, {@link #SYNC_EXTRAS_MANUAL} set to true.
* If any are supplied then an {@link IllegalArgumentException} will be thrown.
*
+ * <p>This method requires the caller to hold the permission
+ * {@link android.Manifest.permission#WRITE_SYNC_SETTINGS}.
+ *
* @param account the account to specify in the sync
* @param authority the provider to specify in the sync request
* @param extras extra parameters to go along with the sync request
@@ -1497,6 +1504,8 @@ public abstract class ContentResolver {
/**
* Remove a periodic sync. Has no affect if account, authority and extras don't match
* an existing periodic sync.
+ * <p>This method requires the caller to hold the permission
+ * {@link android.Manifest.permission#WRITE_SYNC_SETTINGS}.
*
* @param account the account of the periodic sync to remove
* @param authority the provider of the periodic sync to remove
@@ -1519,6 +1528,8 @@ public abstract class ContentResolver {
/**
* Get the list of information about the periodic syncs for the given account and authority.
+ * <p>This method requires the caller to hold the permission
+ * {@link android.Manifest.permission#READ_SYNC_SETTINGS}.
*
* @param account the account whose periodic syncs we are querying
* @param authority the provider whose periodic syncs we are querying
@@ -1540,6 +1551,8 @@ public abstract class ContentResolver {
/**
* Check if this account/provider is syncable.
+ * <p>This method requires the caller to hold the permission
+ * {@link android.Manifest.permission#READ_SYNC_SETTINGS}.
* @return >0 if it is syncable, 0 if not, and <0 if the state isn't known yet.
*/
public static int getIsSyncable(Account account, String authority) {
@@ -1552,6 +1565,8 @@ public abstract class ContentResolver {
/**
* Set whether this account/provider is syncable.
+ * <p>This method requires the caller to hold the permission
+ * {@link android.Manifest.permission#WRITE_SYNC_SETTINGS}.
* @param syncable >0 denotes syncable, 0 means not syncable, <0 means unknown
*/
public static void setIsSyncable(Account account, String authority, int syncable) {
@@ -1566,6 +1581,8 @@ public abstract class ContentResolver {
/**
* Gets the master auto-sync setting that applies to all the providers and accounts.
* If this is false then the per-provider auto-sync setting is ignored.
+ * <p>This method requires the caller to hold the permission
+ * {@link android.Manifest.permission#READ_SYNC_SETTINGS}.
*
* @return the master auto-sync setting that applies to all the providers and accounts
*/
@@ -1580,6 +1597,8 @@ public abstract class ContentResolver {
/**
* Sets the master auto-sync setting that applies to all the providers and accounts.
* If this is false then the per-provider auto-sync setting is ignored.
+ * <p>This method requires the caller to hold the permission
+ * {@link android.Manifest.permission#WRITE_SYNC_SETTINGS}.
*
* @param sync the master auto-sync setting that applies to all the providers and accounts
*/
@@ -1595,6 +1614,8 @@ public abstract class ContentResolver {
/**
* Returns true if there is currently a sync operation for the given
* account or authority in the pending list, or actively being processed.
+ * <p>This method requires the caller to hold the permission
+ * {@link android.Manifest.permission#READ_SYNC_STATS}.
* @param account the account whose setting we are querying
* @param authority the provider whose behavior is being queried
* @return true if a sync is active for the given account or authority.
@@ -1610,6 +1631,9 @@ public abstract class ContentResolver {
/**
* If a sync is active returns the information about it, otherwise returns null.
* <p>
+ * This method requires the caller to hold the permission
+ * {@link android.Manifest.permission#READ_SYNC_STATS}.
+ * <p>
* @return the SyncInfo for the currently active sync or null if one is not active.
* @deprecated
* Since multiple concurrent syncs are now supported you should use
@@ -1633,6 +1657,10 @@ public abstract class ContentResolver {
/**
* Returns a list with information about all the active syncs. This list will be empty
* if there are no active syncs.
+ * <p>
+ * This method requires the caller to hold the permission
+ * {@link android.Manifest.permission#READ_SYNC_STATS}.
+ * <p>
* @return a List of SyncInfo objects for the currently active syncs.
*/
public static List<SyncInfo> getCurrentSyncs() {
@@ -1660,6 +1688,8 @@ public abstract class ContentResolver {
/**
* Return true if the pending status is true of any matching authorities.
+ * <p>This method requires the caller to hold the permission
+ * {@link android.Manifest.permission#READ_SYNC_STATS}.
* @param account the account whose setting we are querying
* @param authority the provider whose behavior is being queried
* @return true if there is a pending sync with the matching account and authority
diff --git a/core/java/android/content/Context.java b/core/java/android/content/Context.java
index 11b4906..2800930 100644
--- a/core/java/android/content/Context.java
+++ b/core/java/android/content/Context.java
@@ -813,6 +813,8 @@ public abstract class Context {
/**
* @deprecated Use {@link android.app.WallpaperManager#setBitmap(Bitmap)
* WallpaperManager.set()} instead.
+ * <p>This method requires the caller to hold the permission
+ * {@link android.Manifest.permission#SET_WALLPAPER}.
*/
@Deprecated
public abstract void setWallpaper(Bitmap bitmap) throws IOException;
@@ -820,6 +822,8 @@ public abstract class Context {
/**
* @deprecated Use {@link android.app.WallpaperManager#setStream(InputStream)
* WallpaperManager.set()} instead.
+ * <p>This method requires the caller to hold the permission
+ * {@link android.Manifest.permission#SET_WALLPAPER}.
*/
@Deprecated
public abstract void setWallpaper(InputStream data) throws IOException;
@@ -827,6 +831,8 @@ public abstract class Context {
/**
* @deprecated Use {@link android.app.WallpaperManager#clear
* WallpaperManager.clear()} instead.
+ * <p>This method requires the caller to hold the permission
+ * {@link android.Manifest.permission#SET_WALLPAPER}.
*/
@Deprecated
public abstract void clearWallpaper() throws IOException;