Lens

interface Lens

Defines the data model of a lens that is available to be used by LensesComponent exposed features.

Types

Companion

Provides ability to attach utility functions to the Lens interface on implementation side.

Facing

Defines all possible facings (inversely relative to user) that a lens can be designed for.

LaunchData

Represents an additional data that is passed to a lens at its launch time.

Preview

sealed class Preview

Represents data that can be used to display lens preview to a user.

facingPreference

Specifies a Facing that this lens is designed for, null when no preference is expressed.

groupId

abstract val groupId: String

Non-empty identifier of a group this lens belongs to.

iconUri

abstract val iconUri: String?

Icon resource URI that represents this lens, null when not available.

abstract val id: String

Non-empty identifier of a unique lens available to be applied through processor.

name

abstract val name: String?

Human readable name of this lens, null when not available.

preview

Preview that represents this lens, null when not available.

vendorData

Vendor specific metadata associated with this lens, empty by default.