onyxsdk-ktx/com.onyx.android.sdk.ktx.testing/FakePenSession

FakePenSession

class FakePenSession(commitHandler: suspend (bitmap: Bitmap, destination: Rect, dirtyRegion: Rect, options: CommitOptions) -> Result<CommitReceipt> = { _, _, _, _ -> Result.failure( OnyxFailure.UnsupportedCapability( "fake.commit", null, "No commit result was configured for FakePenSession", ), ) }) : PenSession(source)

Deterministic consumer-facing test double; it performs no Android firmware calls.

Constructors

FakePenSession

constructor(commitHandler: suspend (bitmap: Bitmap, destination: Rect, dirtyRegion: Rect, options: CommitOptions) -> Result<CommitReceipt> = { _, _, _, _ -> Result.failure( OnyxFailure.UnsupportedCapability( "fake.commit", null, "No commit result was configured for FakePenSession", ), ) })

Properties

completedStrokes

open override val completedStrokes: Flow<InkStroke>

Strokes injected through emit.

events

open override val events: Flow<PenEvent>

Events injected through emit.

preview

open override val preview: StateFlow<InkPreview?>

Latest preview derived from injected pen events.

state

open override val state: StateFlow<RawInkSessionState>

Mutable test state exposed as the production session contract.

Functions

open override fun close()

Closes all fake streams and updates state.

closeAndAwait

open suspend override fun closeAndAwait(): Result<Unit>

Closes the fake synchronously and returns success.

commit

open suspend override fun commit(bitmap: Bitmap, destination: Rect, dirtyRegion: Rect = destination, options: CommitOptions = CommitOptions()): Result<CommitReceipt>

Delegates a commit to the handler supplied at construction time.

emit

suspend fun emit(stroke: InkStroke)

Injects a completed stroke into the fake session when it is active.

suspend fun emit(event: PenEvent)

Injects event into the fake session when it is active.

pause

open suspend override fun pause(): Result<Unit>

Moves the fake session to its requested-suspension state.

resume

open suspend override fun resume(): Result<Unit>

Moves an open fake session back to its active state.