Document class
A Firestore document. Must not exceed 1 MiB - 4 bytes.
Constructors
- Document()
- Document.fromJson(Map _json)
Properties
- createTime ↔ String
-
Output only. The time at which the document was created. This value
increases monotonically when a document is deleted then recreated. It can
also be compared to values from other documents and the
read_time
of a query.read / write -
fields
↔ Map<
String, Value> -
The document's fields. The map keys represent field names. A simple field
name contains only characters
a
toz
,A
toZ
,0
to9
, or_
, and must not start with0
to9
. For example,foo_bar_17
. Field names matching the regular expression__.*__
are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. Formap_value
, the field path is represented by the simple or quoted field names of the containing fields, delimited by.
. For example, the structured field"foo" : { map_value: { "x&y" : { string_value: "hello" }}}
would be represented by the field pathfoo.x&y
. Within a field path, a quoted field name starts and ends with`
and may contain any character. Some characters, including`
, must be escaped using a\
. For example,`x&y`
representsx&y
and`bak\`tik`
representsbak`tik
.read / write - hashCode → int
-
The hash code for this object. [...]
read-only, inherited
- name ↔ String
-
The resource name of the document, for example
projects/{project_id}/databases/{database_id}/documents/{document_path}
.read / write - runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
- updateTime ↔ String
-
Output only. The time at which the document was last changed. This value
is initially set to the
create_time
then increases monotonically with each change to the document. It can also be compared to values from other documents and theread_time
of a query.read / write
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed. [...]
inherited
-
toJson(
) → Map< String, Object> -
toString(
) → String -
Returns a string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator. [...]
inherited