-
Notifications
You must be signed in to change notification settings - Fork 578
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: Add support for the VectorValue type #6154
Conversation
Javadoc Changes:--- /home/runner/diff/original/firebase-kotlindoc/android/client/firebase-firestore/_toc.yaml 2024-08-08 02:26:21.585795228 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/client/firebase-firestore/_toc.yaml 2024-08-08 02:23:48.983960992 +0000
@@ -104,6 +104,8 @@
path: "/docs/reference/android/com/google/firebase/firestore/TransactionOptions.html"
- title: "TransactionOptions.Builder"
path: "/docs/reference/android/com/google/firebase/firestore/TransactionOptions.Builder.html"
+ - title: "VectorValue"
+ path: "/docs/reference/android/com/google/firebase/firestore/VectorValue.html"
- title: "WriteBatch"
path: "/docs/reference/android/com/google/firebase/firestore/WriteBatch.html"
--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/DocumentSnapshot.html 2024-08-08 02:26:21.545794766 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/DocumentSnapshot.html 2024-08-08 02:23:48.979960949 +0000
@@ -284,6 +284,13 @@
</td>
</tr>
<tr>
+ <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/Nullable.html">Nullable</a> <a href="/docs/reference/android/com/google/firebase/firestore/VectorValue.html">VectorValue</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/DocumentSnapshot.html#getVectorValue(java.lang.String)">getVectorValue</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> field)</code></div>
+ <p>Returns the value of the field as a <code><a href="/docs/reference/android/com/google/firebase/firestore/VectorValue.html">VectorValue</a></code> or `null` if the field does not exist in the document.</p>
+ </td>
+ </tr>
+ <tr>
<td><code>int</code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/firestore/DocumentSnapshot.html#hashCode()">hashCode</a>()</code></div>
@@ -1852,6 +1859,74 @@
</td>
</tr>
</tbody>
+ </table>
+ </div>
+ </div>
+ <div class="api-item"><a name="getVectorValue-java.lang.String-"></a><a name="getvectorvalue"></a>
+ <h3 class="api-name" id="getVectorValue(java.lang.String)">getVectorValue</h3>
+ <pre class="api-signature no-pretty-print">public @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/Nullable.html">Nullable</a> <a href="/docs/reference/android/com/google/firebase/firestore/VectorValue.html">VectorValue</a> <a href="/docs/reference/android/com/google/firebase/firestore/DocumentSnapshot.html#getVectorValue(java.lang.String)">getVectorValue</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> field)</pre>
+ <p>Returns the value of the field as a <code><a href="/docs/reference/android/com/google/firebase/firestore/VectorValue.html">VectorValue</a></code> or `null` if the field does not exist in the document.</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> field</code></td>
+ <td>
+ <p>The path to the field.</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/Nullable.html">Nullable</a> <a href="/docs/reference/android/com/google/firebase/firestore/VectorValue.html">VectorValue</a></code></td>
+ <td>
+ <p>The value of the field.</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%">Throws</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/RuntimeException.html">java.lang.RuntimeException</a> java.lang.RuntimeException</code></td>
+ <td>
+ <p>if the value is not a VectorValue.</p>
+ </td>
+ </tr>
+ </tbody>
</table>
</div>
</div> --- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/FieldValue.html 2024-08-08 02:26:21.541794720 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/FieldValue.html 2024-08-08 02:23:48.963960777 +0000
@@ -68,6 +68,13 @@
<p>Returns a sentinel for use with <code>set()</code> or <code>update()</code> to include a server-generated timestamp in the written data.</p>
</td>
</tr>
+ <tr>
+ <td><code>static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/VectorValue.html">VectorValue</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/FieldValue.html#vector(double[])">vector</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> double[] values)</code></div>
+ <p>Creates a new <code><a href="/docs/reference/android/com/google/firebase/firestore/VectorValue.html">VectorValue</a></code> constructed with a copy of the given array of doubles.</p>
+ </td>
+ </tr>
</tbody>
</table>
</div>
@@ -232,6 +239,53 @@
<pre class="api-signature no-pretty-print">public static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/FieldValue.html">FieldValue</a> <a href="/docs/reference/android/com/google/firebase/firestore/FieldValue.html#serverTimestamp()">serverTimestamp</a>()</pre>
<p>Returns a sentinel for use with <code>set()</code> or <code>update()</code> to include a server-generated timestamp in the written data.</p>
</div>
+ <div class="api-item"><a name="vector-double[]-"></a><a name="vector"></a>
+ <h3 class="api-name" id="vector(double[])">vector</h3>
+ <pre class="api-signature no-pretty-print">public static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/VectorValue.html">VectorValue</a> <a href="/docs/reference/android/com/google/firebase/firestore/FieldValue.html#vector(double[])">vector</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> double[] values)</pre>
+ <p>Creates a new <code><a href="/docs/reference/android/com/google/firebase/firestore/VectorValue.html">VectorValue</a></code> constructed with a copy of the given array of doubles.</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> double[] values</code></td>
+ <td>
+ <p>Array of doubles to be copied to create a <code><a href="/docs/reference/android/com/google/firebase/firestore/VectorValue.html">VectorValue</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%">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="/docs/reference/android/com/google/firebase/firestore/VectorValue.html">VectorValue</a></code></td>
+ <td>
+ <p>A new <code><a href="/docs/reference/android/com/google/firebase/firestore/VectorValue.html">VectorValue</a></code> constructed with a copy of the given array of doubles.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
</div>
</body>
</html> --- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/QueryDocumentSnapshot.html 2024-08-08 02:26:21.541794720 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/QueryDocumentSnapshot.html 2024-08-08 02:23:48.963960777 +0000
@@ -346,6 +346,13 @@
</td>
</tr>
<tr>
+ <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/Nullable.html">Nullable</a> <a href="/docs/reference/android/com/google/firebase/firestore/VectorValue.html">VectorValue</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/DocumentSnapshot.html#getVectorValue(java.lang.String)">getVectorValue</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> field)</code></div>
+ <p>Returns the value of the field as a <code><a href="/docs/reference/android/com/google/firebase/firestore/VectorValue.html">VectorValue</a></code> or `null` if the field does not exist in the document.</p>
+ </td>
+ </tr>
+ <tr>
<td><code>int</code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/firestore/DocumentSnapshot.html#hashCode()">hashCode</a>()</code></div> --- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/VectorValue.html 1970-01-01 00:00:00.000000000 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/VectorValue.html 2024-08-08 02:23:48.983960992 +0000
@@ -0,0 +1,133 @@
+<html devsite="true">
+ <head>
+ <title>VectorValue</title>
+{% setvar book_path %}/_book.yaml{% endsetvar %}
+{% include "docs/reference/android/_reference-head-tags.html" %}
+ </head>
+ <body>
+ <div id="metadata-info-block"></div>
+ <h1>VectorValue</h1>
+ <p>
+ <pre>public class <a href="/docs/reference/android/com/google/firebase/firestore/VectorValue.html">VectorValue</a></pre>
+ </p>
+ <hr>
+ <p>Represent a vector type in Firestore documents. Create an instance with <code><a href="/docs/reference/android/com/google/firebase/firestore/FieldValue.html#vector(double[])">vector</a></code>.</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 methods</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code>boolean</code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/VectorValue.html#equals(java.lang.Object)">equals</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">Object</a> obj)</code></div>
+ <p>Returns true if this VectorValue is equal to the provided object.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>int</code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/VectorValue.html#hashCode()">hashCode</a>()</code></div>
+ </td>
+ </tr>
+ <tr>
+ <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> double[]</code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/VectorValue.html#toArray()">toArray</a>()</code></div>
+ <p>Returns a representation of the vector as an array of doubles.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="list">
+ <h2>Public methods</h2>
+ <div class="api-item"><a name="equals-java.lang.Object-"></a><a name="equals"></a>
+ <h3 class="api-name" id="equals(java.lang.Object)">equals</h3>
+ <pre class="api-signature no-pretty-print">public boolean <a href="/docs/reference/android/com/google/firebase/firestore/VectorValue.html#equals(java.lang.Object)">equals</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">Object</a> obj)</pre>
+ <p>Returns true if this VectorValue is equal to the provided object.</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/java/lang/Object.html">Object</a> obj</code></td>
+ <td>
+ <p>The object to compare against.</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>boolean</code></td>
+ <td>
+ <p>Whether this VectorValue is equal to the provided object.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ <div class="api-item"><a name="hashCode--"></a><a name="hashcode"></a>
+ <h3 class="api-name" id="hashCode()">hashCode</h3>
+ <pre class="api-signature no-pretty-print">public int <a href="/docs/reference/android/com/google/firebase/firestore/VectorValue.html#hashCode()">hashCode</a>()</pre>
+ </div>
+ <div class="api-item"><a name="toArray--"></a><a name="toarray"></a>
+ <h3 class="api-name" id="toArray()">toArray</h3>
+ <pre class="api-signature no-pretty-print">public @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> double[] <a href="/docs/reference/android/com/google/firebase/firestore/VectorValue.html#toArray()">toArray</a>()</pre>
+ <p>Returns a representation of the vector as an array of doubles.</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://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> double[]</code></td>
+ <td>
+ <p>A representation of the vector as an array of doubles</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ </div>
+ </body>
+</html>
+ --- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/package-summary.html 2024-08-08 02:26:21.529794582 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/package-summary.html 2024-08-08 02:23:48.963960777 +0000
@@ -348,6 +348,12 @@
</td>
</tr>
<tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/firestore/VectorValue.html">VectorValue</a></code></td>
+ <td>
+ <p>Represent a vector type in Firestore documents.</p>
+ </td>
+ </tr>
+ <tr>
<td><code><a href="/docs/reference/android/com/google/firebase/firestore/WriteBatch.html">WriteBatch</a></code></td>
<td>
<p>A write batch, used to perform multiple writes as a single atomic unit.</p> --- /home/runner/diff/original/firebase-kotlindoc/kotlin/client/firebase-firestore/_toc.yaml 2024-08-08 02:26:21.529794582 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/client/firebase-firestore/_toc.yaml 2024-08-08 02:23:48.959960734 +0000
@@ -102,6 +102,8 @@
path: "/docs/reference/kotlin/com/google/firebase/firestore/TransactionOptions.html"
- title: "TransactionOptions.Builder"
path: "/docs/reference/kotlin/com/google/firebase/firestore/TransactionOptions.Builder.html"
+ - title: "VectorValue"
+ path: "/docs/reference/kotlin/com/google/firebase/firestore/VectorValue.html"
- title: "WriteBatch"
path: "/docs/reference/kotlin/com/google/firebase/firestore/WriteBatch.html"
--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/DocumentSnapshot.html 2024-08-08 02:26:21.509794350 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/DocumentSnapshot.html 2024-08-08 02:23:48.943960562 +0000
@@ -257,6 +257,13 @@
</td>
</tr>
<tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/VectorValue.html">VectorValue</a>?</code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/DocumentSnapshot.html#getVectorValue(java.lang.String)">getVectorValue</a>(field: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>)</code></div>
+ <p>Returns the value of the field as a <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/VectorValue.html">VectorValue</a></code> or `null` if the field does not exist in the document.</p>
+ </td>
+ </tr>
+ <tr>
<td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/DocumentSnapshot.html#hashCode()">hashCode</a>()</code></div>
@@ -1814,6 +1821,74 @@
</td>
</tr>
</tbody>
+ </table>
+ </div>
+ </div>
+ <div class="api-item"><a name="getVectorValue-java.lang.String-"></a><a name="getvectorvalue"></a>
+ <h3 class="api-name" id="getVectorValue(java.lang.String)">getVectorValue</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/DocumentSnapshot.html#getVectorValue(java.lang.String)">getVectorValue</a>(field: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/VectorValue.html">VectorValue</a>?</pre>
+ <p>Returns the value of the field as a <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/VectorValue.html">VectorValue</a></code> or `null` if the field does not exist in the document.</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>field: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></code></td>
+ <td>
+ <p>The path to the field.</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/firestore/VectorValue.html">VectorValue</a>?</code></td>
+ <td>
+ <p>The value of the field.</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%">Throws</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code>java.lang.RuntimeException: <a href="https://developer.android.com/reference/kotlin/java/lang/RuntimeException.html">java.lang.RuntimeException</a></code></td>
+ <td>
+ <p>if the value is not a VectorValue.</p>
+ </td>
+ </tr>
+ </tbody>
</table>
</div>
</div> --- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/FieldValue.html 2024-08-08 02:26:21.501794258 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/FieldValue.html 2024-08-08 02:23:48.943960562 +0000
@@ -68,6 +68,13 @@
<p>Returns a sentinel for use with <code>set()</code> or <code>update()</code> to include a server-generated timestamp in the written data.</p>
</td>
</tr>
+ <tr>
+ <td><code>java-static <a href="/docs/reference/kotlin/com/google/firebase/firestore/VectorValue.html">VectorValue</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FieldValue.html#vector(double[])">vector</a>(values: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double-array/index.html">DoubleArray</a>)</code></div>
+ <p>Creates a new <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/VectorValue.html">VectorValue</a></code> constructed with a copy of the given array of doubles.</p>
+ </td>
+ </tr>
</tbody>
</table>
</div>
@@ -232,6 +239,53 @@
<pre class="api-signature no-pretty-print">java-static fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/FieldValue.html#serverTimestamp()">serverTimestamp</a>(): <a href="/docs/reference/kotlin/com/google/firebase/firestore/FieldValue.html">FieldValue</a></pre>
<p>Returns a sentinel for use with <code>set()</code> or <code>update()</code> to include a server-generated timestamp in the written data.</p>
</div>
+ <div class="api-item"><a name="vector-double[]-"></a><a name="vector"></a>
+ <h3 class="api-name" id="vector(double[])">vector</h3>
+ <pre class="api-signature no-pretty-print">java-static fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/FieldValue.html#vector(double[])">vector</a>(values: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double-array/index.html">DoubleArray</a>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/VectorValue.html">VectorValue</a></pre>
+ <p>Creates a new <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/VectorValue.html">VectorValue</a></code> constructed with a copy of the given array of doubles.</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>values: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double-array/index.html">DoubleArray</a></code></td>
+ <td>
+ <p>Array of doubles to be copied to create a <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/VectorValue.html">VectorValue</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%">Returns</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/VectorValue.html">VectorValue</a></code></td>
+ <td>
+ <p>A new <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/VectorValue.html">VectorValue</a></code> constructed with a copy of the given array of doubles.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
</div>
</body>
</html> --- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/QueryDocumentSnapshot.html 2024-08-08 02:26:21.505794305 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/QueryDocumentSnapshot.html 2024-08-08 02:23:48.943960562 +0000
@@ -315,6 +315,13 @@
</td>
</tr>
<tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/VectorValue.html">VectorValue</a>?</code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/DocumentSnapshot.html#getVectorValue(java.lang.String)">getVectorValue</a>(field: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>)</code></div>
+ <p>Returns the value of the field as a <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/VectorValue.html">VectorValue</a></code> or `null` if the field does not exist in the document.</p>
+ </td>
+ </tr>
+ <tr>
<td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/DocumentSnapshot.html#hashCode()">hashCode</a>()</code></div> --- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/VectorValue.html 1970-01-01 00:00:00.000000000 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/VectorValue.html 2024-08-08 02:23:48.959960734 +0000
@@ -0,0 +1,133 @@
+<html devsite="true">
+ <head>
+ <title>VectorValue</title>
+{% setvar book_path %}/_book.yaml{% endsetvar %}
+{% include "docs/reference/kotlin/_reference-head-tags.html" %}
+ </head>
+ <body>
+ <div id="metadata-info-block"></div>
+ <h1>VectorValue</h1>
+ <p>
+ <pre>class <a href="/docs/reference/kotlin/com/google/firebase/firestore/VectorValue.html">VectorValue</a></pre>
+ </p>
+ <hr>
+ <p>Represent a vector type in Firestore documents. Create an instance with <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FieldValue.html#vector(double[])">vector</a></code>.</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 functions</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/firestore/VectorValue.html#equals(java.lang.Object)">equals</a>(obj: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>!)</code></div>
+ <p>Returns true if this VectorValue is equal to the provided object.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/VectorValue.html#hashCode()">hashCode</a>()</code></div>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double-array/index.html">DoubleArray</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a>></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/VectorValue.html#toArray()">toArray</a>()</code></div>
+ <p>Returns a representation of the vector as an array of doubles.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="list">
+ <h2>Public functions</h2>
+ <div class="api-item"><a name="equals-java.lang.Object-"></a><a name="equals"></a>
+ <h3 class="api-name" id="equals(java.lang.Object)">equals</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/VectorValue.html#equals(java.lang.Object)">equals</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/-boolean/index.html">Boolean</a></pre>
+ <p>Returns true if this VectorValue is equal to the provided object.</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>obj: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>!</code></td>
+ <td>
+ <p>The object to compare against.</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://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></code></td>
+ <td>
+ <p>Whether this VectorValue is equal to the provided object.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ <div class="api-item"><a name="hashCode--"></a><a name="hashcode"></a>
+ <h3 class="api-name" id="hashCode()">hashCode</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/VectorValue.html#hashCode()">hashCode</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></pre>
+ </div>
+ <div class="api-item"><a name="toArray--"></a><a name="toarray"></a>
+ <h3 class="api-name" id="toArray()">toArray</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/VectorValue.html#toArray()">toArray</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double-array/index.html">DoubleArray</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a>></pre>
+ <p>Returns a representation of the vector as an array of doubles.</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/-double-array/index.html">DoubleArray</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a>></code></td>
+ <td>
+ <p>A representation of the vector as an array of doubles</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ </div>
+ </body>
+</html>
+ --- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/package-summary.html 2024-08-08 02:26:21.501794258 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/package-summary.html 2024-08-08 02:23:48.939960519 +0000
@@ -297,6 +297,12 @@
</td>
</tr>
<tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/VectorValue.html">VectorValue</a></code></td>
+ <td>
+ <p>Represent a vector type in Firestore documents.</p>
+ </td>
+ </tr>
+ <tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/WriteBatch.html">WriteBatch</a></code></td>
<td>
<p>A write batch, used to perform multiple writes as a single atomic unit.</p> |
… into markduckworth/vector-type
The public api surface has changed for the subproject firebase-firestore: 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. |
The public api surface has changed for the subproject firebase-firestore: 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. |
1 similar comment
The public api surface has changed for the subproject firebase-firestore: 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. |
Coverage Report 1Affected Products
Test Logs |
The public api surface has changed for the subproject firebase-firestore: 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. |
Unit Test Results 186 files + 122 186 suites +122 4m 40s ⏱️ - 1m 42s Results for commit 0a3204e. ± Comparison against base commit 8c04ec2. This pull request removes 487 and adds 1234 tests. Note that renamed tests count towards both.
♻️ This comment has been updated with latest results. |
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
|
firebase-firestore/src/main/java/com/google/firebase/firestore/DocumentSnapshot.java
Outdated
Show resolved
Hide resolved
firebase-firestore/src/main/java/com/google/firebase/firestore/FieldValue.java
Outdated
Show resolved
Hide resolved
firebase-firestore/src/main/java/com/google/firebase/firestore/UserDataReader.java
Outdated
Show resolved
Hide resolved
firebase-firestore/src/main/java/com/google/firebase/firestore/UserDataWriter.java
Outdated
Show resolved
Hide resolved
firebase-firestore/src/test/java/com/google/firebase/firestore/model/ValuesTest.java
Show resolved
Hide resolved
firebase-firestore/src/main/java/com/google/firebase/firestore/VectorValue.java
Outdated
Show resolved
Hide resolved
firebase-firestore/src/androidTest/java/com/google/firebase/firestore/VectorTest.java
Outdated
Show resolved
Hide resolved
firebase-firestore/src/androidTest/java/com/google/firebase/firestore/VectorTest.java
Show resolved
Hide resolved
...e-firestore/src/main/java/com/google/firebase/firestore/index/FirestoreIndexValueWriter.java
Outdated
Show resolved
Hide resolved
firebase-firestore/src/main/java/com/google/firebase/firestore/model/Values.java
Show resolved
Hide resolved
The public api surface has changed for the subproject firebase-firestore: 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. |
The public api surface has changed for the subproject firebase-firestore: 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. |
The public api surface has changed for the subproject firebase-firestore: 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. |
… into markduckworth/vector-type
The public api surface has changed for the subproject firebase-firestore: 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done...
@@ -182,4 +182,15 @@ public static FieldValue increment(long l) { | |||
public static FieldValue increment(double l) { | |||
return new NumericIncrementFieldValue(l); | |||
} | |||
|
|||
/** | |||
* Creates a new {@link VectorValue} constructed with a copy of the given array of doubles. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you're changing Creates -> Represents per egilmore comment on the js sdk version, apply same changes here AND in the Apple plat/iOS version.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Otherwise, LGTM.
No description provided.