CameraKit/com.snap.camerakit/LegalProcessor/Input

Input

interface Input

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

Types

class Prompt(val id: String, val message: String)

Defines the content in the form of a localized and HTML formatted message to prompt a user for a legal agreement. The provided id uniquely identifies the backing content of the message, it should be used as a key when saving user response and determining whether a user needs to be re-prompted instead of serving a saved response.

RequestUpdate

enum RequestUpdate : Enum<LegalProcessor.Input.RequestUpdate>

Specifies when a LegalProcessor.Input implementation should re-prompt user to get a new response.

Result

sealed class Result

Represents all the available responses to a prompt produced by the LegalProcessor.Input.

Functions

subscribeTo

@CheckResult

abstract fun subscribeTo(prompt: LegalProcessor.Input.Prompt, requestUpdate: LegalProcessor.Input.RequestUpdate, onResult: Consumer<LegalProcessor.Input.Result>): Closeable

Subscribes to the provided onResult to be notified when a new Result is available for this input. The subscriber specifies a Prompt that must be taken into account when presenting a UI or calling back with a previously saved user response for the provided unique Prompt.id. Even though a saved user response may exist for a specific Prompt.id when the requestUpdate option is RequestUpdate.ALWAYS it is expected that the underlying LegalProcessor.Input implementation will re-prompt user to get a new response. The returned Closeable must be closed when done working with this input otherwise underlying resources will be leaked.