Improve real-time reference docs. #4808
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Javadoc Changes:--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/remoteconfig/ConfigUpdate.html 2023-03-21 20:59:28.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/remoteconfig/ConfigUpdate.html 2023-03-21 20:54:55.000000000 +0000
@@ -11,7 +11,7 @@
<pre>@<a href="/docs/reference/android/com/google/auto/value/AutoValue.html">AutoValue</a><br>public abstract class <a href="/docs/reference/android/com/google/firebase/remoteconfig/ConfigUpdate.html">ConfigUpdate</a></pre>
</p>
<hr>
- <p>Information about the updated config passed to the <code>onUpdate</code> callback of .</p>
+ <p>Information about the updated config passed to <code><a href="/docs/reference/android/com/google/firebase/remoteconfig/ConfigUpdateListener.html#onUpdate(com.google.firebase.remoteconfig.ConfigUpdate)">onUpdate</a></code>.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/remoteconfig/ConfigUpdateListener.html 2023-03-21 20:59:28.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/remoteconfig/ConfigUpdateListener.html 2023-03-21 20:54:55.000000000 +0000
@@ -11,7 +11,7 @@
<pre>public interface <a href="/docs/reference/android/com/google/firebase/remoteconfig/ConfigUpdateListener.html">ConfigUpdateListener</a></pre>
</p>
<hr>
- <p>Event listener interface for real-time RC updates. Implement <code>ConfigUpdateListner</code> to call <code><a href="/docs/reference/android/com/google/firebase/remoteconfig/FirebaseRemoteConfig.html#addOnConfigUpdateListener(com.google.firebase.remoteconfig.ConfigUpdateListener)">addOnConfigUpdateListener</a></code>.</p>
+ <p>Event listener interface for real-time Remote Config updates. Implement to call <code><a href="/docs/reference/android/com/google/firebase/remoteconfig/FirebaseRemoteConfig.html#addOnConfigUpdateListener(com.google.firebase.remoteconfig.ConfigUpdateListener)">addOnConfigUpdateListener</a></code>.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -29,14 +29,14 @@
<td><code>abstract void</code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/remoteconfig/ConfigUpdateListener.html#onError(com.google.firebase.remoteconfig.FirebaseRemoteConfigException)">onError</a>(@<a href="/docs/reference/android/javax/annotation/Nonnull.html">Nonnull</a> <a href="/docs/reference/android/com/google/firebase/remoteconfig/FirebaseRemoteConfigException.html">FirebaseRemoteConfigException</a> error)</code></div>
- <p>Callback for when an error occurs while listening or fetching a config update.</p>
+ <p>Callback for when an error occurs while listening for updates or fetching the latest version of the config.</p>
</td>
</tr>
<tr>
<td><code>abstract void</code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/remoteconfig/ConfigUpdateListener.html#onUpdate(com.google.firebase.remoteconfig.ConfigUpdate)">onUpdate</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/remoteconfig/ConfigUpdate.html">ConfigUpdate</a> configUpdate)</code></div>
- <p>Callback for when a new config has been automatically fetched from the backend and has changed from the activated config.</p>
+ <p>Callback for when a new config version has been automatically fetched from the backend and has changed from the activated config.</p>
</td>
</tr>
</tbody>
@@ -47,7 +47,7 @@
<div class="api-item"><a name="onError-com.google.firebase.remoteconfig.FirebaseRemoteConfigException-"></a><a name="onerror"></a>
<h3 class="api-name" id="onError(com.google.firebase.remoteconfig.FirebaseRemoteConfigException)">onError</h3>
<pre class="api-signature no-pretty-print">abstract void <a href="/docs/reference/android/com/google/firebase/remoteconfig/ConfigUpdateListener.html#onError(com.google.firebase.remoteconfig.FirebaseRemoteConfigException)">onError</a>(@<a href="/docs/reference/android/javax/annotation/Nonnull.html">Nonnull</a> <a href="/docs/reference/android/com/google/firebase/remoteconfig/FirebaseRemoteConfigException.html">FirebaseRemoteConfigException</a> error)</pre>
- <p>Callback for when an error occurs while listening or fetching a config update.</p>
+ <p>Callback for when an error occurs while listening for updates or fetching the latest version of the config.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
@@ -73,7 +73,7 @@
<div class="api-item"><a name="onUpdate-com.google.firebase.remoteconfig.ConfigUpdate-"></a><a name="onupdate"></a>
<h3 class="api-name" id="onUpdate(com.google.firebase.remoteconfig.ConfigUpdate)">onUpdate</h3>
<pre class="api-signature no-pretty-print">abstract void <a href="/docs/reference/android/com/google/firebase/remoteconfig/ConfigUpdateListener.html#onUpdate(com.google.firebase.remoteconfig.ConfigUpdate)">onUpdate</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/remoteconfig/ConfigUpdate.html">ConfigUpdate</a> configUpdate)</pre>
- <p>Callback for when a new config has been automatically fetched from the backend and has changed from the activated config.</p>
+ <p>Callback for when a new config version has been automatically fetched from the backend and has changed from the activated config.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
@@ -89,7 +89,7 @@
<tr>
<td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/remoteconfig/ConfigUpdate.html">ConfigUpdate</a> configUpdate</code></td>
<td>
- <p>A <code><a href="/docs/reference/android/com/google/firebase/remoteconfig/ConfigUpdate.html">ConfigUpdate</a></code> with information about the updated config, including the set of updated parameters.</p>
+ <p>A <code><a href="/docs/reference/android/com/google/firebase/remoteconfig/ConfigUpdate.html">ConfigUpdate</a></code> with information about the updated config version, including the set of updated parameters.</p>
</td>
</tr>
</tbody>--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/remoteconfig/FirebaseRemoteConfig.html 2023-03-21 20:59:28.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/remoteconfig/FirebaseRemoteConfig.html 2023-03-21 20:54:55.000000000 +0000
@@ -136,7 +136,7 @@
<td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/remoteconfig/ConfigUpdateListenerRegistration.html">ConfigUpdateListenerRegistration</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/remoteconfig/FirebaseRemoteConfig.html#addOnConfigUpdateListener(com.google.firebase.remoteconfig.ConfigUpdateListener)">addOnConfigUpdateListener</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/remoteconfig/ConfigUpdateListener.html">ConfigUpdateListener</a> configUpdateListener<br>)</code></div>
- <p>Start listening for real-time config updates from the Remote Config backend and automatically fetch updates from the RC backend when they are available.</p>
+ <p>Starts listening for real-time config updates from the Remote Config backend and automatically fetches updates from the RC backend when they are available.</p>
</td>
</tr>
<tr>
@@ -362,9 +362,9 @@
<div class="api-item"><a name="addOnConfigUpdateListener-com.google.firebase.remoteconfig.ConfigUpdateListener-"></a><a name="addonconfigupdatelistener"></a>
<h3 class="api-name" id="addOnConfigUpdateListener(com.google.firebase.remoteconfig.ConfigUpdateListener)">addOnConfigUpdateListener</h3>
<pre class="api-signature no-pretty-print">public @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/remoteconfig/ConfigUpdateListenerRegistration.html">ConfigUpdateListenerRegistration</a> <a href="/docs/reference/android/com/google/firebase/remoteconfig/FirebaseRemoteConfig.html#addOnConfigUpdateListener(com.google.firebase.remoteconfig.ConfigUpdateListener)">addOnConfigUpdateListener</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/remoteconfig/ConfigUpdateListener.html">ConfigUpdateListener</a> configUpdateListener<br>)</pre>
- <p>Start listening for real-time config updates from the Remote Config backend and automatically fetch updates from the RC backend when they are available. </p>
+ <p>Starts listening for real-time config updates from the Remote Config backend and automatically fetches updates from the RC backend when they are available. </p>
<p>If a connection to the Remote Config backend is not already open, calling this method will open it. Multiple listeners can be added by calling this method again, but subsequent calls re-use the same connection to the backend. </p>
- <p>Note: Real-time Remote Config requires the Firebase Remote Config Realtime API. See the <a href="https://firebase.google.com/docs/remote-config/get-started">Remote Config Get Started </a> guide to enable the API.</p>
+ <p>Note: Real-time Remote Config requires the Firebase Remote Config Realtime API. See the <a href="https://firebase.google.com/docs/remote-config/get-started#add-real-time-listener">Remote Config Get Started </a> guide to enable the API.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
@@ -401,7 +401,8 @@
<tr>
<td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/remoteconfig/ConfigUpdateListenerRegistration.html">ConfigUpdateListenerRegistration</a></code></td>
<td>
- <p>A <code><a href="/docs/reference/android/com/google/firebase/remoteconfig/ConfigUpdateListenerRegistration.html">ConfigUpdateListenerRegistration</a></code> that allows the user to remove the added <code>configUpdateListener</code> and close the connection when there are no more listeners.</p>
+ <p>A <code><a href="/docs/reference/android/com/google/firebase/remoteconfig/ConfigUpdateListenerRegistration.html">ConfigUpdateListenerRegistration</a></code> that allows you to remove the added <code>
+ configUpdateListener</code> and close the connection when there are no more listeners.</p>
</td>
</tr>
</tbody>--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/remoteconfig/FirebaseRemoteConfigClientException.html 2023-03-21 20:59:28.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/remoteconfig/FirebaseRemoteConfigClientException.html 2023-03-21 20:54:55.000000000 +0000
@@ -85,7 +85,7 @@
<tr>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/remoteconfig/FirebaseRemoteConfigClientException.html#FirebaseRemoteConfigClientException(java.lang.String,java.lang.Throwable,com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)">FirebaseRemoteConfigClientException</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> detailMessage,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Throwable.html">Throwable</a> cause,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/remoteconfig/FirebaseRemoteConfigException.Code.html">FirebaseRemoteConfigException.Code</a> code<br>)</code></div>
- <p>Creates a Firebase Remote Config client exception with the given message, exception cause, and FirebaseRemoteConfigException code.</p>
+ <p>Creates a Firebase Remote Config client exception with the given message, exception cause, and <code>FirebaseRemoteConfigException</code> code.</p>
</td>
</tr>
</tbody>
@@ -254,7 +254,7 @@
<div class="api-item"><a name="FirebaseRemoteConfigClientException(java.lang.String, java.lang.Throwable, com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)"></a><a name="FirebaseRemoteConfigClientException-java.lang.String-java.lang.Throwable-com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code-"></a><a name="firebaseremoteconfigclientexception"></a>
<h3 class="api-name" id="FirebaseRemoteConfigClientException(java.lang.String,java.lang.Throwable,com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)">FirebaseRemoteConfigClientException</h3>
<pre class="api-signature no-pretty-print">public <a href="/docs/reference/android/com/google/firebase/remoteconfig/FirebaseRemoteConfigClientException.html#FirebaseRemoteConfigClientException(java.lang.String,java.lang.Throwable,com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)">FirebaseRemoteConfigClientException</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> detailMessage,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Throwable.html">Throwable</a> cause,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/remoteconfig/FirebaseRemoteConfigException.Code.html">FirebaseRemoteConfigException.Code</a> code<br>)</pre>
- <p>Creates a Firebase Remote Config client exception with the given message, exception cause, and FirebaseRemoteConfigException code.</p>
+ <p>Creates a Firebase Remote Config client exception with the given message, exception cause, and <code>FirebaseRemoteConfigException</code> code.</p>
</div>
</div>
</body>--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/remoteconfig/FirebaseRemoteConfigServerException.html 2023-03-21 20:59:28.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/remoteconfig/FirebaseRemoteConfigServerException.html 2023-03-21 20:54:55.000000000 +0000
@@ -88,7 +88,8 @@
<tr>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/remoteconfig/FirebaseRemoteConfigServerException.html#FirebaseRemoteConfigServerException(java.lang.String,com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)">FirebaseRemoteConfigServerException</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> detailMessage,<br> @<a href="/docs/reference/android/javax/annotation/Nonnull.html">Nonnull</a> <a href="/docs/reference/android/com/google/firebase/remoteconfig/FirebaseRemoteConfigException.Code.html">FirebaseRemoteConfigException.Code</a> code<br>)</code></div>
- <p>Creates a Firebase Remote Config server exception with the given message and FirebaseRemoteConfigException code.</p>
+ <p>Creates a Firebase Remote Config server exception with the given message and <code>
+FirebaseRemoteConfigException</code> code.</p>
</td>
</tr>
<tr>
@@ -100,7 +101,7 @@
<tr>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/remoteconfig/FirebaseRemoteConfigServerException.html#FirebaseRemoteConfigServerException(java.lang.String,java.lang.Throwable,com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)">FirebaseRemoteConfigServerException</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> detailMessage,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Throwable.html">Throwable</a> cause,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/remoteconfig/FirebaseRemoteConfigException.Code.html">FirebaseRemoteConfigException.Code</a> code<br>)</code></div>
- <p>Creates a Firebase Remote Config server exception with the given message, exception cause, and FirebaseRemoteConfigException code.</p>
+ <p>Creates a Firebase Remote Config server exception with the given message, exception cause, and <code>FirebaseRemoteConfigException</code> code.</p>
</td>
</tr>
<tr>
@@ -112,13 +113,13 @@
<tr>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/remoteconfig/FirebaseRemoteConfigServerException.html#FirebaseRemoteConfigServerException(int,java.lang.String,com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)">FirebaseRemoteConfigServerException</a>(<br> int httpStatusCode,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> detailMessage,<br> @<a href="/docs/reference/android/javax/annotation/Nonnull.html">Nonnull</a> <a href="/docs/reference/android/com/google/firebase/remoteconfig/FirebaseRemoteConfigException.Code.html">FirebaseRemoteConfigException.Code</a> code<br>)</code></div>
- <p>Creates a Firebase Remote Config server exception with the HTTP status code, given message, and FirebaseRemoteConfigException code.</p>
+ <p>Creates a Firebase Remote Config server exception with the HTTP status code, given message, and <code>FirebaseRemoteConfigException</code> code.</p>
</td>
</tr>
<tr>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/remoteconfig/FirebaseRemoteConfigServerException.html#FirebaseRemoteConfigServerException(int,java.lang.String,java.lang.Throwable,com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)">FirebaseRemoteConfigServerException</a>(<br> int httpStatusCode,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> detailMessage,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Throwable.html">Throwable</a> cause,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/remoteconfig/FirebaseRemoteConfigException.Code.html">FirebaseRemoteConfigException.Code</a> code<br>)</code></div>
- <p>Creates a Firebase Remote Config server exception with the HTTP status code, given message, exception cause, and FirebaseRemoteConfigException code.</p>
+ <p>Creates a Firebase Remote Config server exception with the HTTP status code, given message, exception cause, and <code>FirebaseRemoteConfigException</code> code.</p>
</td>
</tr>
</tbody>
@@ -301,7 +302,8 @@
<div class="api-item"><a name="FirebaseRemoteConfigServerException(java.lang.String, com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)"></a><a name="FirebaseRemoteConfigServerException-java.lang.String-com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code-"></a><a name="firebaseremoteconfigserverexception"></a>
<h3 class="api-name" id="FirebaseRemoteConfigServerException(java.lang.String,com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)">FirebaseRemoteConfigServerException</h3>
<pre class="api-signature no-pretty-print">public <a href="/docs/reference/android/com/google/firebase/remoteconfig/FirebaseRemoteConfigServerException.html#FirebaseRemoteConfigServerException(java.lang.String,com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)">FirebaseRemoteConfigServerException</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> detailMessage,<br> @<a href="/docs/reference/android/javax/annotation/Nonnull.html">Nonnull</a> <a href="/docs/reference/android/com/google/firebase/remoteconfig/FirebaseRemoteConfigException.Code.html">FirebaseRemoteConfigException.Code</a> code<br>)</pre>
- <p>Creates a Firebase Remote Config server exception with the given message and FirebaseRemoteConfigException code.</p>
+ <p>Creates a Firebase Remote Config server exception with the given message and <code>
+FirebaseRemoteConfigException</code> code.</p>
</div>
<div class="api-item"><a name="FirebaseRemoteConfigServerException(int, java.lang.String)"></a><a name="FirebaseRemoteConfigServerException-int-java.lang.String-"></a><a name="firebaseremoteconfigserverexception"></a>
<h3 class="api-name" id="FirebaseRemoteConfigServerException(int,java.lang.String)">FirebaseRemoteConfigServerException</h3>
@@ -311,7 +313,7 @@
<div class="api-item"><a name="FirebaseRemoteConfigServerException(java.lang.String, java.lang.Throwable, com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)"></a><a name="FirebaseRemoteConfigServerException-java.lang.String-java.lang.Throwable-com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code-"></a><a name="firebaseremoteconfigserverexception"></a>
<h3 class="api-name" id="FirebaseRemoteConfigServerException(java.lang.String,java.lang.Throwable,com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)">FirebaseRemoteConfigServerException</h3>
<pre class="api-signature no-pretty-print">public <a href="/docs/reference/android/com/google/firebase/remoteconfig/FirebaseRemoteConfigServerException.html#FirebaseRemoteConfigServerException(java.lang.String,java.lang.Throwable,com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)">FirebaseRemoteConfigServerException</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> detailMessage,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Throwable.html">Throwable</a> cause,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/remoteconfig/FirebaseRemoteConfigException.Code.html">FirebaseRemoteConfigException.Code</a> code<br>)</pre>
- <p>Creates a Firebase Remote Config server exception with the given message, exception cause, and FirebaseRemoteConfigException code.</p>
+ <p>Creates a Firebase Remote Config server exception with the given message, exception cause, and <code>FirebaseRemoteConfigException</code> code.</p>
</div>
<div class="api-item"><a name="FirebaseRemoteConfigServerException(int, java.lang.String, java.lang.Throwable)"></a><a name="FirebaseRemoteConfigServerException-int-java.lang.String-java.lang.Throwable-"></a><a name="firebaseremoteconfigserverexception"></a>
<h3 class="api-name" id="FirebaseRemoteConfigServerException(int,java.lang.String,java.lang.Throwable)">FirebaseRemoteConfigServerException</h3>
@@ -321,12 +323,12 @@
<div class="api-item"><a name="FirebaseRemoteConfigServerException(int, java.lang.String, com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)"></a><a name="FirebaseRemoteConfigServerException-int-java.lang.String-com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code-"></a><a name="firebaseremoteconfigserverexception"></a>
<h3 class="api-name" id="FirebaseRemoteConfigServerException(int,java.lang.String,com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)">FirebaseRemoteConfigServerException</h3>
<pre class="api-signature no-pretty-print">public <a href="/docs/reference/android/com/google/firebase/remoteconfig/FirebaseRemoteConfigServerException.html#FirebaseRemoteConfigServerException(int,java.lang.String,com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)">FirebaseRemoteConfigServerException</a>(<br> int httpStatusCode,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> detailMessage,<br> @<a href="/docs/reference/android/javax/annotation/Nonnull.html">Nonnull</a> <a href="/docs/reference/android/com/google/firebase/remoteconfig/FirebaseRemoteConfigException.Code.html">FirebaseRemoteConfigException.Code</a> code<br>)</pre>
- <p>Creates a Firebase Remote Config server exception with the HTTP status code, given message, and FirebaseRemoteConfigException code.</p>
+ <p>Creates a Firebase Remote Config server exception with the HTTP status code, given message, and <code>FirebaseRemoteConfigException</code> code.</p>
</div>
<div class="api-item"><a name="FirebaseRemoteConfigServerException(int, java.lang.String, java.lang.Throwable, com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)"></a><a name="FirebaseRemoteConfigServerException-int-java.lang.String-java.lang.Throwable-com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code-"></a><a name="firebaseremoteconfigserverexception"></a>
<h3 class="api-name" id="FirebaseRemoteConfigServerException(int,java.lang.String,java.lang.Throwable,com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)">FirebaseRemoteConfigServerException</h3>
<pre class="api-signature no-pretty-print">public <a href="/docs/reference/android/com/google/firebase/remoteconfig/FirebaseRemoteConfigServerException.html#FirebaseRemoteConfigServerException(int,java.lang.String,java.lang.Throwable,com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)">FirebaseRemoteConfigServerException</a>(<br> int httpStatusCode,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> detailMessage,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Throwable.html">Throwable</a> cause,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/remoteconfig/FirebaseRemoteConfigException.Code.html">FirebaseRemoteConfigException.Code</a> code<br>)</pre>
- <p>Creates a Firebase Remote Config server exception with the HTTP status code, given message, exception cause, and FirebaseRemoteConfigException code.</p>
+ <p>Creates a Firebase Remote Config server exception with the HTTP status code, given message, exception cause, and <code>FirebaseRemoteConfigException</code> code.</p>
</div>
</div>
<div class="list">--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/remoteconfig/package-summary.html 2023-03-21 20:59:28.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/remoteconfig/package-summary.html 2023-03-21 20:54:55.000000000 +0000
@@ -17,7 +17,7 @@
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/remoteconfig/ConfigUpdateListener.html">ConfigUpdateListener</a></code></td>
<td>
- <p>Event listener interface for real-time RC updates.</p>
+ <p>Event listener interface for real-time Remote Config updates.</p>
</td>
</tr>
<tr>
@@ -52,7 +52,7 @@
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/remoteconfig/ConfigUpdate.html">ConfigUpdate</a></code></td>
<td>
- <p>Information about the updated config passed to the <code>onUpdate</code> callback of .</p>
+ <p>Information about the updated config passed to <code><a href="/docs/reference/android/com/google/firebase/remoteconfig/ConfigUpdateListener.html#onUpdate(com.google.firebase.remoteconfig.ConfigUpdate)">onUpdate</a></code>.</p>
</td>
</tr>
<tr>--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/remoteconfig/ConfigUpdate.html 2023-03-21 20:59:28.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/remoteconfig/ConfigUpdate.html 2023-03-21 20:54:55.000000000 +0000
@@ -11,7 +11,7 @@
<pre>@<a href="/docs/reference/kotlin/com/google/auto/value/AutoValue.html">AutoValue</a><br>abstract class <a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/ConfigUpdate.html">ConfigUpdate</a></pre>
</p>
<hr>
- <p>Information about the updated config passed to the <code>onUpdate</code> callback of .</p>
+ <p>Information about the updated config passed to <code><a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/ConfigUpdateListener.html#onUpdate(com.google.firebase.remoteconfig.ConfigUpdate)">onUpdate</a></code>.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/remoteconfig/ConfigUpdateListener.html 2023-03-21 20:59:28.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/remoteconfig/ConfigUpdateListener.html 2023-03-21 20:54:55.000000000 +0000
@@ -11,7 +11,7 @@
<pre>interface <a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/ConfigUpdateListener.html">ConfigUpdateListener</a></pre>
</p>
<hr>
- <p>Event listener interface for real-time RC updates. Implement <code>ConfigUpdateListner</code> to call <code><a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/FirebaseRemoteConfig.html#addOnConfigUpdateListener(com.google.firebase.remoteconfig.ConfigUpdateListener)">addOnConfigUpdateListener</a></code>.</p>
+ <p>Event listener interface for real-time Remote Config updates. Implement to call <code><a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/FirebaseRemoteConfig.html#addOnConfigUpdateListener(com.google.firebase.remoteconfig.ConfigUpdateListener)">addOnConfigUpdateListener</a></code>.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -29,14 +29,14 @@
<td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/ConfigUpdateListener.html#onError(com.google.firebase.remoteconfig.FirebaseRemoteConfigException)">onError</a>(@<a href="/docs/reference/kotlin/javax/annotation/Nonnull.html">Nonnull</a> error: <a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/FirebaseRemoteConfigException.html">FirebaseRemoteConfigException</a>!)</code></div>
- <p>Callback for when an error occurs while listening or fetching a config update.</p>
+ <p>Callback for when an error occurs while listening for updates or fetching the latest version of the config.</p>
</td>
</tr>
<tr>
<td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/ConfigUpdateListener.html#onUpdate(com.google.firebase.remoteconfig.ConfigUpdate)">onUpdate</a>(configUpdate: <a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/ConfigUpdate.html">ConfigUpdate</a>)</code></div>
- <p>Callback for when a new config has been automatically fetched from the backend and has changed from the activated config.</p>
+ <p>Callback for when a new config version has been automatically fetched from the backend and has changed from the activated config.</p>
</td>
</tr>
</tbody>
@@ -47,7 +47,7 @@
<div class="api-item"><a name="onError-com.google.firebase.remoteconfig.FirebaseRemoteConfigException-"></a><a name="onerror"></a>
<h3 class="api-name" id="onError(com.google.firebase.remoteconfig.FirebaseRemoteConfigException)">onError</h3>
<pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/ConfigUpdateListener.html#onError(com.google.firebase.remoteconfig.FirebaseRemoteConfigException)">onError</a>(@<a href="/docs/reference/kotlin/javax/annotation/Nonnull.html">Nonnull</a> error: <a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/FirebaseRemoteConfigException.html">FirebaseRemoteConfigException</a>!): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a></pre>
- <p>Callback for when an error occurs while listening or fetching a config update.</p>
+ <p>Callback for when an error occurs while listening for updates or fetching the latest version of the config.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
@@ -73,7 +73,7 @@
<div class="api-item"><a name="onUpdate-com.google.firebase.remoteconfig.ConfigUpdate-"></a><a name="onupdate"></a>
<h3 class="api-name" id="onUpdate(com.google.firebase.remoteconfig.ConfigUpdate)">onUpdate</h3>
<pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/ConfigUpdateListener.html#onUpdate(com.google.firebase.remoteconfig.ConfigUpdate)">onUpdate</a>(configUpdate: <a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/ConfigUpdate.html">ConfigUpdate</a>): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a></pre>
- <p>Callback for when a new config has been automatically fetched from the backend and has changed from the activated config.</p>
+ <p>Callback for when a new config version has been automatically fetched from the backend and has changed from the activated config.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
@@ -89,7 +89,7 @@
<tr>
<td><code>configUpdate: <a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/ConfigUpdate.html">ConfigUpdate</a></code></td>
<td>
- <p>A <code><a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/ConfigUpdate.html">ConfigUpdate</a></code> with information about the updated config, including the set of updated parameters.</p>
+ <p>A <code><a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/ConfigUpdate.html">ConfigUpdate</a></code> with information about the updated config version, including the set of updated parameters.</p>
</td>
</tr>
</tbody>--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/remoteconfig/FirebaseRemoteConfig.html 2023-03-21 20:59:28.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/remoteconfig/FirebaseRemoteConfig.html 2023-03-21 20:54:55.000000000 +0000
@@ -136,7 +136,7 @@
<td><code><a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/ConfigUpdateListenerRegistration.html">ConfigUpdateListenerRegistration</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/FirebaseRemoteConfig.html#addOnConfigUpdateListener(com.google.firebase.remoteconfig.ConfigUpdateListener)">addOnConfigUpdateListener</a>(configUpdateListener: <a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/ConfigUpdateListener.html">ConfigUpdateListener</a>)</code></div>
- <p>Start listening for real-time config updates from the Remote Config backend and automatically fetch updates from the RC backend when they are available.</p>
+ <p>Starts listening for real-time config updates from the Remote Config backend and automatically fetches updates from the RC backend when they are available.</p>
</td>
</tr>
<tr>
@@ -362,9 +362,9 @@
<div class="api-item"><a name="addOnConfigUpdateListener-com.google.firebase.remoteconfig.ConfigUpdateListener-"></a><a name="addonconfigupdatelistener"></a>
<h3 class="api-name" id="addOnConfigUpdateListener(com.google.firebase.remoteconfig.ConfigUpdateListener)">addOnConfigUpdateListener</h3>
<pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/FirebaseRemoteConfig.html#addOnConfigUpdateListener(com.google.firebase.remoteconfig.ConfigUpdateListener)">addOnConfigUpdateListener</a>(configUpdateListener: <a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/ConfigUpdateListener.html">ConfigUpdateListener</a>): <a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/ConfigUpdateListenerRegistration.html">ConfigUpdateListenerRegistration</a></pre>
- <p>Start listening for real-time config updates from the Remote Config backend and automatically fetch updates from the RC backend when they are available. </p>
+ <p>Starts listening for real-time config updates from the Remote Config backend and automatically fetches updates from the RC backend when they are available. </p>
<p>If a connection to the Remote Config backend is not already open, calling this method will open it. Multiple listeners can be added by calling this method again, but subsequent calls re-use the same connection to the backend. </p>
- <p>Note: Real-time Remote Config requires the Firebase Remote Config Realtime API. See the <a href="https://firebase.google.com/docs/remote-config/get-started">Remote Config Get Started </a> guide to enable the API.</p>
+ <p>Note: Real-time Remote Config requires the Firebase Remote Config Realtime API. See the <a href="https://firebase.google.com/docs/remote-config/get-started#add-real-time-listener">Remote Config Get Started </a> guide to enable the API.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
@@ -401,7 +401,8 @@
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/ConfigUpdateListenerRegistration.html">ConfigUpdateListenerRegistration</a></code></td>
<td>
- <p>A <code><a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/ConfigUpdateListenerRegistration.html">ConfigUpdateListenerRegistration</a></code> that allows the user to remove the added <code>configUpdateListener</code> and close the connection when there are no more listeners.</p>
+ <p>A <code><a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/ConfigUpdateListenerRegistration.html">ConfigUpdateListenerRegistration</a></code> that allows you to remove the added <code>
+ configUpdateListener</code> and close the connection when there are no more listeners.</p>
</td>
</tr>
</tbody>--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/remoteconfig/FirebaseRemoteConfigClientException.html 2023-03-21 20:59:28.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/remoteconfig/FirebaseRemoteConfigClientException.html 2023-03-21 20:54:55.000000000 +0000
@@ -85,7 +85,7 @@
<tr>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/FirebaseRemoteConfigClientException.html#FirebaseRemoteConfigClientException(java.lang.String,java.lang.Throwable,com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)">FirebaseRemoteConfigClientException</a>(<br> detailMessage: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>,<br> cause: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html">Throwable</a>?,<br> code: <a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/FirebaseRemoteConfigException.Code.html">FirebaseRemoteConfigException.Code</a><br>)</code></div>
- <p>Creates a Firebase Remote Config client exception with the given message, exception cause, and FirebaseRemoteConfigException code.</p>
+ <p>Creates a Firebase Remote Config client exception with the given message, exception cause, and <code>FirebaseRemoteConfigException</code> code.</p>
</td>
</tr>
</tbody>
@@ -254,7 +254,7 @@
<div class="api-item"><a name="FirebaseRemoteConfigClientException(java.lang.String, java.lang.Throwable, com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)"></a><a name="FirebaseRemoteConfigClientException-java.lang.String-java.lang.Throwable-com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code-"></a><a name="firebaseremoteconfigclientexception"></a>
<h3 class="api-name" id="FirebaseRemoteConfigClientException(java.lang.String,java.lang.Throwable,com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)">FirebaseRemoteConfigClientException</h3>
<pre class="api-signature no-pretty-print"><a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/FirebaseRemoteConfigClientException.html#FirebaseRemoteConfigClientException(java.lang.String,java.lang.Throwable,com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)">FirebaseRemoteConfigClientException</a>(<br> detailMessage: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>,<br> cause: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html">Throwable</a>?,<br> code: <a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/FirebaseRemoteConfigException.Code.html">FirebaseRemoteConfigException.Code</a><br>)</pre>
- <p>Creates a Firebase Remote Config client exception with the given message, exception cause, and FirebaseRemoteConfigException code.</p>
+ <p>Creates a Firebase Remote Config client exception with the given message, exception cause, and <code>FirebaseRemoteConfigException</code> code.</p>
</div>
</div>
</body>--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/remoteconfig/FirebaseRemoteConfigServerException.html 2023-03-21 20:59:28.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/remoteconfig/FirebaseRemoteConfigServerException.html 2023-03-21 20:54:55.000000000 +0000
@@ -67,7 +67,8 @@
<tr>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/FirebaseRemoteConfigServerException.html#FirebaseRemoteConfigServerException(java.lang.String,com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)">FirebaseRemoteConfigServerException</a>(<br> detailMessage: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>,<br> @<a href="/docs/reference/kotlin/javax/annotation/Nonnull.html">Nonnull</a> code: <a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/FirebaseRemoteConfigException.Code.html">FirebaseRemoteConfigException.Code</a>!<br>)</code></div>
- <p>Creates a Firebase Remote Config server exception with the given message and FirebaseRemoteConfigException code.</p>
+ <p>Creates a Firebase Remote Config server exception with the given message and <code>
+FirebaseRemoteConfigException</code> code.</p>
</td>
</tr>
<tr>
@@ -79,7 +80,7 @@
<tr>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/FirebaseRemoteConfigServerException.html#FirebaseRemoteConfigServerException(java.lang.String,java.lang.Throwable,com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)">FirebaseRemoteConfigServerException</a>(<br> detailMessage: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>,<br> cause: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html">Throwable</a>?,<br> code: <a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/FirebaseRemoteConfigException.Code.html">FirebaseRemoteConfigException.Code</a><br>)</code></div>
- <p>Creates a Firebase Remote Config server exception with the given message, exception cause, and FirebaseRemoteConfigException code.</p>
+ <p>Creates a Firebase Remote Config server exception with the given message, exception cause, and <code>FirebaseRemoteConfigException</code> code.</p>
</td>
</tr>
<tr>
@@ -91,13 +92,13 @@
<tr>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/FirebaseRemoteConfigServerException.html#FirebaseRemoteConfigServerException(int,java.lang.String,com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)">FirebaseRemoteConfigServerException</a>(<br> httpStatusCode: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>,<br> detailMessage: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>,<br> @<a href="/docs/reference/kotlin/javax/annotation/Nonnull.html">Nonnull</a> code: <a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/FirebaseRemoteConfigException.Code.html">FirebaseRemoteConfigException.Code</a>!<br>)</code></div>
- <p>Creates a Firebase Remote Config server exception with the HTTP status code, given message, and FirebaseRemoteConfigException code.</p>
+ <p>Creates a Firebase Remote Config server exception with the HTTP status code, given message, and <code>FirebaseRemoteConfigException</code> code.</p>
</td>
</tr>
<tr>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/FirebaseRemoteConfigServerException.html#FirebaseRemoteConfigServerException(int,java.lang.String,java.lang.Throwable,com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)">FirebaseRemoteConfigServerException</a>(<br> httpStatusCode: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>,<br> detailMessage: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>,<br> cause: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html">Throwable</a>?,<br> code: <a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/FirebaseRemoteConfigException.Code.html">FirebaseRemoteConfigException.Code</a><br>)</code></div>
- <p>Creates a Firebase Remote Config server exception with the HTTP status code, given message, exception cause, and FirebaseRemoteConfigException code.</p>
+ <p>Creates a Firebase Remote Config server exception with the HTTP status code, given message, exception cause, and <code>FirebaseRemoteConfigException</code> code.</p>
</td>
</tr>
</tbody>
@@ -272,7 +273,8 @@
<div class="api-item"><a name="FirebaseRemoteConfigServerException(java.lang.String, com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)"></a><a name="FirebaseRemoteConfigServerException-java.lang.String-com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code-"></a><a name="firebaseremoteconfigserverexception"></a>
<h3 class="api-name" id="FirebaseRemoteConfigServerException(java.lang.String,com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)">FirebaseRemoteConfigServerException</h3>
<pre class="api-signature no-pretty-print"><a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/FirebaseRemoteConfigServerException.html#FirebaseRemoteConfigServerException(java.lang.String,com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)">FirebaseRemoteConfigServerException</a>(<br> detailMessage: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>,<br> @<a href="/docs/reference/kotlin/javax/annotation/Nonnull.html">Nonnull</a> code: <a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/FirebaseRemoteConfigException.Code.html">FirebaseRemoteConfigException.Code</a>!<br>)</pre>
- <p>Creates a Firebase Remote Config server exception with the given message and FirebaseRemoteConfigException code.</p>
+ <p>Creates a Firebase Remote Config server exception with the given message and <code>
+FirebaseRemoteConfigException</code> code.</p>
</div>
<div class="api-item"><a name="FirebaseRemoteConfigServerException(int, java.lang.String)"></a><a name="FirebaseRemoteConfigServerException-int-java.lang.String-"></a><a name="firebaseremoteconfigserverexception"></a>
<h3 class="api-name" id="FirebaseRemoteConfigServerException(int,java.lang.String)">FirebaseRemoteConfigServerException</h3>
@@ -282,7 +284,7 @@
<div class="api-item"><a name="FirebaseRemoteConfigServerException(java.lang.String, java.lang.Throwable, com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)"></a><a name="FirebaseRemoteConfigServerException-java.lang.String-java.lang.Throwable-com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code-"></a><a name="firebaseremoteconfigserverexception"></a>
<h3 class="api-name" id="FirebaseRemoteConfigServerException(java.lang.String,java.lang.Throwable,com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)">FirebaseRemoteConfigServerException</h3>
<pre class="api-signature no-pretty-print"><a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/FirebaseRemoteConfigServerException.html#FirebaseRemoteConfigServerException(java.lang.String,java.lang.Throwable,com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)">FirebaseRemoteConfigServerException</a>(<br> detailMessage: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>,<br> cause: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html">Throwable</a>?,<br> code: <a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/FirebaseRemoteConfigException.Code.html">FirebaseRemoteConfigException.Code</a><br>)</pre>
- <p>Creates a Firebase Remote Config server exception with the given message, exception cause, and FirebaseRemoteConfigException code.</p>
+ <p>Creates a Firebase Remote Config server exception with the given message, exception cause, and <code>FirebaseRemoteConfigException</code> code.</p>
</div>
<div class="api-item"><a name="FirebaseRemoteConfigServerException(int, java.lang.String, java.lang.Throwable)"></a><a name="FirebaseRemoteConfigServerException-int-java.lang.String-java.lang.Throwable-"></a><a name="firebaseremoteconfigserverexception"></a>
<h3 class="api-name" id="FirebaseRemoteConfigServerException(int,java.lang.String,java.lang.Throwable)">FirebaseRemoteConfigServerException</h3>
@@ -292,12 +294,12 @@
<div class="api-item"><a name="FirebaseRemoteConfigServerException(int, java.lang.String, com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)"></a><a name="FirebaseRemoteConfigServerException-int-java.lang.String-com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code-"></a><a name="firebaseremoteconfigserverexception"></a>
<h3 class="api-name" id="FirebaseRemoteConfigServerException(int,java.lang.String,com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)">FirebaseRemoteConfigServerException</h3>
<pre class="api-signature no-pretty-print"><a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/FirebaseRemoteConfigServerException.html#FirebaseRemoteConfigServerException(int,java.lang.String,com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)">FirebaseRemoteConfigServerException</a>(<br> httpStatusCode: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>,<br> detailMessage: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>,<br> @<a href="/docs/reference/kotlin/javax/annotation/Nonnull.html">Nonnull</a> code: <a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/FirebaseRemoteConfigException.Code.html">FirebaseRemoteConfigException.Code</a>!<br>)</pre>
- <p>Creates a Firebase Remote Config server exception with the HTTP status code, given message, and FirebaseRemoteConfigException code.</p>
+ <p>Creates a Firebase Remote Config server exception with the HTTP status code, given message, and <code>FirebaseRemoteConfigException</code> code.</p>
</div>
<div class="api-item"><a name="FirebaseRemoteConfigServerException(int, java.lang.String, java.lang.Throwable, com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)"></a><a name="FirebaseRemoteConfigServerException-int-java.lang.String-java.lang.Throwable-com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code-"></a><a name="firebaseremoteconfigserverexception"></a>
<h3 class="api-name" id="FirebaseRemoteConfigServerException(int,java.lang.String,java.lang.Throwable,com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)">FirebaseRemoteConfigServerException</h3>
<pre class="api-signature no-pretty-print"><a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/FirebaseRemoteConfigServerException.html#FirebaseRemoteConfigServerException(int,java.lang.String,java.lang.Throwable,com.google.firebase.remoteconfig.FirebaseRemoteConfigException.Code)">FirebaseRemoteConfigServerException</a>(<br> httpStatusCode: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>,<br> detailMessage: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>,<br> cause: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html">Throwable</a>?,<br> code: <a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/FirebaseRemoteConfigException.Code.html">FirebaseRemoteConfigException.Code</a><br>)</pre>
- <p>Creates a Firebase Remote Config server exception with the HTTP status code, given message, exception cause, and FirebaseRemoteConfigException code.</p>
+ <p>Creates a Firebase Remote Config server exception with the HTTP status code, given message, exception cause, and <code>FirebaseRemoteConfigException</code> code.</p>
</div>
</div>
<div class="list">--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/remoteconfig/package-summary.html 2023-03-21 20:59:28.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/remoteconfig/package-summary.html 2023-03-21 20:54:55.000000000 +0000
@@ -17,7 +17,7 @@
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/ConfigUpdateListener.html">ConfigUpdateListener</a></code></td>
<td>
- <p>Event listener interface for real-time RC updates.</p>
+ <p>Event listener interface for real-time Remote Config updates.</p>
</td>
</tr>
<tr>
@@ -52,7 +52,7 @@
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/ConfigUpdate.html">ConfigUpdate</a></code></td>
<td>
- <p>Information about the updated config passed to the <code>onUpdate</code> callback of .</p>
+ <p>Information about the updated config passed to <code><a href="/docs/reference/kotlin/com/google/firebase/remoteconfig/ConfigUpdateListener.html#onUpdate(com.google.firebase.remoteconfig.ConfigUpdate)">onUpdate</a></code>.</p>
</td>
</tr>
<tr> |
📝 PRs merging into main branchOur main branch should always be in a releasable state. If you are working on a larger change, or if you don't want this change to see the light of the day just yet, consider using a feature branch first, and only merge into the main branch when the code complete and ready to be released. Add the 'main-merge-ack' label to your PR to confirm merging into the main branch is intended. |
Coverage Report 1Affected ProductsNo changes between base commit (71772b3) and merge commit (ce790e6).Test Logs |
Unit Test Results 28 files - 12 28 suites - 12 1m 30s ⏱️ -54s Results for commit fa5be75. ± Comparison against base commit 71772b3. This pull request removes 203 and adds 276 tests. Note that renamed tests count towards both.♻️ This comment has been updated with latest results. |
Size Report 1Affected ProductsTest Logs |
Startup Time Report 1Note: Layout is sometimes suboptimal due to limited formatting support on GitHub. Please check this report on GCS. Notes
Startup Times
|
qdpham13
approved these changes
Mar 21, 2023
firebase-config/src/main/java/com/google/firebase/remoteconfig/ConfigUpdateListener.java
Outdated
Show resolved
Hide resolved
emilypgoogle
pushed a commit
that referenced
this pull request
Mar 23, 2023
* Improve real-time reference docs. * Change 'the user' to 'you'. * Separate listening and fetching.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Internal b/274648602.