Adjust Functions Kotlin docs for release #6449
Open
Conversation
This file contains 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:--- /home/runner/diff/original/firebase-kotlindoc/android/client/firebase-functions/_toc.yaml 2024-11-08 21:51:52.932204164 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/client/firebase-functions/_toc.yaml 2024-11-08 21:49:20.784392571 +0000
@@ -10,8 +10,6 @@
path: "/docs/reference/android/com/google/firebase/functions/FirebaseFunctions.html"
- title: "FunctionsKt"
path: "/docs/reference/android/com/google/firebase/functions/FunctionsKt.html"
- - title: "HttpsCallOptions"
- path: "/docs/reference/android/com/google/firebase/functions/HttpsCallOptions.html"
- title: "HttpsCallableOptions"
path: "/docs/reference/android/com/google/firebase/functions/HttpsCallableOptions.html"
- title: "HttpsCallableOptions.Builder"
@@ -20,8 +18,6 @@
path: "/docs/reference/android/com/google/firebase/functions/HttpsCallableReference.html"
- title: "HttpsCallableResult"
path: "/docs/reference/android/com/google/firebase/functions/HttpsCallableResult.html"
- - title: "Serializer"
- path: "/docs/reference/android/com/google/firebase/functions/Serializer.html"
- title: "Enums"
--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/functions/FirebaseFunctions.html 2024-11-08 21:51:52.932204164 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/functions/FirebaseFunctions.html 2024-11-08 21:49:20.796392558 +0000
@@ -112,7 +112,7 @@
<td><code>final void</code></td>
<td>
<div><code><span><del><a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctions.html#useFunctionsEmulator(kotlin.String)">useFunctionsEmulator</a></del></span>(@<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> origin)</code></div>
- <p><strong>This method is deprecated.</strong> Use {@link #useEmulator(String, int)} to connect to the emulator.</p>
+ <p><strong>This method is deprecated.</strong> Use useEmulator to connect to the emulator.</p>
</td>
</tr>
</tbody>
@@ -308,7 +308,7 @@
<div class="api-item"><a name="useFunctionsEmulator-kotlin.String-"></a><a name="usefunctionsemulator"></a>
<h3 class="api-name" id="useFunctionsEmulator(kotlin.String)">useFunctionsEmulator</h3>
<pre class="api-signature no-pretty-print">public final void <span><del><a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctions.html#useFunctionsEmulator(kotlin.String)">useFunctionsEmulator</a></del></span>(@<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> origin)</pre>
- <aside class="caution"><strong>This method is deprecated.</strong><br>Use {@link #useEmulator(String, int)} to connect to the emulator. </aside>
+ <aside class="caution"><strong>This method is deprecated.</strong><br>Use useEmulator to connect to the emulator.</aside>
</div>
</div>
<div class="list">--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/functions/FirebaseFunctionsException.Code.Companion.html 2024-11-08 21:51:52.932204164 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/functions/FirebaseFunctionsException.Code.Companion.html 2024-11-08 21:49:20.796392558 +0000
@@ -28,7 +28,7 @@
<td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctionsException.Code.html">FirebaseFunctionsException.Code</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctionsException.Code.Companion.html#fromHttpStatus(kotlin.Int)">fromHttpStatus</a>(int status)</code></div>
- <p>Takes an HTTP status code and returns the corresponding FUNErrorCode error code.</p>
+ <p>Takes an HTTP status code and returns the corresponding <code><a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctionsException.Code.html">Code</a></code> error code.</p>
</td>
</tr>
<tr>
@@ -45,7 +45,7 @@
<div class="api-item"><a name="fromHttpStatus-kotlin.Int-"></a><a name="fromhttpstatus"></a>
<h3 class="api-name" id="fromHttpStatus(kotlin.Int)">fromHttpStatus</h3>
<pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctionsException.Code.html">FirebaseFunctionsException.Code</a> <a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctionsException.Code.Companion.html#fromHttpStatus(kotlin.Int)">fromHttpStatus</a>(int status)</pre>
- <p>Takes an HTTP status code and returns the corresponding FUNErrorCode error code. This is the standard HTTP status code -> error mapping defined in: https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto</p>
+ <p>Takes an HTTP status code and returns the corresponding <code><a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctionsException.Code.html">Code</a></code> error code. This is the standard HTTP status code -> error mapping defined in: https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
@@ -82,7 +82,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/functions/FirebaseFunctionsException.Code.html">FirebaseFunctionsException.Code</a></code></td>
<td>
- <p>The corresponding Code, or Code.UNKNOWN if none.</p>
+ <p>The corresponding <code>Code</code>, or <code>Code.UNKNOWN</code> if none.</p>
</td>
</tr>
</tbody>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/functions/FirebaseFunctionsException.Code.html 2024-11-08 21:51:52.932204164 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/functions/FirebaseFunctionsException.Code.html 2024-11-08 21:49:20.796392558 +0000
@@ -184,7 +184,7 @@
<td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctionsException.Code.html">FirebaseFunctionsException.Code</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctionsException.Code.Companion.html#fromHttpStatus(kotlin.Int)">fromHttpStatus</a>(int status)</code></div>
- <p>Takes an HTTP status code and returns the corresponding FUNErrorCode error code.</p>
+ <p>Takes an HTTP status code and returns the corresponding <code><a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctionsException.Code.html">Code</a></code> error code.</p>
</td>
</tr>
<tr>
@@ -250,7 +250,7 @@
<div class="api-item">
<h3 class="api-name" id="INVALID_ARGUMENT">INVALID_ARGUMENT</h3>
<pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctionsException.Code.html">FirebaseFunctionsException.Code</a> <a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctionsException.Code.html#INVALID_ARGUMENT">FirebaseFunctionsException.Code.INVALID_ARGUMENT</a></pre>
- <p>Client specified an invalid argument. Note that this differs from FAILED_PRECONDITION. INVALID_ARGUMENT indicates arguments that are problematic regardless of the state of the system (e.g., an invalid field name).</p>
+ <p>Client specified an invalid argument. Note that this differs from <code>FAILED_PRECONDITION</code>. <code>INVALID_ARGUMENT</code> indicates arguments that are problematic regardless of the state of the system (For example, an invalid field name).</p>
</div>
<div class="api-item">
<h3 class="api-name" id="NOT_FOUND">NOT_FOUND</h3>
@@ -260,7 +260,7 @@
<div class="api-item">
<h3 class="api-name" id="OK">OK</h3>
<pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctionsException.Code.html">FirebaseFunctionsException.Code</a> <a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctionsException.Code.html#OK">FirebaseFunctionsException.Code.OK</a></pre>
- <p>The operation completed successfully. FirebaseFunctionsException will never have a status of OK.</p>
+ <p>The operation completed successfully. <code>FirebaseFunctionsException</code> will never have a status of <code>OK</code>.</p>
</div>
<div class="api-item">
<h3 class="api-name" id="OUT_OF_RANGE">OUT_OF_RANGE</h3>
@@ -303,7 +303,7 @@
<div class="api-item"><a name="fromHttpStatus-kotlin.Int-"></a><a name="fromhttpstatus"></a>
<h3 class="api-name" id="fromHttpStatus(kotlin.Int)">fromHttpStatus</h3>
<pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctionsException.Code.html">FirebaseFunctionsException.Code</a> <a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctionsException.Code.Companion.html#fromHttpStatus(kotlin.Int)">fromHttpStatus</a>(int status)</pre>
- <p>Takes an HTTP status code and returns the corresponding FUNErrorCode error code. This is the standard HTTP status code -> error mapping defined in: https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto</p>
+ <p>Takes an HTTP status code and returns the corresponding <code><a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctionsException.Code.html">Code</a></code> error code. This is the standard HTTP status code -> error mapping defined in: https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
@@ -340,7 +340,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/functions/FirebaseFunctionsException.Code.html">FirebaseFunctionsException.Code</a></code></td>
<td>
- <p>The corresponding Code, or Code.UNKNOWN if none.</p>
+ <p>The corresponding <code>Code</code>, or <code>Code.UNKNOWN</code> if none.</p>
</td>
</tr>
</tbody>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/functions/FirebaseFunctionsException.Companion.html 2024-11-08 21:51:52.932204164 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/functions/FirebaseFunctionsException.Companion.html 1970-01-01 00:00:00.000000000 +0000
@@ -1,101 +0,0 @@
-<html devsite="true">
- <head>
- <title>FirebaseFunctionsException.Companion</title>
-{% setvar book_path %}/_book.yaml{% endsetvar %}
-{% include "docs/reference/android/_reference-head-tags.html" %}
- </head>
- <body>
- <div id="metadata-info-block"></div>
- <h1>FirebaseFunctionsException.Companion</h1>
- <p>
- <pre>public static class <a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctionsException.Companion.html">FirebaseFunctionsException.Companion</a></pre>
- </p>
- <hr>
- <h2>Summary</h2>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%"><h3>Public methods</h3></th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>static final <a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctionsException.html">FirebaseFunctionsException</a></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctionsException.Companion.html#fromResponse(com.google.firebase.functions.FirebaseFunctionsException.Code,kotlin.String,com.google.firebase.functions.Serializer)">fromResponse</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctionsException.Code.html">FirebaseFunctionsException.Code</a> code,<br> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> body,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/functions/Serializer.html">Serializer</a> serializer<br>)</code></div>
- <p>Takes an HTTP response and returns the corresponding Exception if any.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="list">
- <h2>Public methods</h2>
- <div class="api-item"><a name="fromResponse(com.google.firebase.functions.FirebaseFunctionsException.Code, kotlin.String, com.google.firebase.functions.Serializer)"></a><a name="fromResponse-com.google.firebase.functions.FirebaseFunctionsException.Code-kotlin.String-com.google.firebase.functions.Serializer-"></a><a name="fromresponse"></a>
- <h3 class="api-name" id="fromResponse(com.google.firebase.functions.FirebaseFunctionsException.Code,kotlin.String,com.google.firebase.functions.Serializer)">fromResponse</h3>
- <pre class="api-signature no-pretty-print">public static final <a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctionsException.html">FirebaseFunctionsException</a> <a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctionsException.Companion.html#fromResponse(com.google.firebase.functions.FirebaseFunctionsException.Code,kotlin.String,com.google.firebase.functions.Serializer)">fromResponse</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctionsException.Code.html">FirebaseFunctionsException.Code</a> code,<br> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> body,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/functions/Serializer.html">Serializer</a> serializer<br>)</pre>
- <p>Takes an HTTP response and returns the corresponding Exception if any.</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Parameters</th>
- </tr>
- </thead>
- <tbody class="list">
- <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/functions/FirebaseFunctionsException.Code.html">FirebaseFunctionsException.Code</a> code</code></td>
- <td>
- <p>An HTTP status code.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> body</code></td>
- <td>
- <p>The body of the HTTP response, if any.</p>
- </td>
- </tr>
- <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/functions/Serializer.html">Serializer</a> serializer</code></td>
- <td>
- <p>A serializer to use for decoding error details.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Returns</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctionsException.html">FirebaseFunctionsException</a></code></td>
- <td>
- <p>The corresponding Exception, or null if none.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- </div>
- </body>
-</html>
---- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/functions/FirebaseFunctionsException.html 2024-11-08 21:51:52.932204164 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/functions/FirebaseFunctionsException.html 2024-11-08 21:49:20.796392558 +0000
@@ -67,11 +67,6 @@
<div><code>public static class <a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctionsException.Code.Companion.html">FirebaseFunctionsException.Code.Companion</a></code></div>
</td>
</tr>
- <tr>
- <td>
- <div><code>public static class <a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctionsException.Companion.html">FirebaseFunctionsException.Companion</a></code></div>
- </td>
- </tr>
</tbody>
</table>
</div>
@@ -105,28 +100,6 @@
</table>
</div>
<div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%"><h3>Public methods</h3></th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>static final <a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctionsException.html">FirebaseFunctionsException</a></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctionsException.Companion.html#fromResponse(com.google.firebase.functions.FirebaseFunctionsException.Code,kotlin.String,com.google.firebase.functions.Serializer)">fromResponse</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctionsException.Code.html">FirebaseFunctionsException.Code</a> code,<br> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> body,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/functions/Serializer.html">Serializer</a> serializer<br>)</code></div>
- <p>Takes an HTTP response and returns the corresponding Exception if any.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="devsite-table-wrapper">
<table class="responsive" id="inhmethods">
<thead>
<tr>
@@ -269,7 +242,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/functions/FirebaseFunctionsException.Code.html">FirebaseFunctionsException.Code</a></code></td>
<td>
- <p>the code for the FirebaseFunctionsException</p>
+ <p>the code for the <code>FirebaseFunctionsException</code></p>
</td>
</tr>
</tbody>
@@ -299,68 +272,6 @@
</td>
</tr>
</tbody>
- </table>
- </div>
- </div>
- </div>
- <div class="list">
- <h2>Public methods</h2>
- <div class="api-item"><a name="fromResponse(com.google.firebase.functions.FirebaseFunctionsException.Code, kotlin.String, com.google.firebase.functions.Serializer)"></a><a name="fromResponse-com.google.firebase.functions.FirebaseFunctionsException.Code-kotlin.String-com.google.firebase.functions.Serializer-"></a><a name="fromresponse"></a>
- <h3 class="api-name" id="fromResponse(com.google.firebase.functions.FirebaseFunctionsException.Code,kotlin.String,com.google.firebase.functions.Serializer)">fromResponse</h3>
- <pre class="api-signature no-pretty-print">public static final <a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctionsException.html">FirebaseFunctionsException</a> <a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctionsException.Companion.html#fromResponse(com.google.firebase.functions.FirebaseFunctionsException.Code,kotlin.String,com.google.firebase.functions.Serializer)">fromResponse</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctionsException.Code.html">FirebaseFunctionsException.Code</a> code,<br> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> body,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/functions/Serializer.html">Serializer</a> serializer<br>)</pre>
- <p>Takes an HTTP response and returns the corresponding Exception if any.</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Parameters</th>
- </tr>
- </thead>
- <tbody class="list">
- <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/functions/FirebaseFunctionsException.Code.html">FirebaseFunctionsException.Code</a> code</code></td>
- <td>
- <p>An HTTP status code.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> body</code></td>
- <td>
- <p>The body of the HTTP response, if any.</p>
- </td>
- </tr>
- <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/functions/Serializer.html">Serializer</a> serializer</code></td>
- <td>
- <p>A serializer to use for decoding error details.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Returns</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctionsException.html">FirebaseFunctionsException</a></code></td>
- <td>
- <p>The corresponding Exception, or null if none.</p>
- </td>
- </tr>
- </tbody>
</table>
</div>
</div>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/functions/HttpsCallOptions.html 2024-11-08 21:51:52.932204164 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/functions/HttpsCallOptions.html 1970-01-01 00:00:00.000000000 +0000
@@ -1,196 +0,0 @@
-<html devsite="true">
- <head>
- <title>HttpsCallOptions</title>
-{% setvar book_path %}/_book.yaml{% endsetvar %}
-{% include "docs/reference/android/_reference-head-tags.html" %}
- </head>
- <body>
- <div id="metadata-info-block"></div>
- <h1>HttpsCallOptions</h1>
- <p>
- <pre>public final class <a href="/docs/reference/android/com/google/firebase/functions/HttpsCallOptions.html">HttpsCallOptions</a></pre>
- </p>
- <hr>
- <p>An internal class for keeping track of options applied to an HttpsCallableReference.</p>
- <h2>Summary</h2>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%"><h3>Public fields</h3></th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>final boolean</code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/functions/HttpsCallOptions.html#limitedUseAppCheckTokens()">limitedUseAppCheckTokens</a></code></div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%"><h3>Public constructors</h3></th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/functions/HttpsCallOptions.html#HttpsCallOptions()">HttpsCallOptions</a>()</code></div>
- </td>
- </tr>
- <tr>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/functions/HttpsCallOptions.html#HttpsCallOptions(com.google.firebase.functions.HttpsCallableOptions)">HttpsCallOptions</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/functions/HttpsCallableOptions.html">HttpsCallableOptions</a> publicCallableOptions)</code></div>
- <p>Creates an (internal) HttpsCallOptions from the (external) <code><a href="/docs/reference/android/com/google/firebase/functions/HttpsCallableOptions.html">HttpsCallableOptions</a></code>.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%"><h3>Public methods</h3></th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/okhttp3/OkHttpClient.html">OkHttpClient</a></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/functions/HttpsCallOptions.html#apply(okhttp3.OkHttpClient)">apply</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/okhttp3/OkHttpClient.html">OkHttpClient</a> client)</code></div>
- <p>Creates a new OkHttpClient with these options applied to it.</p>
- </td>
- </tr>
- <tr>
- <td><code>final boolean</code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/functions/HttpsCallOptions.html#getLimitedUseAppCheckTokens()">getLimitedUseAppCheckTokens</a>()</code></div>
- </td>
- </tr>
- <tr>
- <td><code>final long</code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/functions/HttpsCallOptions.html#getTimeout()">getTimeout</a>()</code></div>
- <p>Returns the timeout for calls from this instance of Functions.</p>
- </td>
- </tr>
- <tr>
- <td><code>final void</code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/functions/HttpsCallOptions.html#setTimeout(kotlin.Long,java.util.concurrent.TimeUnit)">setTimeout</a>(long timeout, @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/concurrent/TimeUnit.html">TimeUnit</a> units)</code></div>
- <p>Changes the timeout for calls from this instance of Functions.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="list">
- <h2>Public fields</h2>
- <div class="api-item"><a name="getLimitedUseAppCheckTokens()"></a><a name="setLimitedUseAppCheckTokens()"></a><a name="getLimitedUseAppCheckTokens--"></a><a name="setLimitedUseAppCheckTokens--"></a>
- <h3 class="api-name" id="limitedUseAppCheckTokens()">limitedUseAppCheckTokens</h3>
- <pre class="api-signature no-pretty-print">public final boolean <a href="/docs/reference/android/com/google/firebase/functions/HttpsCallOptions.html#limitedUseAppCheckTokens()">limitedUseAppCheckTokens</a></pre>
- </div>
- </div>
- <div class="list">
- <h2>Public constructors</h2>
- <div class="api-item"><a name="HttpsCallOptions--"></a><a name="httpscalloptions"></a>
- <h3 class="api-name" id="HttpsCallOptions()">HttpsCallOptions</h3>
- <pre class="api-signature no-pretty-print">public <a href="/docs/reference/android/com/google/firebase/functions/HttpsCallOptions.html#HttpsCallOptions()">HttpsCallOptions</a>()</pre>
- </div>
- <div class="api-item"><a name="HttpsCallOptions-com.google.firebase.functions.HttpsCallableOptions-"></a><a name="httpscalloptions"></a>
- <h3 class="api-name" id="HttpsCallOptions(com.google.firebase.functions.HttpsCallableOptions)">HttpsCallOptions</h3>
- <pre class="api-signature no-pretty-print">public <a href="/docs/reference/android/com/google/firebase/functions/HttpsCallOptions.html#HttpsCallOptions(com.google.firebase.functions.HttpsCallableOptions)">HttpsCallOptions</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/functions/HttpsCallableOptions.html">HttpsCallableOptions</a> publicCallableOptions)</pre>
- <p>Creates an (internal) HttpsCallOptions from the (external) <code><a href="/docs/reference/android/com/google/firebase/functions/HttpsCallableOptions.html">HttpsCallableOptions</a></code>.</p>
- </div>
- </div>
- <div class="list">
- <h2>Public methods</h2>
- <div class="api-item"><a name="apply-okhttp3.OkHttpClient-"></a><a name="apply"></a>
- <h3 class="api-name" id="apply(okhttp3.OkHttpClient)">apply</h3>
- <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/okhttp3/OkHttpClient.html">OkHttpClient</a> <a href="/docs/reference/android/com/google/firebase/functions/HttpsCallOptions.html#apply(okhttp3.OkHttpClient)">apply</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/okhttp3/OkHttpClient.html">OkHttpClient</a> client)</pre>
- <p>Creates a new OkHttpClient with these options applied to it.</p>
- </div>
- <div class="api-item"><a name="getLimitedUseAppCheckTokens--"></a><a name="getlimiteduseappchecktokens"></a>
- <h3 class="api-name" id="getLimitedUseAppCheckTokens()">getLimitedUseAppCheckTokens</h3>
- <pre class="api-signature no-pretty-print">public final boolean <a href="/docs/reference/android/com/google/firebase/functions/HttpsCallOptions.html#getLimitedUseAppCheckTokens()">getLimitedUseAppCheckTokens</a>()</pre>
- </div>
- <div class="api-item"><a name="getTimeout--"></a><a name="gettimeout"></a>
- <h3 class="api-name" id="getTimeout()">getTimeout</h3>
- <pre class="api-signature no-pretty-print">public final long <a href="/docs/reference/android/com/google/firebase/functions/HttpsCallOptions.html#getTimeout()">getTimeout</a>()</pre>
- <p>Returns the timeout for calls from this instance of Functions.</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Returns</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>long</code></td>
- <td>
- <p>The timeout, in milliseconds.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="setTimeout(kotlin.Long, java.util.concurrent.TimeUnit)"></a><a name="setTimeout-kotlin.Long-java.util.concurrent.TimeUnit-"></a><a name="settimeout"></a>
- <h3 class="api-name" id="setTimeout(kotlin.Long,java.util.concurrent.TimeUnit)">setTimeout</h3>
- <pre class="api-signature no-pretty-print">public final void <a href="/docs/reference/android/com/google/firebase/functions/HttpsCallOptions.html#setTimeout(kotlin.Long,java.util.concurrent.TimeUnit)">setTimeout</a>(long timeout, @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/concurrent/TimeUnit.html">TimeUnit</a> units)</pre>
- <p>Changes the timeout for calls from this instance of Functions. The default is 60 seconds.</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Parameters</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>long timeout</code></td>
- <td>
- <p>The length of the timeout, in the given units.</p>
- </td>
- </tr>
- <tr>
- <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/concurrent/TimeUnit.html">TimeUnit</a> units</code></td>
- <td>
- <p>The units for the specified timeout.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- </div>
- </body>
-</html>
---- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/functions/HttpsCallableOptions.Builder.html 2024-11-08 21:51:52.932204164 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/functions/HttpsCallableOptions.Builder.html 2024-11-08 21:49:20.796392558 +0000
@@ -11,7 +11,7 @@
<pre>public final class <a href="/docs/reference/android/com/google/firebase/functions/HttpsCallableOptions.Builder.html">HttpsCallableOptions.Builder</a></pre>
</p>
<hr>
- <p>Builder class for <code><a href="/docs/reference/android/com/google/firebase/functions/HttpsCallableOptions.html">com.google.firebase.functions.HttpsCallableOptions</a></code></p>
+ <p>A builder for creating <code><a href="/docs/reference/android/com/google/firebase/functions/HttpsCallableOptions.html">com.google.firebase.functions.HttpsCallableOptions</a></code>.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/functions/HttpsCallableOptions.html 2024-11-08 21:51:52.932204164 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/functions/HttpsCallableOptions.html 2024-11-08 21:49:20.796392558 +0000
@@ -29,7 +29,7 @@
<tr>
<td>
<div><code>public final class <a href="/docs/reference/android/com/google/firebase/functions/HttpsCallableOptions.Builder.html">HttpsCallableOptions.Builder</a></code></div>
- <p>Builder class for <code><a href="/docs/reference/android/com/google/firebase/functions/HttpsCallableOptions.html">com.google.firebase.functions.HttpsCallableOptions</a></code></p>
+ <p>A builder for creating <code><a href="/docs/reference/android/com/google/firebase/functions/HttpsCallableOptions.html">com.google.firebase.functions.HttpsCallableOptions</a></code>.</p>
</td>
</tr>
</tbody>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/functions/HttpsCallableReference.html 2024-11-08 21:51:52.932204164 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/functions/HttpsCallableReference.html 2024-11-08 21:49:20.796392558 +0000
@@ -91,7 +91,7 @@
<pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developers.google.com/android/reference/com/google/android/gms/tasks/Task.html">Task</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/functions/HttpsCallableResult.html">HttpsCallableResult</a>> <a href="/docs/reference/android/com/google/firebase/functions/HttpsCallableReference.html#call()">call</a>()</pre>
<p>Executes this HTTPS endpoint asynchronously without arguments.</p>
<p>The request to the Cloud Functions backend made by this method automatically includes a Firebase Instance ID token to identify the app instance. If a user is logged in with Firebase Auth, an auth token for the user will also be automatically included.</p>
- <p>Firebase Instance ID sends data to the Firebase backend periodically to collect information regarding the app instance. To stop this, see <code><a href="/docs/reference/android/com/google/firebase/iid/FirebaseInstanceId.html#deleteInstanceId()"> </a></code>. It will resume with a new Instance ID the next time you call this method.</p>
+ <p>Firebase Instance ID sends data to the Firebase backend periodically to collect information regarding the app instance. To stop this, see <code><a href="/docs/reference/android/com/google/firebase/iid/FirebaseInstanceId.html#deleteInstanceId()">com.google.firebase.iid.FirebaseInstanceId.deleteInstanceId</a></code>. It will resume with a new Instance ID the next time you call this method.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
@@ -164,7 +164,7 @@
</li>
</ul>
<p>The request to the Cloud Functions backend made by this method automatically includes a Firebase Instance ID token to identify the app instance. If a user is logged in with Firebase Auth, an auth token for the user will also be automatically included.</p>
- <p>Firebase Instance ID sends data to the Firebase backend periodically to collect information regarding the app instance. To stop this, see <code><a href="/docs/reference/android/com/google/firebase/iid/FirebaseInstanceId.html#deleteInstanceId()"> </a></code>. It will resume with a new Instance ID the next time you call this method.</p>
+ <p>Firebase Instance ID sends data to the Firebase backend periodically to collect information regarding the app instance. To stop this, see <code><a href="/docs/reference/android/com/google/firebase/iid/FirebaseInstanceId.html#deleteInstanceId()">com.google.firebase.iid.FirebaseInstanceId.deleteInstanceId</a></code>. It will resume with a new Instance ID the next time you call this method.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/functions/HttpsCallableResult.html 2024-11-08 21:51:52.932204164 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/functions/HttpsCallableResult.html 2024-11-08 21:49:20.796392558 +0000
@@ -11,7 +11,7 @@
<pre>public final class <a href="/docs/reference/android/com/google/firebase/functions/HttpsCallableResult.html">HttpsCallableResult</a></pre>
</p>
<hr>
- <p>The result of calling a HttpsCallableReference function.</p>
+ <p>The result of calling a <code>HttpsCallableReference</code> function.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -41,7 +41,7 @@
<h3 class="api-name" id="getData()">getData</h3>
<pre class="api-signature no-pretty-print">public final <a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">Object</a> <a href="/docs/reference/android/com/google/firebase/functions/HttpsCallableResult.html#getData()">getData</a>()</pre>
<p>Returns the data that was returned from the Callable HTTPS trigger.</p>
- <p>The data is in the form of native Java objects. For example, if your trigger returned an array, this object would be a List<Object>. If your trigger returned a JavaScript object with keys and values, this object would be a Map.</p>
+ <p>The data is in the form of native Java objects. For example, if your trigger returned an array, this object would be a <code>List<Object></code>. If your trigger returned a JavaScript object with keys and values, this object would be a <code>Map<String, Object></code>.</p>
</div>
</div>
</body>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/functions/Serializer.Companion.html 2024-11-08 21:51:52.932204164 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/functions/Serializer.Companion.html 1970-01-01 00:00:00.000000000 +0000
@@ -1,16 +0,0 @@
-<html devsite="true">
- <head>
- <title>Serializer.Companion</title>
-{% setvar book_path %}/_book.yaml{% endsetvar %}
-{% include "docs/reference/android/_reference-head-tags.html" %}
- </head>
- <body>
- <div id="metadata-info-block"></div>
- <h1>Serializer.Companion</h1>
- <p>
- <pre>public static class <a href="/docs/reference/android/com/google/firebase/functions/Serializer.Companion.html">Serializer.Companion</a></pre>
- </p>
- <hr>
- </body>
-</html>
---- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/functions/Serializer.html 2024-11-08 21:51:52.932204164 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/functions/Serializer.html 1970-01-01 00:00:00.000000000 +0000
@@ -1,103 +0,0 @@
-<html devsite="true">
- <head>
- <title>Serializer</title>
-{% setvar book_path %}/_book.yaml{% endsetvar %}
-{% include "docs/reference/android/_reference-head-tags.html" %}
- </head>
- <body>
- <div id="metadata-info-block"></div>
- <h1>Serializer</h1>
- <p>
- <pre>public final class <a href="/docs/reference/android/com/google/firebase/functions/Serializer.html">Serializer</a></pre>
- </p>
- <hr>
- <p>Converts raw Java types into JSON objects.</p>
- <h2>Summary</h2>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%"><h3>Nested types</h3></th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td>
- <div><code>public static class <a href="/docs/reference/android/com/google/firebase/functions/Serializer.Companion.html">Serializer.Companion</a></code></div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%"><h3>Public constructors</h3></th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/functions/Serializer.html#Serializer()">Serializer</a>()</code></div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%"><h3>Public methods</h3></th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>final <a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">Object</a></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/functions/Serializer.html#decode(kotlin.Any)">decode</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">Object</a> obj)</code></div>
- </td>
- </tr>
- <tr>
- <td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">Object</a></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/functions/Serializer.html#encode(kotlin.Any)">encode</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">Object</a> obj)</code></div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="list">
- <h2>Public constructors</h2>
- <div class="api-item"><a name="Serializer--"></a><a name="serializer"></a>
- <h3 class="api-name" id="Serializer()">Serializer</h3>
- <pre class="api-signature no-pretty-print">public <a href="/docs/reference/android/com/google/firebase/functions/Serializer.html#Serializer()">Serializer</a>()</pre>
- </div>
- </div>
- <div class="list">
- <h2>Public methods</h2>
- <div class="api-item"><a name="decode-kotlin.Any-"></a><a name="decode"></a>
- <h3 class="api-name" id="decode(kotlin.Any)">decode</h3>
- <pre class="api-signature no-pretty-print">public final <a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">Object</a> <a href="/docs/reference/android/com/google/firebase/functions/Serializer.html#decode(kotlin.Any)">decode</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">Object</a> obj)</pre>
- </div>
- <div class="api-item"><a name="encode-kotlin.Any-"></a><a name="encode"></a>
- <h3 class="api-name" id="encode(kotlin.Any)">encode</h3>
- <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">Object</a> <a href="/docs/reference/android/com/google/firebase/functions/Serializer.html#encode(kotlin.Any)">encode</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">Object</a> obj)</pre>
- </div>
- </div>
- </body>
-</html>
---- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/functions/package-summary.html 2024-11-08 21:51:52.932204164 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/functions/package-summary.html 2024-11-08 21:49:20.796392558 +0000
@@ -25,12 +25,6 @@
<td></td>
</tr>
<tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/functions/HttpsCallOptions.html">HttpsCallOptions</a></code></td>
- <td>
- <p>An internal class for keeping track of options applied to an HttpsCallableReference.</p>
- </td>
- </tr>
- <tr>
<td><code><a href="/docs/reference/android/com/google/firebase/functions/HttpsCallableOptions.html">HttpsCallableOptions</a></code></td>
<td>
<p>Options for configuring the callable function.</p>
@@ -39,7 +33,7 @@
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/functions/HttpsCallableOptions.Builder.html">HttpsCallableOptions.Builder</a></code></td>
<td>
- <p>Builder class for <code><a href="/docs/reference/android/com/google/firebase/functions/HttpsCallableOptions.html">com.google.firebase.functions.HttpsCallableOptions</a></code></p>
+ <p>A builder for creating <code><a href="/docs/reference/android/com/google/firebase/functions/HttpsCallableOptions.html">com.google.firebase.functions.HttpsCallableOptions</a></code>.</p>
</td>
</tr>
<tr>
@@ -51,13 +45,7 @@
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/functions/HttpsCallableResult.html">HttpsCallableResult</a></code></td>
<td>
- <p>The result of calling a HttpsCallableReference function.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/functions/Serializer.html">Serializer</a></code></td>
- <td>
- <p>Converts raw Java types into JSON objects.</p>
+ <p>The result of calling a <code>HttpsCallableReference</code> function.</p>
</td>
</tr>
</tbody>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/client/firebase-functions/_toc.yaml 2024-11-08 21:51:52.920204177 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/client/firebase-functions/_toc.yaml 2024-11-08 21:49:20.784392571 +0000
@@ -8,8 +8,6 @@
section:
- title: "FirebaseFunctions"
path: "/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctions.html"
- - title: "HttpsCallOptions"
- path: "/docs/reference/kotlin/com/google/firebase/functions/HttpsCallOptions.html"
- title: "HttpsCallableOptions"
path: "/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableOptions.html"
- title: "HttpsCallableOptions.Builder"
@@ -18,8 +16,6 @@
path: "/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableReference.html"
- title: "HttpsCallableResult"
path: "/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableResult.html"
- - title: "Serializer"
- path: "/docs/reference/kotlin/com/google/firebase/functions/Serializer.html"
- title: "Enums"
--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/functions/FirebaseFunctions.html 2024-11-08 21:51:52.928204168 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/functions/FirebaseFunctions.html 2024-11-08 21:49:20.784392571 +0000
@@ -107,7 +107,7 @@
<td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a></code></td>
<td>
<div><code><span><del><a href="/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctions.html#useFunctionsEmulator(kotlin.String)">useFunctionsEmulator</a></del></span>(origin: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>)</code></div>
- <p><strong>This function is deprecated.</strong> Use {@link #useEmulator(String, int)} to connect to the emulator.</p>
+ <p><strong>This function is deprecated.</strong> Use useEmulator to connect to the emulator.</p>
</td>
</tr>
</tbody>
@@ -306,7 +306,7 @@
<div class="api-item"><a name="useFunctionsEmulator-kotlin.String-"></a><a name="usefunctionsemulator"></a>
<h3 class="api-name" id="useFunctionsEmulator(kotlin.String)">useFunctionsEmulator</h3>
<pre class="api-signature no-pretty-print">fun <span><del><a href="/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctions.html#useFunctionsEmulator(kotlin.String)">useFunctionsEmulator</a></del></span>(origin: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a></pre>
- <aside class="caution"><strong>This function is deprecated.</strong><br>Use {@link #useEmulator(String, int)} to connect to the emulator. </aside>
+ <aside class="caution"><strong>This function is deprecated.</strong><br>Use useEmulator to connect to the emulator.</aside>
</div>
</div>
<div class="list">--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/functions/FirebaseFunctionsException.Code.html 2024-11-08 21:51:52.920204177 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/functions/FirebaseFunctionsException.Code.html 2024-11-08 21:49:20.784392571 +0000
@@ -164,7 +164,7 @@
<td><code><a href="/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctionsException.Code.html">FirebaseFunctionsException.Code</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctionsException.Code.Companion.html#fromHttpStatus(kotlin.Int)">fromHttpStatus</a>(status: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>)</code></div>
- <p>Takes an HTTP status code and returns the corresponding FUNErrorCode error code.</p>
+ <p>Takes an HTTP status code and returns the corresponding <code><a href="/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctionsException.Code.html">Code</a></code> error code.</p>
</td>
</tr>
<tr>
@@ -245,7 +245,7 @@
<div class="api-item">
<h3 class="api-name" id="INVALID_ARGUMENT">INVALID_ARGUMENT</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctionsException.Code.html#INVALID_ARGUMENT">FirebaseFunctionsException.Code.INVALID_ARGUMENT</a>: <a href="/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctionsException.Code.html">FirebaseFunctionsException.Code</a></pre>
- <p>Client specified an invalid argument. Note that this differs from FAILED_PRECONDITION. INVALID_ARGUMENT indicates arguments that are problematic regardless of the state of the system (e.g., an invalid field name).</p>
+ <p>Client specified an invalid argument. Note that this differs from <code>FAILED_PRECONDITION</code>. <code>INVALID_ARGUMENT</code> indicates arguments that are problematic regardless of the state of the system (For example, an invalid field name).</p>
</div>
<div class="api-item">
<h3 class="api-name" id="NOT_FOUND">NOT_FOUND</h3>
@@ -255,7 +255,7 @@
<div class="api-item">
<h3 class="api-name" id="OK">OK</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctionsException.Code.html#OK">FirebaseFunctionsException.Code.OK</a>: <a href="/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctionsException.Code.html">FirebaseFunctionsException.Code</a></pre>
- <p>The operation completed successfully. FirebaseFunctionsException will never have a status of OK.</p>
+ <p>The operation completed successfully. <code>FirebaseFunctionsException</code> will never have a status of <code>OK</code>.</p>
</div>
<div class="api-item">
<h3 class="api-name" id="OUT_OF_RANGE">OUT_OF_RANGE</h3>
@@ -298,7 +298,7 @@
<div class="api-item"><a name="fromHttpStatus-kotlin.Int-"></a><a name="fromhttpstatus"></a>
<h3 class="api-name" id="fromHttpStatus(kotlin.Int)">fromHttpStatus</h3>
<pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctionsException.Code.Companion.html#fromHttpStatus(kotlin.Int)">fromHttpStatus</a>(status: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>): <a href="/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctionsException.Code.html">FirebaseFunctionsException.Code</a></pre>
- <p>Takes an HTTP status code and returns the corresponding FUNErrorCode error code. This is the standard HTTP status code -> error mapping defined in: https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto</p>
+ <p>Takes an HTTP status code and returns the corresponding <code><a href="/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctionsException.Code.html">Code</a></code> error code. This is the standard HTTP status code -> error mapping defined in: https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
@@ -335,7 +335,7 @@
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctionsException.Code.html">FirebaseFunctionsException.Code</a></code></td>
<td>
- <p>The corresponding Code, or Code.UNKNOWN if none.</p>
+ <p>The corresponding <code>Code</code>, or <code>Code.UNKNOWN</code> if none.</p>
</td>
</tr>
</tbody>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/functions/FirebaseFunctionsException.html 2024-11-08 21:51:52.928204168 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/functions/FirebaseFunctionsException.html 2024-11-08 21:49:20.784392571 +0000
@@ -73,28 +73,6 @@
</colgroup>
<thead>
<tr>
- <th colspan="100%"><h3>Public companion functions</h3></th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctionsException.html">FirebaseFunctionsException</a>?</code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctionsException.Companion.html#fromResponse(com.google.firebase.functions.FirebaseFunctionsException.Code,kotlin.String,com.google.firebase.functions.Serializer)">fromResponse</a>(<br> code: <a href="/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctionsException.Code.html">FirebaseFunctionsException.Code</a>,<br> body: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>?,<br> serializer: <a href="/docs/reference/kotlin/com/google/firebase/functions/Serializer.html">Serializer</a><br>)</code></div>
- <p>Takes an HTTP response and returns the corresponding Exception if any.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
<th colspan="100%"><h3>Public properties</h3></th>
</tr>
</thead>
@@ -239,68 +217,6 @@
</table>
</div>
<div class="list">
- <h2>Public companion functions</h2>
- <div class="api-item"><a name="fromResponse(com.google.firebase.functions.FirebaseFunctionsException.Code, kotlin.String, com.google.firebase.functions.Serializer)"></a><a name="fromResponse-com.google.firebase.functions.FirebaseFunctionsException.Code-kotlin.String-com.google.firebase.functions.Serializer-"></a><a name="fromresponse"></a>
- <h3 class="api-name" id="fromResponse(com.google.firebase.functions.FirebaseFunctionsException.Code,kotlin.String,com.google.firebase.functions.Serializer)">fromResponse</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctionsException.Companion.html#fromResponse(com.google.firebase.functions.FirebaseFunctionsException.Code,kotlin.String,com.google.firebase.functions.Serializer)">fromResponse</a>(<br> code: <a href="/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctionsException.Code.html">FirebaseFunctionsException.Code</a>,<br> body: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>?,<br> serializer: <a href="/docs/reference/kotlin/com/google/firebase/functions/Serializer.html">Serializer</a><br>): <a href="/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctionsException.html">FirebaseFunctionsException</a>?</pre>
- <p>Takes an HTTP response and returns the corresponding Exception if any.</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Parameters</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>code: <a href="/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctionsException.Code.html">FirebaseFunctionsException.Code</a></code></td>
- <td>
- <p>An HTTP status code.</p>
- </td>
- </tr>
- <tr>
- <td><code>body: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>?</code></td>
- <td>
- <p>The body of the HTTP response, if any.</p>
- </td>
- </tr>
- <tr>
- <td><code>serializer: <a href="/docs/reference/kotlin/com/google/firebase/functions/Serializer.html">Serializer</a></code></td>
- <td>
- <p>A serializer to use for decoding error details.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Returns</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctionsException.html">FirebaseFunctionsException</a>?</code></td>
- <td>
- <p>The corresponding Exception, or null if none.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- </div>
- <div class="list">
<h2>Public properties</h2>
<div class="api-item"><a name="getCode()"></a><a name="setCode()"></a><a name="getCode--"></a><a name="setCode--"></a>
<h3 class="api-name" id="code()">code</h3>
@@ -321,7 +237,7 @@
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctionsException.Code.html">FirebaseFunctionsException.Code</a></code></td>
<td>
- <p>the code for the FirebaseFunctionsException</p>
+ <p>the code for the <code>FirebaseFunctionsException</code></p>
</td>
</tr>
</tbody>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/functions/HttpsCallOptions.html 2024-11-08 21:51:52.928204168 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/functions/HttpsCallOptions.html 1970-01-01 00:00:00.000000000 +0000
@@ -1,196 +0,0 @@
-<html devsite="true">
- <head>
- <title>HttpsCallOptions</title>
-{% setvar book_path %}/_book.yaml{% endsetvar %}
-{% include "docs/reference/kotlin/_reference-head-tags.html" %}
- </head>
- <body>
- <div id="metadata-info-block"></div>
- <h1>HttpsCallOptions</h1>
- <p>
- <pre>class <a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallOptions.html">HttpsCallOptions</a></pre>
- </p>
- <hr>
- <p>An internal class for keeping track of options applied to an HttpsCallableReference.</p>
- <h2>Summary</h2>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%"><h3>Public constructors</h3></th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallOptions.html#HttpsCallOptions()">HttpsCallOptions</a>()</code></div>
- </td>
- </tr>
- <tr>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallOptions.html#HttpsCallOptions(com.google.firebase.functions.HttpsCallableOptions)">HttpsCallOptions</a>(publicCallableOptions: <a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableOptions.html">HttpsCallableOptions</a>)</code></div>
- <p>Creates an (internal) HttpsCallOptions from the (external) <code><a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableOptions.html">HttpsCallableOptions</a></code>.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%"><h3>Public functions</h3></th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code><a href="/docs/reference/kotlin/okhttp3/OkHttpClient.html">OkHttpClient</a></code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallOptions.html#apply(okhttp3.OkHttpClient)">apply</a>(client: <a href="/docs/reference/kotlin/okhttp3/OkHttpClient.html">OkHttpClient</a>)</code></div>
- <p>Creates a new OkHttpClient with these options applied to it.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallOptions.html#getLimitedUseAppCheckTokens()">getLimitedUseAppCheckTokens</a>()</code></div>
- </td>
- </tr>
- <tr>
- <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallOptions.html#getTimeout()">getTimeout</a>()</code></div>
- <p>Returns the timeout for calls from this instance of Functions.</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/functions/HttpsCallOptions.html#setTimeout(kotlin.Long,java.util.concurrent.TimeUnit)">setTimeout</a>(timeout: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a>, units: <a href="https://developer.android.com/reference/kotlin/java/util/concurrent/TimeUnit.html">TimeUnit</a>)</code></div>
- <p>Changes the timeout for calls from this instance of Functions.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%"><h3>Public properties</h3></th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallOptions.html#limitedUseAppCheckTokens()">limitedUseAppCheckTokens</a></code></div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="list">
- <h2>Public constructors</h2>
- <div class="api-item"><a name="HttpsCallOptions--"></a><a name="httpscalloptions"></a>
- <h3 class="api-name" id="HttpsCallOptions()">HttpsCallOptions</h3>
- <pre class="api-signature no-pretty-print"><a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallOptions.html#HttpsCallOptions()">HttpsCallOptions</a>()</pre>
- </div>
- <div class="api-item"><a name="HttpsCallOptions-com.google.firebase.functions.HttpsCallableOptions-"></a><a name="httpscalloptions"></a>
- <h3 class="api-name" id="HttpsCallOptions(com.google.firebase.functions.HttpsCallableOptions)">HttpsCallOptions</h3>
- <pre class="api-signature no-pretty-print"><a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallOptions.html#HttpsCallOptions(com.google.firebase.functions.HttpsCallableOptions)">HttpsCallOptions</a>(publicCallableOptions: <a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableOptions.html">HttpsCallableOptions</a>)</pre>
- <p>Creates an (internal) HttpsCallOptions from the (external) <code><a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableOptions.html">HttpsCallableOptions</a></code>.</p>
- </div>
- </div>
- <div class="list">
- <h2>Public functions</h2>
- <div class="api-item"><a name="apply-okhttp3.OkHttpClient-"></a><a name="apply"></a>
- <h3 class="api-name" id="apply(okhttp3.OkHttpClient)">apply</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallOptions.html#apply(okhttp3.OkHttpClient)">apply</a>(client: <a href="/docs/reference/kotlin/okhttp3/OkHttpClient.html">OkHttpClient</a>): <a href="/docs/reference/kotlin/okhttp3/OkHttpClient.html">OkHttpClient</a></pre>
- <p>Creates a new OkHttpClient with these options applied to it.</p>
- </div>
- <div class="api-item"><a name="getLimitedUseAppCheckTokens--"></a><a name="getlimiteduseappchecktokens"></a>
- <h3 class="api-name" id="getLimitedUseAppCheckTokens()">getLimitedUseAppCheckTokens</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallOptions.html#getLimitedUseAppCheckTokens()">getLimitedUseAppCheckTokens</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></pre>
- </div>
- <div class="api-item"><a name="getTimeout--"></a><a name="gettimeout"></a>
- <h3 class="api-name" id="getTimeout()">getTimeout</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallOptions.html#getTimeout()">getTimeout</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></pre>
- <p>Returns the timeout for calls from this instance of Functions.</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Returns</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></code></td>
- <td>
- <p>The timeout, in milliseconds.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="setTimeout(kotlin.Long, java.util.concurrent.TimeUnit)"></a><a name="setTimeout-kotlin.Long-java.util.concurrent.TimeUnit-"></a><a name="settimeout"></a>
- <h3 class="api-name" id="setTimeout(kotlin.Long,java.util.concurrent.TimeUnit)">setTimeout</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallOptions.html#setTimeout(kotlin.Long,java.util.concurrent.TimeUnit)">setTimeout</a>(timeout: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a>, units: <a href="https://developer.android.com/reference/kotlin/java/util/concurrent/TimeUnit.html">TimeUnit</a>): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a></pre>
- <p>Changes the timeout for calls from this instance of Functions. The default is 60 seconds.</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Parameters</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>timeout: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></code></td>
- <td>
- <p>The length of the timeout, in the given units.</p>
- </td>
- </tr>
- <tr>
- <td><code>units: <a href="https://developer.android.com/reference/kotlin/java/util/concurrent/TimeUnit.html">TimeUnit</a></code></td>
- <td>
- <p>The units for the specified timeout.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- </div>
- <div class="list">
- <h2>Public properties</h2>
- <div class="api-item"><a name="getLimitedUseAppCheckTokens()"></a><a name="setLimitedUseAppCheckTokens()"></a><a name="getLimitedUseAppCheckTokens--"></a><a name="setLimitedUseAppCheckTokens--"></a>
- <h3 class="api-name" id="limitedUseAppCheckTokens()">limitedUseAppCheckTokens</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallOptions.html#limitedUseAppCheckTokens()">limitedUseAppCheckTokens</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></pre>
- </div>
- </div>
- </body>
-</html>
---- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/functions/HttpsCallableOptions.Builder.html 2024-11-08 21:51:52.928204168 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/functions/HttpsCallableOptions.Builder.html 2024-11-08 21:49:20.784392571 +0000
@@ -11,7 +11,7 @@
<pre>class <a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableOptions.Builder.html">HttpsCallableOptions.Builder</a></pre>
</p>
<hr>
- <p>Builder class for <code><a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableOptions.html">com.google.firebase.functions.HttpsCallableOptions</a></code></p>
+ <p>A builder for creating <code><a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableOptions.html">com.google.firebase.functions.HttpsCallableOptions</a></code>.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/functions/HttpsCallableOptions.html 2024-11-08 21:51:52.928204168 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/functions/HttpsCallableOptions.html 2024-11-08 21:49:20.784392571 +0000
@@ -29,7 +29,7 @@
<tr>
<td>
<div><code>class <a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableOptions.Builder.html">HttpsCallableOptions.Builder</a></code></div>
- <p>Builder class for <code><a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableOptions.html">com.google.firebase.functions.HttpsCallableOptions</a></code></p>
+ <p>A builder for creating <code><a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableOptions.html">com.google.firebase.functions.HttpsCallableOptions</a></code>.</p>
</td>
</tr>
</tbody>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/functions/HttpsCallableReference.html 2024-11-08 21:51:52.920204177 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/functions/HttpsCallableReference.html 2024-11-08 21:49:20.784392571 +0000
@@ -84,7 +84,7 @@
<pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableReference.html#call()">call</a>(): <a href="https://developers.google.com/android/reference/com/google/android/gms/tasks/Task.html">Task</a><<a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableResult.html">HttpsCallableResult</a>></pre>
<p>Executes this HTTPS endpoint asynchronously without arguments.</p>
<p>The request to the Cloud Functions backend made by this method automatically includes a Firebase Instance ID token to identify the app instance. If a user is logged in with Firebase Auth, an auth token for the user will also be automatically included.</p>
- <p>Firebase Instance ID sends data to the Firebase backend periodically to collect information regarding the app instance. To stop this, see <code><a href="/docs/reference/kotlin/com/google/firebase/iid/FirebaseInstanceId.html#deleteInstanceId()"> </a></code>. It will resume with a new Instance ID the next time you call this method.</p>
+ <p>Firebase Instance ID sends data to the Firebase backend periodically to collect information regarding the app instance. To stop this, see <code><a href="/docs/reference/kotlin/com/google/firebase/iid/FirebaseInstanceId.html#deleteInstanceId()">com.google.firebase.iid.FirebaseInstanceId.deleteInstanceId</a></code>. It will resume with a new Instance ID the next time you call this method.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
@@ -157,7 +157,7 @@
</li>
</ul>
<p>The request to the Cloud Functions backend made by this method automatically includes a Firebase Instance ID token to identify the app instance. If a user is logged in with Firebase Auth, an auth token for the user will also be automatically included.</p>
- <p>Firebase Instance ID sends data to the Firebase backend periodically to collect information regarding the app instance. To stop this, see <code><a href="/docs/reference/kotlin/com/google/firebase/iid/FirebaseInstanceId.html#deleteInstanceId()"> </a></code>. It will resume with a new Instance ID the next time you call this method.</p>
+ <p>Firebase Instance ID sends data to the Firebase backend periodically to collect information regarding the app instance. To stop this, see <code><a href="/docs/reference/kotlin/com/google/firebase/iid/FirebaseInstanceId.html#deleteInstanceId()">com.google.firebase.iid.FirebaseInstanceId.deleteInstanceId</a></code>. It will resume with a new Instance ID the next time you call this method.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/functions/HttpsCallableResult.html 2024-11-08 21:51:52.928204168 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/functions/HttpsCallableResult.html 2024-11-08 21:49:20.784392571 +0000
@@ -11,7 +11,7 @@
<pre>class <a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableResult.html">HttpsCallableResult</a></pre>
</p>
<hr>
- <p>The result of calling a HttpsCallableReference function.</p>
+ <p>The result of calling a <code>HttpsCallableReference</code> function.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -41,7 +41,7 @@
<h3 class="api-name" id="getData()">getData</h3>
<pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableResult.html#getData()">getData</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>?</pre>
<p>Returns the data that was returned from the Callable HTTPS trigger.</p>
- <p>The data is in the form of native Java objects. For example, if your trigger returned an array, this object would be a List<Object>. If your trigger returned a JavaScript object with keys and values, this object would be a Map.</p>
+ <p>The data is in the form of native Java objects. For example, if your trigger returned an array, this object would be a <code>List<Object></code>. If your trigger returned a JavaScript object with keys and values, this object would be a <code>Map<String, Object></code>.</p>
</div>
</div>
</body>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/functions/Serializer.html 2024-11-08 21:51:52.920204177 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/functions/Serializer.html 1970-01-01 00:00:00.000000000 +0000
@@ -1,83 +0,0 @@
-<html devsite="true">
- <head>
- <title>Serializer</title>
-{% setvar book_path %}/_book.yaml{% endsetvar %}
-{% include "docs/reference/kotlin/_reference-head-tags.html" %}
- </head>
- <body>
- <div id="metadata-info-block"></div>
- <h1>Serializer</h1>
- <p>
- <pre>class <a href="/docs/reference/kotlin/com/google/firebase/functions/Serializer.html">Serializer</a></pre>
- </p>
- <hr>
- <p>Converts raw Java types into JSON objects.</p>
- <h2>Summary</h2>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%"><h3>Public constructors</h3></th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/functions/Serializer.html#Serializer()">Serializer</a>()</code></div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%"><h3>Public functions</h3></th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>?</code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/functions/Serializer.html#decode(kotlin.Any)">decode</a>(obj: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>)</code></div>
- </td>
- </tr>
- <tr>
- <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a></code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/functions/Serializer.html#encode(kotlin.Any)">encode</a>(obj: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>?)</code></div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="list">
- <h2>Public constructors</h2>
- <div class="api-item"><a name="Serializer--"></a><a name="serializer"></a>
- <h3 class="api-name" id="Serializer()">Serializer</h3>
- <pre class="api-signature no-pretty-print"><a href="/docs/reference/kotlin/com/google/firebase/functions/Serializer.html#Serializer()">Serializer</a>()</pre>
- </div>
- </div>
- <div class="list">
- <h2>Public functions</h2>
- <div class="api-item"><a name="decode-kotlin.Any-"></a><a name="decode"></a>
- <h3 class="api-name" id="decode(kotlin.Any)">decode</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/functions/Serializer.html#decode(kotlin.Any)">decode</a>(obj: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>?</pre>
- </div>
- <div class="api-item"><a name="encode-kotlin.Any-"></a><a name="encode"></a>
- <h3 class="api-name" id="encode(kotlin.Any)">encode</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/functions/Serializer.html#encode(kotlin.Any)">encode</a>(obj: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>?): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a></pre>
- </div>
- </div>
- </body>
-</html>
---- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/functions/package-summary.html 2024-11-08 21:51:52.920204177 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/functions/package-summary.html 2024-11-08 21:49:20.784392571 +0000
@@ -21,12 +21,6 @@
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallOptions.html">HttpsCallOptions</a></code></td>
- <td>
- <p>An internal class for keeping track of options applied to an HttpsCallableReference.</p>
- </td>
- </tr>
- <tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableOptions.html">HttpsCallableOptions</a></code></td>
<td>
<p>Options for configuring the callable function.</p>
@@ -35,7 +29,7 @@
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableOptions.Builder.html">HttpsCallableOptions.Builder</a></code></td>
<td>
- <p>Builder class for <code><a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableOptions.html">com.google.firebase.functions.HttpsCallableOptions</a></code></p>
+ <p>A builder for creating <code><a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableOptions.html">com.google.firebase.functions.HttpsCallableOptions</a></code>.</p>
</td>
</tr>
<tr>
@@ -47,13 +41,7 @@
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableResult.html">HttpsCallableResult</a></code></td>
<td>
- <p>The result of calling a HttpsCallableReference function.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/functions/Serializer.html">Serializer</a></code></td>
- <td>
- <p>Converts raw Java types into JSON objects.</p>
+ <p>The result of calling a <code>HttpsCallableReference</code> function.</p>
</td>
</tr>
</tbody> |
Vertex AI Mock Responses Check
|
Generated by 🚫 Danger |
Test Results14 files - 40 14 suites - 40 16s ⏱️ - 1m 42s Results for commit 0618642. ± Comparison against base commit f20340a. This pull request removes 515 and adds 23 tests. Note that renamed tests count towards both. |
|
The public api surface has changed for the subproject firebase-functions: Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly. |
VinayGuthal
approved these changes
Nov 9, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Adjusted Functions docs as well as vestigial visibility issues.