DocumentLockedException class

Exception thrown when trying to access a locked document.

This exception is thrown when an operation cannot proceed because another process holds a lock on the document.

Example:

try {
  await db.update(ItemWithId(id: 'user-1', collection: 'users', item: {}));
} on DocumentLockedException catch (e) {
  print('Document ${e.documentPath} is locked');
}

Implemented types

• Exception

Constructors

DocumentLockedException({required String documentPath})

Creates a new DocumentLockedException.

const

Properties

documentPath → String

The path of the locked document.

final

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited