CameraKit/com.snap.camerakit/LegalProcessor

LegalProcessor

Defines a Processor that subscribes to LegalProcessor.Input to receive results from a user responding to a LegalProcessor.Input.Prompt for a legal agreement.

Since

1.8.0

Types

Input

interface Input

Defines the legal input model that is available to be read from by the processor.

Functions

connectInput

@CheckResult

abstract fun connectInput(input: LegalProcessor.Input): Closeable

Connects the provided input to this processor and returns a Closeable to release the connection when required. Normally, processing of the provided input starts instantly however certain processors may do it async so it is not guaranteed that any work will be done as soon as input is connected.

observe

@CheckResult

abstract fun observe(onResult: Consumer<LegalProcessor.Input.Result>): Closeable

Notifies the provided onResult callback when this LegalProcessor obtains a Input.Result until the returned Closeable is closed.

waitFor

abstract fun waitFor(requestUpdate: LegalProcessor.Input.RequestUpdate, onResult: Consumer<LegalProcessor.Input.Result>)

Notifies the provided onResult callback when this LegalProcessor handles a Input.Result. When the requestUpdate option is LegalProcessor.Input.RequestUpdate.ALWAYS the processor will attempt to subscribe to a LegalProcessor.Input eagerly in order to obtain a Input.Result earlier than typically required.

Inheritors

Processor