TCDigitalFlyer/com.tctranscontinental.android.digitalflyer

Package-level declarations

Types

class AnalyticsConfig(id: String, upload: AnalyticsConfig.UploadConfig = UploadConfig(), storage: AnalyticsConfig.StorageConfig = StorageConfig())

Configuration object for the Analytics subsystem.

AnimationConfiguration

data class AnimationConfiguration(val autoplayDelay: Double = 0.5, val shouldLoop: Boolean = true, val loopCount: Int = 0)

AnimationRegion

data class AnimationRegion(val x: Double, val y: Double, val width: Double, val height: Double, val url: String, val sku: String?, val config: AnimationConfiguration)

Animation/Decoration regions inside of a block These values are percentages of the block's width and height

CarouselConfig

data class CarouselConfig(val animationEffect: String, val showControls: Boolean, val shouldAutoScroll: Boolean, val autoScrollInterval: Double, val transitionDuration: Double)

ClickableProduct

data class ClickableProduct(val sku: String, val clickRegions: List<ClickRegion>, val productData: Map<String, String>? = null)

A product, within a `Block` that can be clicked on.

ClickRegion

data class ClickRegion(val x: Double, val y: Double, val width: Double, val height: Double, val value: Event?)

Click regions of a product inside a block. These values are percentages of the block's width and height.

DFError

enum DFError : Enum<DFError>

The set of errors that can be thrown by the SDK

DigitalFlyer

data class DigitalFlyer(val subscriptionKey: String, val client: String, val banner: String = client, val environment: Environment = Environment.LIVE, val analyticsConfig: AnalyticsConfig? = null, bannerId: String? = null)

The entry-point for interacting with the SDK.

DigitalFlyerException

class DigitalFlyerException(error: DFError) : Exception

Environment

enum Environment : Enum<Environment>

The API environments supported by the SDK

FilterOptions

data class FilterOptions(val text: String? = null, val saving: Int? = null, val category: List<String>? = null, val subcategory: List<String>? = null) : Parcelable

Filters

data class Filters(val categories: List<Filters.Category>, val discounts: List<Int>)

Grid

data class Grid(val rows: Int, val columns: Int, val aspectRatio: Double)

The grid of items on a Publication.Page.

GridSpan

data class GridSpan(val spannedRows: Int, val spannedColumns: Int)

Represents a span of rows and columns in a grid.

Language

enum Language : Enum<Language>

The languages supported by the SDK

Logger

interface Logger

A logger that can be injected to log messages from the DigitalFlyer.

Orientation

enum Orientation : Enum<Orientation>

Publication

data class Publication(val attributes: Publication.Attributes, val pages: List<Publication.Page>)

The primary Publication object It contains the Publication.Attributes and an array of Publication.Page objects, which contain the page content.

VideoPlayback

data class VideoPlayback(val autoplayDelay: Double = 2.0, val shouldAutoplay: Boolean = true, val shouldLoop: Boolean = true, val isAudioEnabled: Boolean = true, val showControls: Boolean = true)

VideoRegion

data class VideoRegion(val x: Double, val y: Double, val width: Double, val height: Double, val url: String)

Video regions of a product inside a block These values are percentages of the block's width and height

Properties

logger

var logger: Logger?