DocumentScanSession class
Manages a multi-page document scanning session (scanbot_sdk document session style).
Constructors
- DocumentScanSession({required String id, String? name, int? maxPages, DateTime? createdAt})
- Constructs a DocumentScanSession.
Properties
- createdAt → DateTime
-
Creation timestamp.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → String
-
Session identifier.
final
- isFull → bool
-
Whether page count has reached maxPages.
no setter
- maxPages → int?
-
Maximum allowable pages per document session (null for unlimited).
final
- name → String
-
Session title / name.
final
- pageCount → int
-
Number of pages currently in the session.
no setter
-
pages
→ List<
DocumentPage> -
Unmodifiable view of document pages.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
addPage(
{required Uint8List imageBytes, DocumentFilterMode filterMode = DocumentFilterMode.original, DocumentCorners? corners, int width = 640, int height = 480}) → DocumentPage - Adds a new page to the document session.
-
applyFilterToAll(
DocumentFilterMode filter) → void - Applies a DocumentFilterMode to all pages in this session.
-
clear(
) → void - Clears all pages from this session.
-
exportPageImages(
) → List< Uint8List> - Exports all processed page image byte buffers.
-
exportToPdf(
{String? title, String? password, String? watermarkText, bool isEncrypted = false, bool enableCompression = true}) → Uint8List - Exports all pages to a multi-page PDF byte buffer.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
removePage(
String id) → bool -
Removes a page by
id. -
removePageAt(
int index) → DocumentPage? -
Removes a page at specified
index. -
reorderPage(
int oldIndex, int newIndex) → void -
Moves page from
oldIndextonewIndexfor page reordering. -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited