UpdateType enum

Defines how the field will be updated.

Inheritance

Constructors

UpdateType()
const

Values

set → const UpdateType

Sets (overwrites) the value of a field. Applicable on all fields, except system managed _id, _parent, createdAt, updatedAt fields.

unset → const UpdateType

Clears the value of a field. Applicable on all fields, except system managed _id, _parent, createdAt, updatedAt fields.

increment → const UpdateType

Increments the value of a numeric field by the specified amount. Applicable only for integer and decimal fields.

decrement → const UpdateType

Decrements the value of a numeric field by the specified amount. Applicable only for integer and decimal fields.

min → const UpdateType

Assigns the minimum of the specified value or the field value. If the specified value is less than the current field value, sets the field value to the specificied value, otherwise does not make any changes. Applicable only for integer and decimal fields.

max → const UpdateType

Assigns the maximum of the specified value or the field value. If the specified value is greater than the current field value, sets the field value to the specificied value, otherwise does not make any changes. Applicable only for integer and decimal fields.

multiply → const UpdateType

Multiplies the current value of the field with the specified amount and sets the field value to teh multiplication result. Applicable only for integer and decimal fields.

pull → const UpdateType

Removes the specified value from a basic values list. Applicable only for basic values list fields.

push → const UpdateType

Adds the specified value to a basic values list. Applicable only for basic values list fields.

pop → const UpdateType

Removes the last element from a basic values list. Applicable only for basic values list fields.

shift → const UpdateType

Removes the first element from a basic values list. Applicable only for basic values list fields.

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

values → const List<UpdateType>
A constant List of the values in this enum, in order of their declaration.