summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author Jeremy Joslin <jjoslin@google.com> 2017-04-13 10:33:26 -0700
committer Jeremy Joslin <jjoslin@google.com> 2017-04-13 10:33:26 -0700
commitf7909cc399e0e7664a679d6048e41337acef8a25 (patch)
tree7d6a0e67a782df83bc9464cda0c29ca12f2a3dbb
parentd39388219f0d8f0fc2ec1b61a8b339684c610182 (diff)
Add more NetworkRecommendationProvider documentation.
Documented the requirements for becoming a network recommendation provider. Test: Built Bug: 33632378 Change-Id: I8ec037c8688b250514cbe25a13434c7b8bef8327
-rw-r--r--core/java/android/net/NetworkRecommendationProvider.java13
1 files changed, 13 insertions, 0 deletions
diff --git a/core/java/android/net/NetworkRecommendationProvider.java b/core/java/android/net/NetworkRecommendationProvider.java
index 271b0a7c7507..af0459d63718 100644
--- a/core/java/android/net/NetworkRecommendationProvider.java
+++ b/core/java/android/net/NetworkRecommendationProvider.java
@@ -20,6 +20,19 @@ import java.util.concurrent.atomic.AtomicBoolean;
/**
* The base class for implementing a network recommendation provider.
+ * <p>
+ * A network recommendation provider is any application which:
+ * <ul>
+ * <li>Is granted the {@link permission#SCORE_NETWORKS} permission.
+ * <li>Includes a Service for the {@link NetworkScoreManager#ACTION_RECOMMEND_NETWORKS} intent
+ * which is protected by the {@link permission#BIND_NETWORK_RECOMMENDATION_SERVICE} permission.
+ * </ul>
+ * <p>
+ * Implementations are required to implement the abstract methods in this class and return the
+ * result of {@link #getBinder()} from the <code>onBind()</code> method in their Service.
+ * <p>
+ * The default network recommendation provider is controlled via the
+ * <code>config_defaultNetworkRecommendationProviderPackage</code> config key.
* @hide
*/
@SystemApi