From f7909cc399e0e7664a679d6048e41337acef8a25 Mon Sep 17 00:00:00 2001
From: Jeremy Joslin <jjoslin@google.com>
Date: Thu, 13 Apr 2017 10:33:26 -0700
Subject: Add more NetworkRecommendationProvider documentation.

Documented the requirements for becoming a network recommendation
provider.

Test: Built
Bug: 33632378
Change-Id: I8ec037c8688b250514cbe25a13434c7b8bef8327
---
 core/java/android/net/NetworkRecommendationProvider.java | 13 +++++++++++++
 1 file changed, 13 insertions(+)

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
-- 
cgit v1.2.3-59-g8ed1b