Carousel

interface Carousel

Provides ability to interact with lenses carousel feature which can be enabled with Configuration supplied to LensesComponent.Builder.configureCarousel method.

Types

Configuration
Link copied to clipboard
interface Configuration
Exposes configuration options available to lenses carousel feature.
Event
Link copied to clipboard
sealed class Event
All lenses carousel lifecycle events available to observe.
ItemOptions
Link copied to clipboard
interface ItemOptions
Represents options to customize lenses carousel item appearance.
LayoutPlacement
Link copied to clipboard
sealed class LayoutPlacement
Describes directional placement relative to the lens carousel.
Noop
Link copied to clipboard
object Noop : LensesComponent.Carousel
Side
Link copied to clipboard
enum Side : Enum<LensesComponent.Carousel.Side>
Describes position on the left or right to the center of lenses carousel.
View
Link copied to clipboard
interface View : Consumer<LensesComponent.Carousel.View.Model>
Defines a contract of a view that is called to show and hide lenses carousel.

Functions

activate
Link copied to clipboard
abstract fun activate(lens: LensesComponent.Lens? = null, callback: Consumer<Boolean> = Consumer {})
Attempts to activate lenses carousel with an optional Lens pre-selected.
deactivate
Link copied to clipboard
abstract fun deactivate(callback: Consumer<Boolean> = Consumer {})
Attempts to deactivate lenses carousel.
observe
Link copied to clipboard
abstract fun observe(onEvent: Consumer<LensesComponent.Carousel.Event>): Closeable
Allows to observe lenses carousel lifecycle events defined in Event.

Inheritors

LensesComponent.Carousel
Link copied to clipboard