Typed Data topic

The typed data API is experimental and subject to change.

Classes

AsyncSaveTypedDocument<D extends TypedDocumentObject<Object>, MD extends TypedMutableDocumentObject<TypedDocumentObject<Object>, TypedDocumentObject<Object>>> Database Typed Data
The result of AsyncDatabase.saveTypedDocument, which needs to be used to actually save the document.
AsyncSaveTypedDocument<D extends TypedDocumentObject<Object>, MD extends TypedMutableDocumentObject<TypedDocumentObject<Object>, TypedDocumentObject<Object>>> Database Typed Data
The result of AsyncDatabase.saveTypedDocument, which needs to be used to actually save the document.
AsyncSaveTypedDocument<D extends TypedDocumentObject<Object>, MD extends TypedMutableDocumentObject<TypedDocumentObject<Object>, TypedDocumentObject<Object>>> Database Typed Data
The result of AsyncDatabase.saveTypedDocument, which needs to be used to actually save the document.
DocumentId Typed Data
Annotation for the property of a typed document that is the document id.
DocumentId Typed Data
Annotation for the property of a typed document that is the document id.
DocumentId Typed Data
Annotation for the property of a typed document that is the document id.
DocumentRevisionId Typed Data
Annotation for the property of a typed document that is the document revision id.
DocumentRevisionId Typed Data
Annotation for the property of a typed document that is the document revision id.
DocumentRevisionId Typed Data
Annotation for the property of a typed document that is the document revision id.
DocumentSequence Typed Data
Annotation for the property of a typed document that is the document sequence.
DocumentSequence Typed Data
Annotation for the property of a typed document that is the document sequence.
DocumentSequence Typed Data
Annotation for the property of a typed document that is the document sequence.
EnumIndexConverter<T extends Enum> Typed Data
A ScalarConverter that encodes Enum values by their index.
EnumIndexConverter<T extends Enum> Typed Data
A ScalarConverter that encodes Enum values by their index.
EnumIndexConverter<T extends Enum> Typed Data
A ScalarConverter that encodes Enum values by their index.
EnumNameConverter<T extends Enum> Typed Data
A ScalarConverter that encodes Enum values by their name.
EnumNameConverter<T extends Enum> Typed Data
A ScalarConverter that encodes Enum values by their name.
EnumNameConverter<T extends Enum> Typed Data
A ScalarConverter that encodes Enum values by their name.
SaveTypedDocument<D extends TypedDocumentObject<Object>, MD extends TypedMutableDocumentObject<TypedDocumentObject<Object>, TypedDocumentObject<Object>>> Database Typed Data
The result of Database.saveTypedDocument, which needs to be used to actually save the document.
SaveTypedDocument<D extends TypedDocumentObject<Object>, MD extends TypedMutableDocumentObject<TypedDocumentObject<Object>, TypedDocumentObject<Object>>> Database Typed Data
The result of Database.saveTypedDocument, which needs to be used to actually save the document.
SaveTypedDocument<D extends TypedDocumentObject<Object>, MD extends TypedMutableDocumentObject<TypedDocumentObject<Object>, TypedDocumentObject<Object>>> Database Typed Data
The result of Database.saveTypedDocument, which needs to be used to actually save the document.
ScalarConverter<T> Typed Data
An object that converts between untyped data and instances of type T, which must have value semantics.
ScalarConverter<T> Typed Data
An object that converts between untyped data and instances of type T, which must have value semantics.
ScalarConverter<T> Typed Data
An object that converts between untyped data and instances of type T, which must have value semantics.
SyncSaveTypedDocument<D extends TypedDocumentObject<Object>, MD extends TypedMutableDocumentObject<TypedDocumentObject<Object>, TypedDocumentObject<Object>>> Database Typed Data
The result of SyncDatabase.saveTypedDocument, which needs to be used to actually save the document.
SyncSaveTypedDocument<D extends TypedDocumentObject<Object>, MD extends TypedMutableDocumentObject<TypedDocumentObject<Object>, TypedDocumentObject<Object>>> Database Typed Data
The result of SyncDatabase.saveTypedDocument, which needs to be used to actually save the document.
SyncSaveTypedDocument<D extends TypedDocumentObject<Object>, MD extends TypedMutableDocumentObject<TypedDocumentObject<Object>, TypedDocumentObject<Object>>> Database Typed Data
The result of SyncDatabase.saveTypedDocument, which needs to be used to actually save the document.
TypedConflict Replication Typed Data
A conflict between changes in a local and remote Document, providing typed representations of the documents.
TypedConflict Replication Typed Data
A conflict between changes in a local and remote Document, providing typed representations of the documents.
TypedConflict Replication Typed Data
A conflict between changes in a local and remote Document, providing typed representations of the documents.
TypedConflictResolver Replication Typed Data
An object which is able to resolve a TypedConflict between the local and remote versions of a replicated document.
TypedConflictResolver Replication Typed Data
An object which is able to resolve a TypedConflict between the local and remote versions of a replicated document.
TypedConflictResolver Replication Typed Data
An object which is able to resolve a TypedConflict between the local and remote versions of a replicated document.
TypedDatabase Typed Data
Annotation for classes that are typed databases.
TypedDatabase Typed Data
Annotation for classes that are typed databases.
TypedDatabase Typed Data
Annotation for classes that are typed databases.
TypedDataList<T extends E, E> Typed Data
A list implementation that is used to represent arrays in typed dictionaries and document.
TypedDataList<T extends E, E> Typed Data
A list implementation that is used to represent arrays in typed dictionaries and document.
TypedDataList<T extends E, E> Typed Data
A list implementation that is used to represent arrays in typed dictionaries and document.
TypedDictionary Typed Data
Annotation for classes that are typed dictionaries.
TypedDictionary Typed Data
Annotation for classes that are typed dictionaries.
TypedDictionary Typed Data
Annotation for classes that are typed dictionaries.
TypedDictionaryObject<MD extends Object> Typed Data
The type that is implemented by all typed dictionaries.
TypedDictionaryObject<MD extends Object> Typed Data
The type that is implemented by all typed dictionaries.
TypedDictionaryObject<MD extends Object> Typed Data
The type that is implemented by all typed dictionaries.
TypedDocument Typed Data
Annotation for classes that are typed documents.
TypedDocument Typed Data
Annotation for classes that are typed documents.
TypedDocument Typed Data
Annotation for classes that are typed documents.
TypedDocumentObject<MD extends Object> Typed Data
The type that is implemented by all typed documents.
TypedDocumentObject<MD extends Object> Typed Data
The type that is implemented by all typed documents.
TypedDocumentObject<MD extends Object> Typed Data
The type that is implemented by all typed documents.
TypedMutableDictionaryObject<D extends TypedDictionaryObject<Object>, MD extends TypedDictionaryObject<Object>> Typed Data
The type that is implemented by all typed mutable dictionaries.
TypedMutableDictionaryObject<D extends TypedDictionaryObject<Object>, MD extends TypedDictionaryObject<Object>> Typed Data
The type that is implemented by all typed mutable dictionaries.
TypedMutableDictionaryObject<D extends TypedDictionaryObject<Object>, MD extends TypedDictionaryObject<Object>> Typed Data
The type that is implemented by all typed mutable dictionaries.
TypedMutableDocumentObject<D extends TypedDocumentObject<Object>, MD extends TypedDocumentObject<Object>> Typed Data
The type that is implemented by all typed mutable documents.
TypedMutableDocumentObject<D extends TypedDocumentObject<Object>, MD extends TypedDocumentObject<Object>> Typed Data
The type that is implemented by all typed mutable documents.
TypedMutableDocumentObject<D extends TypedDocumentObject<Object>, MD extends TypedDocumentObject<Object>> Typed Data
The type that is implemented by all typed mutable documents.
TypedProperty Typed Data
Annotation for the property of a typed dictionary or document that is a dictionary or document property.
TypedProperty Typed Data
Annotation for the property of a typed dictionary or document that is a dictionary or document property.
TypedProperty Typed Data
Annotation for the property of a typed dictionary or document that is a dictionary or document property.
TypeMatcher Typed Data
Determines whether a given dictionary or document can be instantiated as a specific typed dictionary or document.
TypeMatcher Typed Data
Determines whether a given dictionary or document can be instantiated as a specific typed dictionary or document.
TypeMatcher Typed Data
Determines whether a given dictionary or document can be instantiated as a specific typed dictionary or document.
ValueTypeMatcher Typed Data
A TypeMatcher that matches a dictionary or document if it contains a fixed value at a fixed path.
ValueTypeMatcher Typed Data
A TypeMatcher that matches a dictionary or document if it contains a fixed value at a fixed path.
ValueTypeMatcher Typed Data
A TypeMatcher that matches a dictionary or document if it contains a fixed value at a fixed path.

Enums

TypedDataErrorCode Typed Data
A specification of the cause of a TypedDataException.
TypedDataErrorCode Typed Data
A specification of the cause of a TypedDataException.

Typedefs

TypedConflictResolverFunction = FutureOr<TypedDocumentObject<Object>?> Function(TypedConflict conflict) Replication Typed Data
Functional version of TypedConflictResolver.
TypedConflictResolverFunction = FutureOr<TypedDocumentObject<Object>?> Function(TypedConflict conflict) Replication Typed Data
Functional version of TypedConflictResolver.
TypedConflictResolverFunction = FutureOr<TypedDocumentObject<Object>?> Function(TypedConflict conflict) Replication Typed Data
Functional version of TypedConflictResolver.
TypedReplicationFilter = FutureOr<bool> Function(TypedDocumentObject<Object> document, Set<DocumentFlag> flags) Replication Typed Data
A function that decides whether a particular typed document should be pushed/pulled.
TypedReplicationFilter = FutureOr<bool> Function(TypedDocumentObject<Object> document, Set<DocumentFlag> flags) Replication Typed Data
A function that decides whether a particular typed document should be pushed/pulled.
TypedReplicationFilter = FutureOr<bool> Function(TypedDocumentObject<Object> document, Set<DocumentFlag> flags) Replication Typed Data
A function that decides whether a particular typed document should be pushed/pulled.
TypedSaveConflictHandler<D extends TypedDocumentObject<Object>, MD extends TypedMutableDocumentObject<TypedDocumentObject<Object>, TypedDocumentObject<Object>>> = FutureOr<bool> Function(MD documentBeingSaved, D? conflictingDocument) Database Typed Data
Custom conflict handler for saving a typed document.
TypedSaveConflictHandler<D extends TypedDocumentObject<Object>, MD extends TypedMutableDocumentObject<TypedDocumentObject<Object>, TypedDocumentObject<Object>>> = FutureOr<bool> Function(MD documentBeingSaved, D? conflictingDocument) Database Typed Data
Custom conflict handler for saving a typed document.
TypedSaveConflictHandler<D extends TypedDocumentObject<Object>, MD extends TypedMutableDocumentObject<TypedDocumentObject<Object>, TypedDocumentObject<Object>>> = FutureOr<bool> Function(MD documentBeingSaved, D? conflictingDocument) Database Typed Data
Custom conflict handler for saving a typed document.
TypedSyncSaveConflictHandler<D extends TypedDocumentObject<Object>, MD extends TypedMutableDocumentObject<TypedDocumentObject<Object>, TypedDocumentObject<Object>>> = bool Function(MD documentBeingSaved, D? conflictingDocument) Database Typed Data
Custom sync conflict handler for saving a typed document.
TypedSyncSaveConflictHandler<D extends TypedDocumentObject<Object>, MD extends TypedMutableDocumentObject<TypedDocumentObject<Object>, TypedDocumentObject<Object>>> = bool Function(MD documentBeingSaved, D? conflictingDocument) Database Typed Data
Custom sync conflict handler for saving a typed document.
TypedSyncSaveConflictHandler<D extends TypedDocumentObject<Object>, MD extends TypedMutableDocumentObject<TypedDocumentObject<Object>, TypedDocumentObject<Object>>> = bool Function(MD documentBeingSaved, D? conflictingDocument) Database Typed Data
Custom sync conflict handler for saving a typed document.

Exceptions / Errors

TypedDataException Typed Data
Exception throw when there is a failure related to typed data.
TypedDataException Typed Data
Exception throw when there is a failure related to typed data.
UnexpectedTypeException Typed Data
Exception thrown by ScalarConverter.fromData when the given value is not of the expected type.
UnexpectedTypeException Typed Data
Exception thrown by ScalarConverter.fromData when the given value is not of the expected type.
UnexpectedTypeException Typed Data
Exception thrown by ScalarConverter.fromData when the given value is not of the expected type.