Fix visibility on Firebase Functions #6269
Merged
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/com/google/firebase/functions/FirebaseFunctions.html 2024-09-18 18:10:11.119387469 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/functions/FirebaseFunctions.html 2024-09-18 18:07:39.853929811 +0000
@@ -46,20 +46,6 @@
</thead>
<tbody class="list">
<tr>
- <td><code>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>></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctions.html#call(kotlin.String,kotlin.Any,com.google.firebase.functions.HttpsCallOptions)">call</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/String.html">String</a> name, <a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">Object</a> data, @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/functions/HttpsCallOptions.html">HttpsCallOptions</a> options)</code></div>
- <p>Calls a Callable HTTPS trigger endpoint.</p>
- </td>
- </tr>
- <tr>
- <td><code>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>></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctions.html#call(java.net.URL,kotlin.Any,com.google.firebase.functions.HttpsCallOptions)">call</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/net/URL.html">URL</a> url, <a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">Object</a> data, @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/functions/HttpsCallOptions.html">HttpsCallOptions</a> options)</code></div>
- <p>Calls a Callable HTTPS trigger endpoint.</p>
- </td>
- </tr>
- <tr>
<td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/functions/HttpsCallableReference.html">HttpsCallableReference</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctions.html#getHttpsCallable(kotlin.String)">getHttpsCallable</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/String.html">String</a> name)</code></div>
@@ -177,112 +163,6 @@
</div>
<div class="list">
<h2>Public methods</h2>
- <div class="api-item"><a name="call(kotlin.String, kotlin.Any, com.google.firebase.functions.HttpsCallOptions)"></a><a name="call-kotlin.String-kotlin.Any-com.google.firebase.functions.HttpsCallOptions-"></a><a name="call"></a>
- <h3 class="api-name" id="call(kotlin.String,kotlin.Any,com.google.firebase.functions.HttpsCallOptions)">call</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://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/FirebaseFunctions.html#call(kotlin.String,kotlin.Any,com.google.firebase.functions.HttpsCallOptions)">call</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/String.html">String</a> name, <a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">Object</a> data, @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/functions/HttpsCallOptions.html">HttpsCallOptions</a> options)</pre>
- <p>Calls a Callable HTTPS trigger endpoint.</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="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> name</code></td>
- <td>
- <p>The name of the HTTPS trigger.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">Object</a> data</code></td>
- <td>
- <p>Parameters to pass to the function. Can be anything encodable as JSON.</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="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>></code></td>
- <td>
- <p>A Task that will be completed when the request is complete.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="call(java.net.URL, kotlin.Any, com.google.firebase.functions.HttpsCallOptions)"></a><a name="call-java.net.URL-kotlin.Any-com.google.firebase.functions.HttpsCallOptions-"></a><a name="call"></a>
- <h3 class="api-name" id="call(java.net.URL,kotlin.Any,com.google.firebase.functions.HttpsCallOptions)">call</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://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/FirebaseFunctions.html#call(java.net.URL,kotlin.Any,com.google.firebase.functions.HttpsCallOptions)">call</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/net/URL.html">URL</a> url, <a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">Object</a> data, @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/functions/HttpsCallOptions.html">HttpsCallOptions</a> options)</pre>
- <p>Calls a Callable HTTPS trigger endpoint.</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="https://developer.android.com/reference/kotlin/java/net/URL.html">URL</a> url</code></td>
- <td>
- <p>The url of the HTTPS trigger</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">Object</a> data</code></td>
- <td>
- <p>Parameters to pass to the function. Can be anything encodable as JSON.</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="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>></code></td>
- <td>
- <p>A Task that will be completed when the request is complete.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
<div class="api-item"><a name="getHttpsCallable-kotlin.String-"></a><a name="gethttpscallable"></a>
<h3 class="api-name" id="getHttpsCallable(kotlin.String)">getHttpsCallable</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/com/google/firebase/functions/HttpsCallableReference.html">HttpsCallableReference</a> <a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctions.html#getHttpsCallable(kotlin.String)">getHttpsCallable</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/String.html">String</a> name)</pre>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/functions/FirebaseFunctions.html 2024-09-18 18:10:11.119387469 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/functions/FirebaseFunctions.html 2024-09-18 18:07:39.837929655 +0000
@@ -69,20 +69,6 @@
</thead>
<tbody class="list">
<tr>
- <td><code><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>></code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctions.html#call(kotlin.String,kotlin.Any,com.google.firebase.functions.HttpsCallOptions)">call</a>(name: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, data: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>?, options: <a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallOptions.html">HttpsCallOptions</a>)</code></div>
- <p>Calls a Callable HTTPS trigger endpoint.</p>
- </td>
- </tr>
- <tr>
- <td><code><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>></code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctions.html#call(java.net.URL,kotlin.Any,com.google.firebase.functions.HttpsCallOptions)">call</a>(url: <a href="https://developer.android.com/reference/kotlin/java/net/URL.html">URL</a>, data: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>?, options: <a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallOptions.html">HttpsCallOptions</a>)</code></div>
- <p>Calls a Callable HTTPS trigger endpoint.</p>
- </td>
- </tr>
- <tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableReference.html">HttpsCallableReference</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctions.html#getHttpsCallable(kotlin.String)">getHttpsCallable</a>(name: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>)</code></div>
@@ -264,112 +250,6 @@
</div>
<div class="list">
<h2>Public functions</h2>
- <div class="api-item"><a name="call(kotlin.String, kotlin.Any, com.google.firebase.functions.HttpsCallOptions)"></a><a name="call-kotlin.String-kotlin.Any-com.google.firebase.functions.HttpsCallOptions-"></a><a name="call"></a>
- <h3 class="api-name" id="call(kotlin.String,kotlin.Any,com.google.firebase.functions.HttpsCallOptions)">call</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctions.html#call(kotlin.String,kotlin.Any,com.google.firebase.functions.HttpsCallOptions)">call</a>(name: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, data: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>?, options: <a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallOptions.html">HttpsCallOptions</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>Calls a Callable HTTPS trigger endpoint.</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>name: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></code></td>
- <td>
- <p>The name of the HTTPS trigger.</p>
- </td>
- </tr>
- <tr>
- <td><code>data: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>?</code></td>
- <td>
- <p>Parameters to pass to the function. Can be anything encodable as JSON.</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="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>></code></td>
- <td>
- <p>A Task that will be completed when the request is complete.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="call(java.net.URL, kotlin.Any, com.google.firebase.functions.HttpsCallOptions)"></a><a name="call-java.net.URL-kotlin.Any-com.google.firebase.functions.HttpsCallOptions-"></a><a name="call"></a>
- <h3 class="api-name" id="call(java.net.URL,kotlin.Any,com.google.firebase.functions.HttpsCallOptions)">call</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctions.html#call(java.net.URL,kotlin.Any,com.google.firebase.functions.HttpsCallOptions)">call</a>(url: <a href="https://developer.android.com/reference/kotlin/java/net/URL.html">URL</a>, data: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>?, options: <a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallOptions.html">HttpsCallOptions</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>Calls a Callable HTTPS trigger endpoint.</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>url: <a href="https://developer.android.com/reference/kotlin/java/net/URL.html">URL</a></code></td>
- <td>
- <p>The url of the HTTPS trigger</p>
- </td>
- </tr>
- <tr>
- <td><code>data: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>?</code></td>
- <td>
- <p>Parameters to pass to the function. Can be anything encodable as JSON.</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="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>></code></td>
- <td>
- <p>A Task that will be completed when the request is complete.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
<div class="api-item"><a name="getHttpsCallable-kotlin.String-"></a><a name="gethttpscallable"></a>
<h3 class="api-name" id="getHttpsCallable(kotlin.String)">getHttpsCallable</h3>
<pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctions.html#getHttpsCallable(kotlin.String)">getHttpsCallable</a>(name: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>): <a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableReference.html">HttpsCallableReference</a></pre> |
Generated by 🚫 Danger |
Coverage Report 1Affected ProductsNo changes between base commit (c56bc5d) and merge commit (04c5391).Test Logs |
Unit Test Results20 files - 68 20 suites - 68 36s ⏱️ - 2m 3s Results for commit 3bd35a9. ± Comparison against base commit e6b4ace. This pull request removes 393 and adds 23 tests. Note that renamed tests count towards both.♻️ This comment has been updated with latest results. |
|
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. |
Size Report 1Affected Products
Test 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
|
rlazo
approved these changes
Sep 18, 2024
|
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. |
rlazo
approved these changes
Sep 19, 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.
No description provided.