DocumentId class

Strips out illegal characters from a string intended to be used as a document ID in Firestore

Removes all forward slashes from the string by default. Set throwsOnForwardSlash if you would prefer for it to throw a CannotContainForwardSlash FormatException instead.

Potential to throw FormatException of type CannotBeNoLongerThan1500Bytes, CannotSolelyConsistOfASingleOrDoublePeriod, CannotStartAndEndWithDoubleUnderscore, or CannotContainForwardSlash.

Inheritance

• Object
• Serializable
• DocumentId

Constructors

DocumentId(String unsafeValue, {dynamic throwsOnForwardSlash = false})

DocumentId.fromJson(Map<String, dynamic> json)

factory

Properties

docId → String

final

hashCode → int

The hash code for this object.

no setter, inherited

props → List<Object?>

The list of properties that will be used to determine whether two instances are equal.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

stringify → bool?

If set to true, the toString method will be overridden to output this instance's props.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

override

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

fieldDocId → const String