-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathGoogle.Cloud.Firestore.xml
2882 lines (2882 loc) · 176 KB
/
Google.Cloud.Firestore.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<doc>
<assembly>
<name>Google.Cloud.Firestore</name>
</assembly>
<members>
<member name="T:Google.Cloud.Firestore.Blob">
<summary>
An immutable sequence of bytes.
</summary>
<remarks>
Although this is a struct, it's effectively just a wrapper around a Protobuf ByteString.
<c>default(Blob)</c> acts as if it had been constructed with <see cref="P:Google.Protobuf.ByteString.Empty"/>.
</remarks>
</member>
<member name="P:Google.Cloud.Firestore.Blob.ByteString">
<summary>
The underlying Protobuf ByteString.
</summary>
</member>
<member name="P:Google.Cloud.Firestore.Blob.Length">
<summary>
The length of the blob, in bytes.
</summary>
</member>
<member name="P:Google.Cloud.Firestore.Blob.Item(System.Int32)">
<summary>
Returns the byte at index <paramref name="index"/>.
</summary>
<param name="index">The index in the blob to return. Must be greater than or equal to 0, and less than <see cref="P:Google.Cloud.Firestore.Blob.Length"/>.</param>
<returns>The byte at index <paramref name="index"/>.</returns>
</member>
<member name="M:Google.Cloud.Firestore.Blob.FromByteString(Google.Protobuf.ByteString)">
<summary>
Constructs a new <see cref="T:Google.Cloud.Firestore.Blob"/> wrapping the given <see cref="P:Google.Cloud.Firestore.Blob.ByteString"/>.
</summary>
<param name="byteString">The ByteString to wrap. Must not be null.</param>
<returns>A new blob wrapping <paramref name="byteString"/>.</returns>
</member>
<member name="M:Google.Cloud.Firestore.Blob.CopyFrom(System.Byte[])">
<summary>
Constructs a new <see cref="T:Google.Cloud.Firestore.Blob"/> by copying the current content of <paramref name="bytes"/>.
</summary>
<param name="bytes">Byte array to copy.</param>
<returns>A new blob containing a copy of <paramref name="bytes"/>.</returns>
</member>
<member name="M:Google.Cloud.Firestore.Blob.Equals(System.Object)">
<inheritdoc />
</member>
<member name="M:Google.Cloud.Firestore.Blob.GetHashCode">
<inheritdoc />
</member>
<member name="M:Google.Cloud.Firestore.Blob.Equals(Google.Cloud.Firestore.Blob)">
<inheritdoc />
</member>
<member name="M:Google.Cloud.Firestore.Blob.op_Equality(Google.Cloud.Firestore.Blob,Google.Cloud.Firestore.Blob)">
<summary>
Operator overload to compare two Blob values for equality.
</summary>
<param name="lhs">Left value to compare</param>
<param name="rhs">Right value to compare</param>
<returns>true if <paramref name="lhs"/> is equal to <paramref name="rhs"/>; otherwise false.</returns>
</member>
<member name="M:Google.Cloud.Firestore.Blob.op_Inequality(Google.Cloud.Firestore.Blob,Google.Cloud.Firestore.Blob)">
<summary>
Operator overload to compare two Blob values for inequality.
</summary>
<param name="lhs">Left value to compare</param>
<param name="rhs">Right value to compare</param>
<returns>false if <paramref name="lhs"/> is equal to <paramref name="rhs"/>; otherwise true.</returns>
</member>
<member name="M:Google.Cloud.Firestore.Blob.ToString">
<inheritdoc />
</member>
<member name="T:Google.Cloud.Firestore.CollectionReference">
<summary>
A reference to a collection in a Firestore database. The existence of
this object does not imply that the collection currently exists in storage.
</summary>
</member>
<member name="P:Google.Cloud.Firestore.CollectionReference.Id">
<summary>
The final part of the complete collection path; this is the identity of
the collection relative to its parent document.
</summary>
</member>
<member name="P:Google.Cloud.Firestore.CollectionReference.Path">
<summary>
The complete collection path, including project and database ID.
</summary>
</member>
<member name="P:Google.Cloud.Firestore.CollectionReference.Parent">
<summary>
The parent document, or null if this is a root collection.
</summary>
</member>
<member name="M:Google.Cloud.Firestore.CollectionReference.Document">
<summary>
Creates a <see cref="T:Google.Cloud.Firestore.DocumentReference"/> for a direct child document of this collection with a random ID.
This performs no server-side operations; it only generates the appropriate <c>DocumentReference</c>.
</summary>
<returns>A <see cref="T:Google.Cloud.Firestore.DocumentReference"/> to a child document of this collection with a random ID.</returns>
</member>
<member name="M:Google.Cloud.Firestore.CollectionReference.Document(System.String)">
<summary>
Creates a <see cref="T:Google.Cloud.Firestore.DocumentReference"/> for a child document of this reference.
</summary>
<param name="path">The path to the document, relative to this collection. Must not be null, and must contain
an odd number of slash-separated path elements.</param>
<returns>A <see cref="T:Google.Cloud.Firestore.DocumentReference"/> for the specified document.</returns>
</member>
<member name="M:Google.Cloud.Firestore.CollectionReference.AddAsync(System.Object,System.Threading.CancellationToken)">
<summary>
Asynchronously creates a document with the given data in this collection. The document has a randomly generated ID.
</summary>
<remarks>
If the <see cref="T:Google.Cloud.Firestore.WriteResult"/> for the operation is required, use <see cref="M:Google.Cloud.Firestore.DocumentReference.CreateAsync(System.Object,System.Threading.CancellationToken)"/>
instead of this method.
</remarks>
<param name="documentData">The data for the document. Must not be null.</param>
<param name="cancellationToken">A cancellation token to monitor for the asynchronous operation.</param>
<returns>The reference for the newly-created document.</returns>
</member>
<member name="M:Google.Cloud.Firestore.CollectionReference.ListDocumentsAsync">
<summary>
Lists the documents in this collection. The results include documents which don't exist in their own right, but which have
nested documents which do exist.
</summary>
<returns>A lazily-iterated sequence of document references within this collection.</returns>
</member>
<member name="M:Google.Cloud.Firestore.CollectionReference.GetHashCode">
<inheritdoc />
</member>
<member name="M:Google.Cloud.Firestore.CollectionReference.Equals(System.Object)">
<inheritdoc />
</member>
<member name="M:Google.Cloud.Firestore.CollectionReference.Equals(Google.Cloud.Firestore.CollectionReference)">
<inheritdoc />
</member>
<member name="M:Google.Cloud.Firestore.CollectionReference.ToString">
<inheritdoc />
</member>
<member name="M:Google.Cloud.Firestore.CollectionReference.CompareTo(Google.Cloud.Firestore.CollectionReference)">
<inheritdoc />
</member>
<member name="T:Google.Cloud.Firestore.ConverterRegistry">
<summary>
Registry of custom converters. This is used to avoid requiring Firestore-specific attributes on types
which may be intended to be non-Firestore-specific. The registry may be specified when creating a <see cref="T:Google.Cloud.Firestore.FirestoreDb"/>
via <see cref="P:Google.Cloud.Firestore.FirestoreDbBuilder.ConverterRegistry"/>.
</summary>
</member>
<member name="M:Google.Cloud.Firestore.ConverterRegistry.Add``1(Google.Cloud.Firestore.IFirestoreConverter{``0})">
<summary>
Adds the given converter to the registry.
</summary>
<typeparam name="T">The type that <paramref name="converter"/> converts to/from.</typeparam>
<param name="converter">The converter to add.</param>
<exception cref="T:System.ArgumentException">There is already a converter in the registry for the given type.</exception>
</member>
<member name="M:Google.Cloud.Firestore.ConverterRegistry.System#Collections#IEnumerable#GetEnumerator">
<inheritdoc />
</member>
<member name="T:Google.Cloud.Firestore.Converters.AnonymousTypeConverter">
<summary>
A converter for an anonymous type. Currently this only performs serialization, not deserialization.
Using anonymous types for deserialization would be unusual in terms of the C# required, but not
entirely infeasible. We can implement this if we're ever asked for it.
</summary>
</member>
<member name="T:Google.Cloud.Firestore.Converters.ArrayConverter">
<summary>
Converter for array types. Serialization is handled by the base class; only custom deserialization is required.
</summary>
</member>
<member name="M:Google.Cloud.Firestore.Converters.AttributedIdAssigner.MaybeCreateAssigner(System.Type)">
<summary>
Returns an "ID assigner" suitable for the given BCL type, or null if the type isn't decorated with FirestoreDataAttribute,
or doesn't have any FirestoreDocumentId attributes.
</summary>
<param name="type">The type to inspect for ID properties.</param>
<returns>An assigner, or null if the type doesn't need any ID assignments performed on it.</returns>
</member>
<member name="T:Google.Cloud.Firestore.Converters.AttributedTimestampAssigner">
<summary>
Copies a snapshot's create/update/read timestamps to attributed properties.
</summary>
</member>
<member name="M:Google.Cloud.Firestore.Converters.AttributedTimestampAssigner.MaybeCreateAssigner(System.Type)">
<summary>
Returns an action (potentially multicast) to copy timestamps from a document snapshot to object properties.
</summary>
<param name="type">The type to inspect for ID properties.</param>
<returns>An assigner, or null if the type doesn't need any timestamp assignments performed on it.</returns>
</member>
<member name="M:Google.Cloud.Firestore.Converters.AttributedTypeConverter.ForType(System.Type)">
<summary>
Factory method to construct a converter for an attributed type.
</summary>
</member>
<member name="P:Google.Cloud.Firestore.Converters.AttributedTypeConverter.AttributedProperty.FirestoreName">
<summary>
The name to use in Firestore serialization/deserialization. Defaults to the property
name, but may be specified in <see cref="T:Google.Cloud.Firestore.FirestorePropertyAttribute"/>.
</summary>
</member>
<member name="T:Google.Cloud.Firestore.Converters.ConverterBase">
<summary>
A base class for many converters, allowing them to simply override the method for the one
deserialization case required. Serializing to a single value has to be implemented; serializing
to a map will fail with an exception unless <see cref="M:Google.Cloud.Firestore.Converters.ConverterBase.SerializeMap(Google.Cloud.Firestore.SerializationContext,System.Object,System.Collections.Generic.IDictionary{System.String,Google.Cloud.Firestore.V1.Value})"/>
is overridden.
</summary>
</member>
<member name="T:Google.Cloud.Firestore.Converters.ConverterCache">
<summary>
A cache for serializers based on the target type. Some are prepopulated (e.g. for protos and
primitives); one for anonymous and attributed types are added on demand.
</summary>
</member>
<member name="M:Google.Cloud.Firestore.Converters.ConverterCache.TryGetStringDictionaryValueType(System.Type)">
<summary>
If <paramref name="type"/> implements (or is) <see cref="T:System.Collections.Generic.IDictionary`2"/> with TKey equal to string, returns TValue.
Otherwise, returns null.
</summary>
</member>
<member name="M:Google.Cloud.Firestore.Converters.ConverterCache.TryGetListType(System.Type)">
<summary>
If <paramref name="targetType"/> is a type that implements <see cref="T:System.Collections.Generic.IEnumerable`1"/>, we check to see if <see cref="T:System.Collections.Generic.List`1"/> is
compatible with the target type.
</summary>
<param name="targetType"></param>
<returns>null if <paramref name="targetType"/> cannot be implemented via <see cref="T:System.Collections.Generic.List`1"/>; the list type otherwise.</returns>
</member>
<member name="T:Google.Cloud.Firestore.Converters.CustomConverter`1">
<summary>
A converter that wraps a user-specified <see cref="T:Google.Cloud.Firestore.IFirestoreConverter`1"/>.
</summary>
</member>
<member name="T:Google.Cloud.Firestore.Converters.DictionaryConverter`1">
<summary>
Base class for dictionary-based map values.
</summary>
<typeparam name="TValue">Type of values in the dictionary.</typeparam>
</member>
<member name="T:Google.Cloud.Firestore.Converters.EnumConverter">
<summary>
A converter for a specific enum type.
</summary>
</member>
<member name="T:Google.Cloud.Firestore.Converters.IFirestoreInternalConverter">
<summary>
Internal interface all converters support.
</summary>
</member>
<member name="M:Google.Cloud.Firestore.Converters.IFirestoreInternalConverter.DeserializeValue(Google.Cloud.Firestore.DeserializationContext,Google.Cloud.Firestore.V1.Value)">
<summary>
Deserializes a single (possibly map- or list-based) Firestore value to a POCO.
</summary>
<param name="context">The context for the deserialization operation. Never null.</param>
<param name="value">The Firestore value to deserialize. Never null.</param>
<returns>The deserialized value. Should never be null.</returns>
</member>
<member name="M:Google.Cloud.Firestore.Converters.IFirestoreInternalConverter.DeserializeMap(Google.Cloud.Firestore.DeserializationContext,System.Collections.Generic.IDictionary{System.String,Google.Cloud.Firestore.V1.Value})">
<summary>
Deserializes a map (as a dictionary of name/value pairs) to a POCO.
</summary>
<param name="context">The context for the deserialization operation. Never null.</param>
<param name="values">The name/value pairs to deserialize. Never null.</param>
<returns>The deserialized value. Should never be null.</returns>
</member>
<member name="M:Google.Cloud.Firestore.Converters.IFirestoreInternalConverter.Serialize(Google.Cloud.Firestore.SerializationContext,System.Object)">
<summary>
Serializes a single POCO to a Firestore representation.
</summary>
<param name="context"></param>
<param name="value">The value to serialize. Never null.</param>
<returns>The serialized value. Should never be null.</returns>
</member>
<member name="M:Google.Cloud.Firestore.Converters.IFirestoreInternalConverter.SerializeMap(Google.Cloud.Firestore.SerializationContext,System.Object,System.Collections.Generic.IDictionary{System.String,Google.Cloud.Firestore.V1.Value})">
<summary>
Populates a map based on the serialized form of a POCO.
</summary>
<remarks>
Logically this could return a dictionary instead, but it's more efficient to populate an existing map.
</remarks>
<param name="context"></param>
<param name="value">The value to serialize. Never null.</param>
<param name="map">The map to populate. Never null.</param>
</member>
<member name="T:Google.Cloud.Firestore.Converters.ListConverter">
<summary>
Converter for <see cref="T:System.Collections.IList"/>-based types. (Note that this doesn't handle types that
implement the generic <see cref="T:System.Collections.Generic.IList`1"/> interface without the non-generic one.)
This type handles deserialization; the base type handles serialization.
</summary>
</member>
<member name="T:Google.Cloud.Firestore.Converters.ListConverterBase">
<summary>
Base class for types that always serialize to a list value. This type handles serialization
by assuming the type implements <see cref="T:System.Collections.IEnumerable"/> and simply serializing each element; derived types
need to perform deserialization.
</summary>
</member>
<member name="T:Google.Cloud.Firestore.Converters.MapConverterBase">
<summary>
Base class for types that always serialize to a map value.
Derived classes need to implement deserialization as well as overriding
<see cref="M:Google.Cloud.Firestore.Converters.ConverterBase.SerializeMap(Google.Cloud.Firestore.SerializationContext,System.Object,System.Collections.Generic.IDictionary{System.String,Google.Cloud.Firestore.V1.Value})"/>,
which is called by this class's implementation of <see cref="M:Google.Cloud.Firestore.Converters.MapConverterBase.Serialize(Google.Cloud.Firestore.SerializationContext,System.Object)"/>.
</summary>
</member>
<member name="T:Google.Cloud.Firestore.Converters.SequenceConverter">
<summary>
List converter that only supports serialization. This is used by
<see cref="T:Google.Cloud.Firestore.Converters.ConverterCache"/> as a final option when we know something can
be iterated over, but that's all. We can't deserialize to it, but that may well be okay.
</summary>
</member>
<member name="M:Google.Cloud.Firestore.Converters.ValueTupleConverter.MaybeCreateConverter(System.Reflection.PropertyInfo)">
<summary>
Creates a converter for the given property if it is a suitable property for a value tuple conversion.
</summary>
</member>
<member name="T:Google.Cloud.Firestore.DeserializationContext">
<summary>
Provides context for deserialization operations.
</summary>
</member>
<member name="P:Google.Cloud.Firestore.DeserializationContext.Database">
<summary>
The database containing the document being deserialized. This is never null.
</summary>
</member>
<member name="P:Google.Cloud.Firestore.DeserializationContext.DocumentReference">
<summary>
The document being deserialized. This is never null.
</summary>
</member>
<member name="P:Google.Cloud.Firestore.DeserializationContext.Snapshot">
<summary>
The document snapshot being deserialized. This is never null.
</summary>
</member>
<member name="M:Google.Cloud.Firestore.DeserializationContext.#ctor(Google.Cloud.Firestore.DocumentSnapshot)">
<summary>
Constructs a new context.
</summary>
<param name="snapshot">The document snapshot being deserialized. Must not be null.</param>
</member>
<member name="T:Google.Cloud.Firestore.DocumentChange">
<summary>
A DocumentChange represents a change to the documents matching a query. It contains the document
affected and a the type of change that occurred (added, modifed, or removed).
</summary>
</member>
<member name="T:Google.Cloud.Firestore.DocumentChange.Type">
<summary>
An enumeration of snapshot change types.
</summary>
</member>
<member name="F:Google.Cloud.Firestore.DocumentChange.Type.Added">
<summary>
Indicates a new document was added to the set of documents matching the query.
</summary>
</member>
<member name="F:Google.Cloud.Firestore.DocumentChange.Type.Removed">
<summary>
Indicates a document within the query was removed (either deleted or no longer matches the query.
</summary>
</member>
<member name="F:Google.Cloud.Firestore.DocumentChange.Type.Modified">
<summary>
Indicates a document within the query was modified.
</summary>
</member>
<member name="P:Google.Cloud.Firestore.DocumentChange.Document">
<summary>
The newly added or modified document, or the document that was deleted.
</summary>
</member>
<member name="P:Google.Cloud.Firestore.DocumentChange.ChangeType">
<summary>
The type of change that was observed.
</summary>
</member>
<member name="P:Google.Cloud.Firestore.DocumentChange.OldIndex">
<summary>
The index of the changed document in the result set immediately prior to this DocumentChange
(i.e. supposing that all prior DocumentChange objects have been applied), or null
if the change type is <see cref="F:Google.Cloud.Firestore.DocumentChange.Type.Added"/>. The index will never be negative.
</summary>
</member>
<member name="P:Google.Cloud.Firestore.DocumentChange.NewIndex">
<summary>
The index of the changed document in the result set immediately after this DocumentChange
(i.e. supposing that all prior DocumentChange objects and this one have been applied),
null if the change type is <see cref="F:Google.Cloud.Firestore.DocumentChange.Type.Removed"/>. The index will never be negative.
</summary>
</member>
<member name="M:Google.Cloud.Firestore.DocumentChange.Equals(Google.Cloud.Firestore.DocumentChange)">
<summary>
Compares this snapshot with another for equality. Only the document data and document reference
are considered; the timestamps are ignored.
</summary>
<param name="other">The snapshot to compare this one with</param>
<returns><c>true</c> if this snapshot is equal to <paramref name="other"/>; <c>false</c> otherwise.</returns>
</member>
<member name="M:Google.Cloud.Firestore.DocumentChange.Equals(System.Object)">
<inheritdoc />
</member>
<member name="M:Google.Cloud.Firestore.DocumentChange.GetHashCode">
<inheritdoc />
</member>
<member name="T:Google.Cloud.Firestore.DocumentReference">
<summary>
A reference to a document in a Firestore database. The existence of
this object does not imply that the document currently exists in storage.
</summary>
</member>
<member name="P:Google.Cloud.Firestore.DocumentReference.Database">
<summary>
The database which contains the document.
</summary>
</member>
<member name="P:Google.Cloud.Firestore.DocumentReference.Id">
<summary>
The final part of the complete document path; this is the identity of
the document relative to its parent collection.
</summary>
</member>
<member name="P:Google.Cloud.Firestore.DocumentReference.Path">
<summary>
The complete document path, including project and database ID.
</summary>
</member>
<member name="P:Google.Cloud.Firestore.DocumentReference.Parent">
<summary>
The parent collection. Never null.
</summary>
</member>
<member name="M:Google.Cloud.Firestore.DocumentReference.Collection(System.String)">
<summary>
Creates a <see cref="T:Google.Cloud.Firestore.CollectionReference"/> for a child collection of this document.
</summary>
<param name="path">The path to the collection, relative to this document. Must not be null, and must contain
an odd number of slash-separated path elements.</param>
<returns>A <see cref="T:Google.Cloud.Firestore.CollectionReference"/> for the specified collection.</returns>
</member>
<member name="M:Google.Cloud.Firestore.DocumentReference.GetHashCode">
<inheritdoc />
</member>
<member name="M:Google.Cloud.Firestore.DocumentReference.Equals(System.Object)">
<inheritdoc />
</member>
<member name="M:Google.Cloud.Firestore.DocumentReference.Equals(Google.Cloud.Firestore.DocumentReference)">
<inheritdoc />
</member>
<member name="M:Google.Cloud.Firestore.DocumentReference.ToString">
<inheritdoc />
</member>
<member name="M:Google.Cloud.Firestore.DocumentReference.CompareTo(Google.Cloud.Firestore.DocumentReference)">
<inheritdoc />
</member>
<member name="M:Google.Cloud.Firestore.DocumentReference.CreateAsync(System.Object,System.Threading.CancellationToken)">
<summary>
Asynchronously creates a document on the server with the given data. The document must not exist beforehand.
</summary>
<param name="documentData">The data for the document. Must not be null.</param>
<param name="cancellationToken">A cancellation token to monitor for the asynchronous operation.</param>
<returns>The write result of the server operation.</returns>
</member>
<member name="M:Google.Cloud.Firestore.DocumentReference.DeleteAsync(Google.Cloud.Firestore.Precondition,System.Threading.CancellationToken)">
<summary>
Asynchronously deletes the document referred to by this path, with an optional precondition.
</summary>
<remarks>
If no precondition is specified and the document doesn't exist, this returned task will succeed. If a precondition
is specified and not met, the returned task will fail with an <see cref="T:Grpc.Core.RpcException"/>.
</remarks>
<param name="precondition">Optional precondition for deletion. May be null, in which case the deletion is unconditional.</param>
<param name="cancellationToken">A cancellation token to monitor for the asynchronous operation.</param>
<returns>The write result of the server operation.</returns>
</member>
<member name="M:Google.Cloud.Firestore.DocumentReference.UpdateAsync(System.Collections.Generic.IDictionary{System.String,System.Object},Google.Cloud.Firestore.Precondition,System.Threading.CancellationToken)">
<summary>
Asynchronously performs a set of updates on the document referred to by this path, with an optional precondition.
</summary>
<param name="updates">The updates to perform on the document, keyed by the dot-separated field path to update. Fields not present in this dictionary are not updated. Must not be null or empty.</param>
<param name="precondition">Optional precondition for updating the document. May be null, which is equivalent to <see cref="P:Google.Cloud.Firestore.Precondition.MustExist"/>.</param>
<param name="cancellationToken">A cancellation token to monitor for the asynchronous operation.</param>
<returns>The write result of the server operation.</returns>
</member>
<member name="M:Google.Cloud.Firestore.DocumentReference.UpdateAsync(System.String,System.Object,Google.Cloud.Firestore.Precondition,System.Threading.CancellationToken)">
<summary>
Asynchronously performs a single field update on the document referred to by this path, with an optional precondition.
</summary>
<param name="field">The dot-separated name of the field to update. Must not be null.</param>
<param name="value">The new value for the field. May be null.</param>
<param name="precondition">Optional precondition for updating the document. May be null, which is equivalent to <see cref="P:Google.Cloud.Firestore.Precondition.MustExist"/>.</param>
<param name="cancellationToken">A cancellation token to monitor for the asynchronous operation.</param>
<returns>The write result of the server operation.</returns>
</member>
<member name="M:Google.Cloud.Firestore.DocumentReference.UpdateAsync(System.Collections.Generic.IDictionary{Google.Cloud.Firestore.FieldPath,System.Object},Google.Cloud.Firestore.Precondition,System.Threading.CancellationToken)">
<summary>
Asynchronously performs a set of updates on the document referred to by this path, with an optional precondition.
</summary>
<param name="updates">The updates to perform on the document, keyed by the field path to update. Fields not present in this dictionary are not updated. Must not be null or empty.</param>
<param name="precondition">Optional precondition for updating the document. May be null, which is equivalent to <see cref="P:Google.Cloud.Firestore.Precondition.MustExist"/>.</param>
<param name="cancellationToken">A cancellation token to monitor for the asynchronous operation.</param>
<returns>The write result of the server operation.</returns>
</member>
<member name="M:Google.Cloud.Firestore.DocumentReference.SetAsync(System.Object,Google.Cloud.Firestore.SetOptions,System.Threading.CancellationToken)">
<summary>
Asynchronously sets data in the document, either replacing it completely or merging fields.
</summary>
<param name="documentData">The data to store in the document. Must not be null.</param>
<param name="options">The options to use when updating the document. May be null, which is equivalent to <see cref="P:Google.Cloud.Firestore.SetOptions.Overwrite"/>.</param>
<param name="cancellationToken">A cancellation token to monitor for the asynchronous operation.</param>
<returns>The write result of the server operation.</returns>
</member>
<member name="M:Google.Cloud.Firestore.DocumentReference.GetSnapshotAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously fetches a snapshot of the document.
</summary>
<returns>A snapshot of the document. The snapshot may represent a missing document.</returns>
</member>
<member name="M:Google.Cloud.Firestore.DocumentReference.GetSnapshotAsync(Google.Protobuf.ByteString,System.Threading.CancellationToken)">
<summary>
Asynchronously fetches a snapshot of the document.
</summary>
<returns>A snapshot of the document. The snapshot may represent a missing document.</returns>
</member>
<member name="M:Google.Cloud.Firestore.DocumentReference.ListCollectionsAsync">
<summary>
Retrieves the collections within this document.
</summary>
<returns>A lazily-iterated sequence of collection references within this document.</returns>
</member>
<member name="M:Google.Cloud.Firestore.DocumentReference.Listen(System.Func{Google.Cloud.Firestore.DocumentSnapshot,System.Threading.CancellationToken,System.Threading.Tasks.Task},System.Threading.CancellationToken)">
<summary>
Watch this document for changes.
</summary>
<param name="callback">The callback to invoke each time the document changes. Must not be null.</param>
<param name="cancellationToken">Optional cancellation token which may be used to cancel the listening operation.</param>
<returns>A <see cref="T:Google.Cloud.Firestore.FirestoreChangeListener"/> which may be used to monitor the listening operation and stop it gracefully.</returns>
</member>
<member name="M:Google.Cloud.Firestore.DocumentReference.Listen(System.Action{Google.Cloud.Firestore.DocumentSnapshot},System.Threading.CancellationToken)">
<summary>
Watch this document for changes. This method is a convenience method over <see cref="M:Google.Cloud.Firestore.DocumentReference.Listen(System.Func{Google.Cloud.Firestore.DocumentSnapshot,System.Threading.CancellationToken,System.Threading.Tasks.Task},System.Threading.CancellationToken)"/>,
wrapping a synchronous callback to create an asynchronous one.
</summary>
<param name="callback">The callback to invoke each time the query results change. Must not be null.</param>
<param name="cancellationToken">Optional cancellation token which may be used to cancel the listening operation.</param>
<returns>A <see cref="T:Google.Cloud.Firestore.FirestoreChangeListener"/> which may be used to monitor the listening operation and stop it gracefully.</returns>
</member>
<member name="T:Google.Cloud.Firestore.DocumentSet">
<summary>
Immutable set of DocumentSnapshots, ordered by a custom comparer.
</summary>
</member>
<member name="T:Google.Cloud.Firestore.DocumentSnapshot">
<summary>
An immutable snapshot of the data for a document.
</summary>
</member>
<member name="P:Google.Cloud.Firestore.DocumentSnapshot.Document">
<summary>
The proto representation of the document. Primarily visible for testing purposes.
</summary>
</member>
<member name="P:Google.Cloud.Firestore.DocumentSnapshot.Reference">
<summary>
The full reference to the document.
</summary>
</member>
<member name="P:Google.Cloud.Firestore.DocumentSnapshot.Database">
<summary>
The database that owns the document.
</summary>
</member>
<member name="P:Google.Cloud.Firestore.DocumentSnapshot.Id">
<summary>
The ID of the document.
</summary>
</member>
<member name="P:Google.Cloud.Firestore.DocumentSnapshot.Exists">
<summary>
Whether or not the document exists.
</summary>
</member>
<member name="P:Google.Cloud.Firestore.DocumentSnapshot.CreateTime">
<summary>
The creation time of the document if it exists, or null otherwise.
</summary>
</member>
<member name="P:Google.Cloud.Firestore.DocumentSnapshot.UpdateTime">
<summary>
The update time of the document if it exists, or null otherwise.
</summary>
</member>
<member name="P:Google.Cloud.Firestore.DocumentSnapshot.ReadTime">
<summary>
The time at which this snapshot was read.
</summary>
</member>
<member name="M:Google.Cloud.Firestore.DocumentSnapshot.ToDictionary">
<summary>
Returns the document data as a <see cref="T:System.Collections.Generic.Dictionary`2"/>.
</summary>
<exception cref="T:System.InvalidOperationException">This snapshot represents a missing document, i.e. <see cref="P:Google.Cloud.Firestore.DocumentSnapshot.Exists"/> is false.</exception>
<returns>A <see cref="T:System.Collections.Generic.Dictionary`2"/> containing the document data, or null if this object represents a missing document.</returns>
</member>
<member name="M:Google.Cloud.Firestore.DocumentSnapshot.ConvertTo``1">
<summary>
Deserializes the document data as the specified type.
</summary>
<typeparam name="T">The type to deserialize the document data as.</typeparam>
<returns>The deserialized data, or null if this object represents a missing document.</returns>
</member>
<member name="M:Google.Cloud.Firestore.DocumentSnapshot.GetValue``1(System.String)">
<summary>
Fetches a field value from the document, throwing an exception if the field does not exist.
</summary>
<param name="path">The dot-separated field path to fetch. Must not be null or empty</param>
<exception cref="T:System.InvalidOperationException">The field does not exist in the document data.</exception>
<returns>The deserialized value.</returns>
</member>
<member name="M:Google.Cloud.Firestore.DocumentSnapshot.TryGetValue``1(System.String,``0@)">
<summary>
Attempts to fetch the given field path from the document, returning whether or not it was found, and deserializing
it if it was found.
</summary>
<remarks>
This method does not throw an exception if the field is not found, but does throw an exception if the field was found
but cannot be deserialized.
</remarks>
<typeparam name="T">The type to deserialize the value to, if it is found.</typeparam>
<param name="path">The dot-separated field path to fetch. Must not be null or empty</param>
<param name="value">When this method returns, contains the deserialized value if the field was found, or the default value
of <typeparamref name="T"/> otherwise.</param>
<returns>true if the field was found; false otherwise.</returns>
</member>
<member name="M:Google.Cloud.Firestore.DocumentSnapshot.GetValue``1(Google.Cloud.Firestore.FieldPath)">
<summary>
Fetches a field value from the document, throwing an exception if the field does not exist.
</summary>
<param name="path">The field path to fetch. Must not be null.</param>
<exception cref="T:System.InvalidOperationException">The field does not exist in the document data.</exception>
<returns>The deserialized value.</returns>
</member>
<member name="M:Google.Cloud.Firestore.DocumentSnapshot.TryGetValue``1(Google.Cloud.Firestore.FieldPath,``0@)">
<summary>
Attempts to fetch the given field path from the document, returning whether or not it was found, and deserializing
it if it was found.
</summary>
<remarks>
This method does not throw an exception if the field is not found, but does throw an exception if the field was found
but cannot be deserialized.
</remarks>
<typeparam name="T">The type to deserialize the value to, if it is found.</typeparam>
<param name="path">The field path to fetch. Must not be null.</param>
<param name="value">When this method returns, contains the deserialized value if the field was found, or the default value
of <typeparamref name="T"/> otherwise.</param>
<returns>true if the field was found; false otherwise.</returns>
</member>
<member name="M:Google.Cloud.Firestore.DocumentSnapshot.ContainsField(System.String)">
<summary>
Determines whether or not the given field path is present in the document. If this snapshot represents
a missing document, this method will always return false.
</summary>
<param name="path">The dot-separated field path to check. Must not be null or empty.</param>
<returns>true if the specified path represents a field in the document; false otherwise</returns>
</member>
<member name="M:Google.Cloud.Firestore.DocumentSnapshot.ContainsField(Google.Cloud.Firestore.FieldPath)">
<summary>
Determines whether or not the given field path is present in the document. If this snapshot represents
a missing document, this method will always return false.
</summary>
<param name="path">The field path to check. Must not be null.</param>
<returns>true if the specified path represents a field in the document; false otherwise</returns>
</member>
<member name="M:Google.Cloud.Firestore.DocumentSnapshot.ExtractValue(Google.Cloud.Firestore.FieldPath)">
<summary>
Extracts the internal value for a field path, still in its serialized form, without any copying.
If the document is missing or the field isn't present, this will return null.
</summary>
</member>
<member name="M:Google.Cloud.Firestore.DocumentSnapshot.Equals(Google.Cloud.Firestore.DocumentSnapshot)">
<summary>
Compares this snapshot with another for equality. Only the document data and document reference
are considered; the timestamps are ignored.
</summary>
<param name="other">The snapshot to compare this one with</param>
<returns><c>true</c> if this snapshot is equal to <paramref name="other"/>; <c>false</c> otherwise.</returns>
</member>
<member name="M:Google.Cloud.Firestore.DocumentSnapshot.Equals(System.Object)">
<inheritdoc />
</member>
<member name="M:Google.Cloud.Firestore.DocumentSnapshot.GetHashCode">
<inheritdoc />
</member>
<member name="T:Google.Cloud.Firestore.FieldMask">
<summary>
An immutable set of field paths, used to limit the data returned by calls to
<see cref="M:Google.Cloud.Firestore.FirestoreDb.GetAllSnapshotsAsync(System.Collections.Generic.IEnumerable{Google.Cloud.Firestore.DocumentReference},System.Threading.CancellationToken)"/>
and similar calls.
</summary>
</member>
<member name="M:Google.Cloud.Firestore.FieldMask.#ctor(System.String[])">
<summary>
Creates a mask from the given paths. Each path is treated as a dot-separated sequence of field names.
</summary>
<param name="paths">The paths, as dot-separated strings. This must not be null, and it must not contain any null or empty elements.</param>
</member>
<member name="M:Google.Cloud.Firestore.FieldMask.#ctor(Google.Cloud.Firestore.FieldPath[])">
<summary>
Creates a mask from the given paths.
</summary>
<param name="paths">The segments of the path. This must not be null, and it must not contain any null elements.</param>
</member>
<member name="M:Google.Cloud.Firestore.FieldMask.GetHashCode">
<inheritdoc />
</member>
<member name="M:Google.Cloud.Firestore.FieldMask.Equals(System.Object)">
<inheritdoc />
</member>
<member name="M:Google.Cloud.Firestore.FieldMask.Equals(Google.Cloud.Firestore.FieldMask)">
<inheritdoc />
</member>
<member name="T:Google.Cloud.Firestore.FieldPath">
<summary>
An immutable path of field names, used to identify parts of a document.
</summary>
<remarks>
Ordering between field paths is primarily to provide canonical orderings for sets of
paths, for example in a <see cref="T:Google.Cloud.Firestore.FieldMask"/>. This ordering is performed segment-wise,
using ordinal string comparisons.
</remarks>
</member>
<member name="F:Google.Cloud.Firestore.FieldPath.s_prohibitedCharacters">
<summary>
Characters prohibited within dot-separated field paths.
</summary>
</member>
<member name="P:Google.Cloud.Firestore.FieldPath.DocumentId">
<summary>
Sentinel field path to refer to the ID of a document. Used in queries to sort or filter
by the document ID.
</summary>
</member>
<member name="P:Google.Cloud.Firestore.FieldPath.Empty">
<summary>
An empty field path, appropriate for appending
</summary>
</member>
<member name="P:Google.Cloud.Firestore.FieldPath.Segments">
<summary>
Segments of the path: do not mutate or expose publicly!
</summary>
</member>
<member name="M:Google.Cloud.Firestore.FieldPath.#ctor(System.String[],System.Boolean)">
<summary>
Constructor that trusts the value
</summary>
<param name="segments">The segments</param>
<param name="trusted">True to bypass both copying and validation; false otherwise.</param>
</member>
<member name="M:Google.Cloud.Firestore.FieldPath.#ctor(System.String[])">
<summary>
Creates a path from multiple segments. Each segment is treated verbatim: it may contain dots, which will lead to the segment being escaped in the
path's string representation.
</summary>
<param name="segments">The segments of the path. This must not be null or empty, and it must not contain any null or empty elements.</param>
</member>
<member name="M:Google.Cloud.Firestore.FieldPath.Append(System.String)">
<summary>
Creates a new path from this one, with the specified segment appended.
</summary>
<param name="segment">The segment to append. Must not be null or empty.</param>
</member>
<member name="M:Google.Cloud.Firestore.FieldPath.IsValidIdentifier(System.String)">
<summary>
Return true if the string could be used as a segment in a field path without escaping. Valid
identifiers follow the regex [a-zA-Z_][a-zA-Z0-9_]*.
(Using a regular expression is significantly slower though.)
</summary>
</member>
<member name="M:Google.Cloud.Firestore.FieldPath.ToString">
<inheritdoc />
</member>
<member name="M:Google.Cloud.Firestore.FieldPath.Equals(System.Object)">
<inheritdoc />
</member>
<member name="M:Google.Cloud.Firestore.FieldPath.GetHashCode">
<inheritdoc />
</member>
<member name="M:Google.Cloud.Firestore.FieldPath.Equals(Google.Cloud.Firestore.FieldPath)">
<inheritdoc />
</member>
<member name="M:Google.Cloud.Firestore.FieldPath.CompareTo(Google.Cloud.Firestore.FieldPath)">
<inheritdoc />
</member>
<member name="M:Google.Cloud.Firestore.FieldPath.ToFieldReference">
<summary>
Conversion from FieldPath to FieldReference.
</summary>
</member>
<member name="M:Google.Cloud.Firestore.FieldPath.IsPrefixOf(Google.Cloud.Firestore.FieldPath)">
<summary>
Checks whether the specified path starts with the same path segments as this path. A path
is considered a prefix of itself, in the way that "a".StartsWith("a") returns true.
</summary>
</member>
<member name="T:Google.Cloud.Firestore.FieldValue">
<summary>
A static class providing properties and methods to represent sentinel values.
Sentinel values are special values where the client-side value is not part of the
document modification sent to the server. A property decorated with
<see cref="T:Google.Cloud.Firestore.FirestorePropertyAttribute"/> can specify an additional attribute
to indicate that it's a sentinel value, such as a<see cref="T:Google.Cloud.Firestore.ServerTimestampAttribute"/>,
or the sentinel values returned by the members of this class can be used directly as
values to be serialized (for example, in anonymous types), and they will be handled
directly by the serialization mechanism.
</summary>
</member>
<member name="P:Google.Cloud.Firestore.FieldValue.ServerTimestamp">
<summary>
Sentinel value indicating that the field should be set to the timestamp of the
commit that creates or modifies the document.
</summary>
</member>
<member name="P:Google.Cloud.Firestore.FieldValue.Delete">
<summary>
Sentinel value indicating that the field should be deleted from the document.
</summary>
</member>
<member name="M:Google.Cloud.Firestore.FieldValue.ArrayUnion(System.Object[])">
<summary>
Creates a sentinel value to indicate the union of the given values with an array.
This overload assumes that any custom serializers are configured via attributes. Use the overload
accepting a <see cref="T:Google.Cloud.Firestore.FirestoreDb" /> if you need to use database-registered custom serializers.
</summary>
<param name="values">The values to include in the resulting sentinel value. Must not be null.</param>
<returns>A sentinel value representing an array union.</returns>
</member>
<member name="M:Google.Cloud.Firestore.FieldValue.ArrayRemove(System.Object[])">
<summary>
Creates a sentinel value to indicate the removal of the given values with an array.
This overload assumes that any custom serializers are configured via attributes. Use the overload
accepting a <see cref="T:Google.Cloud.Firestore.FirestoreDb" /> if you need to use database-registered custom serializers.
</summary>
<param name="values">The values to include in the resulting sentinel value. Must not be null.</param>
<returns>A sentinel value representing an array removal.</returns>
</member>
<member name="M:Google.Cloud.Firestore.FieldValue.ArrayUnion(Google.Cloud.Firestore.FirestoreDb,System.Object[])">
<summary>
Creates a sentinel value to indicate the union of the given values with an array.
</summary>
<param name="database">Database to check for custom serialization.</param>
<param name="values">The values to include in the resulting sentinel value. Must not be null.</param>
<returns>A sentinel value representing an array union.</returns>
</member>
<member name="M:Google.Cloud.Firestore.FieldValue.ArrayRemove(Google.Cloud.Firestore.FirestoreDb,System.Object[])">
<summary>
Creates a sentinel value to indicate the removal of the given values with an array. This over
</summary>
<param name="database">Database to check for custom serialization.</param>
<param name="values">The values to include in the resulting sentinel value. Must not be null.</param>
<returns>A sentinel value representing an array removal.</returns>
</member>
<member name="M:Google.Cloud.Firestore.FieldValue.Increment(System.Int64)">
<summary>
Creates a sentinel value to indicate an increment by the given value.
</summary>
<remarks>
<para>
If the current field value is an integer, possible integer overflows are resolved to
<see cref="F:System.Int64.MaxValue"/> or <see cref="F:System.Int64.MinValue"/>. If the current field value
is a double, both values will be interpreted as doubles and the arithmetic will follow IEEE 754 semantics.
</para>
<para>
If the current field is not an integer or double, or if the field does not yet exist, the
transformation will set the field to the given value.
</para>
</remarks>
<param name="amount">The amount to increment the field by.</param>
<returns>A sentinel value representing a field increment.</returns>
</member>
<member name="M:Google.Cloud.Firestore.FieldValue.Increment(System.Double)">
<summary>
Creates a sentinel value to indicate an increment by the given value.
</summary>
<remarks>
<para>
If the current value is an integer or a double, both the current and the given value will be
interpreted as doubles and all arithmetic will follow IEEE 754 semantics.Otherwise, the
transformation will set the field to the given value.
</para>
</remarks>
<param name="amount">The amount to increment the field by.</param>
<returns>A sentinel value representing a field increment.</returns>
</member>
<member name="T:Google.Cloud.Firestore.FirestoreChangeListener">
<summary>
An ongoing "listen" or "watch" operation on either document or query snapshots.
This is returned from <c>Listen</c> methods.
</summary>
</member>
<member name="P:Google.Cloud.Firestore.FirestoreChangeListener.ListenerTask">
<summary>
A task that will complete when the listen operation finishes.
</summary>
<remarks>
If a cancellation token provided by the caller (either when starting to listen or
when calling <see cref="M:Google.Cloud.Firestore.FirestoreChangeListener.StopAsync(System.Threading.CancellationToken)"/>) is canceled, the task will finish in a state of <see cref="F:System.Threading.Tasks.TaskStatus.Canceled"/>.
The task will finish in a state of <see cref="F:System.Threading.Tasks.TaskStatus.Faulted"/> if any other kind of exception was thrown, including
any non-retriable RPC exceptions. The task will finish in a state of <see cref="F:System.Threading.Tasks.TaskStatus.RanToCompletion"/> if
the listener stopped gracefully.
</remarks>
</member>
<member name="M:Google.Cloud.Firestore.FirestoreChangeListener.StopAsync(System.Threading.CancellationToken)">
<summary>
Requests that the client stops listening for changes. If a callback is in progress,
that will be allowed to complete, but cancelling <paramref name="cancellationToken"/> will
cancel the token passed to the callback, allowing for prompt cancellation if required.
</summary>
<remarks>This method must only be called once per listener.</remarks>
<param name="cancellationToken">A cancellation token to cancel a callback if one is in progress.</param>
<returns>The task to indicate listener completion. This returns the same as <see cref="P:Google.Cloud.Firestore.FirestoreChangeListener.ListenerTask"/>.</returns>
</member>
<member name="T:Google.Cloud.Firestore.FirestoreDataAttribute">
<summary>
Attribute indicating that a type is intended to be used with Firestore.
</summary>
</member>
<member name="P:Google.Cloud.Firestore.FirestoreDataAttribute.UnknownPropertyHandling">
<summary>
The strategy to use when handling unknown properties. The default is
<see cref="F:Google.Cloud.Firestore.UnknownPropertyHandling.Warn"/>.
</summary>
</member>
<member name="P:Google.Cloud.Firestore.FirestoreDataAttribute.ConverterType">
<summary>
A custom converter type to use for serializing and deserializing the attributed type.
</summary>
</member>
<member name="M:Google.Cloud.Firestore.FirestoreDataAttribute.#ctor">
<summary>
Constructs a new instance with default values for options.
</summary>
</member>
<member name="M:Google.Cloud.Firestore.FirestoreDataAttribute.#ctor(Google.Cloud.Firestore.UnknownPropertyHandling)">
<summary>
Constructs a new instance with the given handling for unknown properties.
</summary>
<param name="unknownPropertyHandling">The unknown property handling strategy to use.</param>
</member>
<member name="T:Google.Cloud.Firestore.FirestoreDb">
<summary>
A Firestore database. Create instances using the static <see cref="M:Google.Cloud.Firestore.FirestoreDb.Create(System.String,Google.Cloud.Firestore.V1.FirestoreClient)"/> and <see cref="M:Google.Cloud.Firestore.FirestoreDb.CreateAsync(System.String,Google.Cloud.Firestore.V1.FirestoreClient)"/>
methods, or using a <see cref="T:Google.Cloud.Firestore.FirestoreDbBuilder"/>.
</summary>
</member>
<member name="P:Google.Cloud.Firestore.FirestoreDb.Client">
<summary>
The underlying client used to make service requests.
</summary>
</member>
<member name="P:Google.Cloud.Firestore.FirestoreDb.ProjectId">
<summary>
The project ID associated with this database.
</summary>
</member>
<member name="P:Google.Cloud.Firestore.FirestoreDb.DatabaseId">
<summary>
The database ID associated with this database.
</summary>
</member>
<member name="P:Google.Cloud.Firestore.FirestoreDb.RootPath">
<summary>
The resource name of the database, in the form "projects/{project_id}/databases/{database_id}".
</summary>
</member>
<member name="P:Google.Cloud.Firestore.FirestoreDb.DocumentsPath">
<summary>
The root of the documents, in the form "projects/{project_id}/databases/{database_id}/documents".
</summary>
</member>
<member name="M:Google.Cloud.Firestore.FirestoreDb.Create(System.String,Google.Cloud.Firestore.V1.FirestoreClient)">
<summary>
Creates an instance for the specified project, using the specified <see cref="T:Google.Cloud.Firestore.V1.FirestoreClient"/> for RPC operations.
</summary>
<param name="projectId">The ID of the Google Cloud Platform project that contains the database. May be null, in which case
the project will be automatically detected if possible.</param>
<param name="client">The client to use for RPC operations. May be null, in which case a client will be created with default credentials.</param>
<returns>A new instance.</returns>
</member>
<member name="M:Google.Cloud.Firestore.FirestoreDb.CreateAsync(System.String,Google.Cloud.Firestore.V1.FirestoreClient)">
<summary>