TCDigitalFlyer/com.tctranscontinental.android.digitalflyer/Publication/Attributes

Attributes

data class Attributes(val id: String, val title: String, val flyerTitle: String, val startDate: LocalDate, val endDate: LocalDate, val thumbnailUrl: String, val logoUrl: String, val storeId: String, val language: Language, val jobName: String, val category: String, val filters: FilterOptions? = null, val isBlockedFlyer: Boolean? = null)

The Publication's attributes - which are effectively the metadata for the Publication

Constructors

constructor(id: String, title: String, flyerTitle: String, startDate: LocalDate, endDate: LocalDate, thumbnailUrl: String, logoUrl: String, storeId: String, language: Language, jobName: String, category: String, filters: FilterOptions? = null, isBlockedFlyer: Boolean? = null)

Properties

val category: String

The category assigned to each 'Publication' (eg. Weekly Flyer)

val endDate: LocalDate

The date after which the Publication is no longer available (11:59pm local time)

val filters: FilterOptions? = null

The set of filters that were applied to create this Publication. This is an SDK implementation detail (and may be removed)

val flyerTitle: String

A user-friendly, localized title for the Publication (e.g. "Weekly Flyer")

A non-globally-stable (unique and stable per-publish only) identifier for the Publication

val isBlockedFlyer: Boolean? = null

Whether or not this is a block-based, or page-based Publication. This is an SDK implementation detail (and may be removed)

val jobName: String

A composite string that uniquely identifies a job

val language: Language

The language that this Publication is displayed in. This is the value that was passed in to `listPublications`

val logoUrl: String

A URL to the for the Banner's logo image

val startDate: LocalDate

The date at which the Publication becomes available (midnight local time)

val storeId: String

The store that this Publication is associated with. This is the value that was passed in to `listPublications`

val thumbnailUrl: String

A URL to this Publication's thumbnail image

val title: String

A short, alphanumeric identifier for the Publication. Also known as "deal" (e.g. "ABC123")