API documentation

Author: MarkDuckworth

firebase-firestore/api.txt

@@ -123,6 +123,7 @@ package com.google.firebase.firestore {
     method @Nullable public String getString(@NonNull String);
     method @Nullable public com.google.firebase.Timestamp getTimestamp(@NonNull String);
     method @Nullable public com.google.firebase.Timestamp getTimestamp(@NonNull String, @NonNull com.google.firebase.firestore.DocumentSnapshot.ServerTimestampBehavior);
+    method @Nullable public com.google.firebase.firestore.VectorValue getVectorValue(@NonNull String);
     method @Nullable public <T> T toObject(@NonNull Class<T>);
     method @Nullable public <T> T toObject(@NonNull Class<T>, @NonNull com.google.firebase.firestore.DocumentSnapshot.ServerTimestampBehavior);
   }
@@ -152,6 +153,7 @@ package com.google.firebase.firestore {
     method @NonNull public static com.google.firebase.firestore.FieldValue increment(long);
     method @NonNull public static com.google.firebase.firestore.FieldValue increment(double);
     method @NonNull public static com.google.firebase.firestore.FieldValue serverTimestamp();
+    method @NonNull public static com.google.firebase.firestore.VectorValue vector(@NonNull double[]);
   }
 
   public class Filter {
@@ -554,6 +556,10 @@ package com.google.firebase.firestore {
     method @NonNull public com.google.firebase.firestore.TransactionOptions.Builder setMaxAttempts(int);
   }
 
+  public class VectorValue implements java.io.Serializable {
+    method @NonNull public double[] toArray();
+  }
+
   public class WriteBatch {
     method @NonNull public com.google.android.gms.tasks.Task<java.lang.Void> commit();
     method @NonNull public com.google.firebase.firestore.WriteBatch delete(@NonNull com.google.firebase.firestore.DocumentReference);

firebase-firestore/src/main/java/com/google/firebase/firestore/VectorValue.java

@@ -19,6 +19,10 @@
 import java.io.Serializable;
 import java.util.Arrays;
 
+/**
+ * Represent a vector type in Firestore documents.
+ * Create an instance with {@link FieldValue#vector(double[])}.
+ */
 public class VectorValue implements Serializable {
   private final double[] values;