Kotlin SDK References and Release notes

Classes

DYResult

Open class DYResult(
    val status: ResultStatus,
    val warnings: List<Warning>? = null,
    val error: Exception? = null,
    val rawNetworkData: RawNetworkData? = null
)

Property	Description	Type
status	The status of the Choose call. If the type is "WARNING," it indicates that the request was successful, but there are warnings associated with the response.	ResultStatus: SUCCESS, ERROR, WARNING
warnings	List of warnings returned from the server. Every warning item has a code and message.	List<Warning>?
error	Error and exception.	Exception?
rawNetworkData	Network-related data (for debugging purposes).	RawNetworkData?

Page

class Page(
    pageType: PageType,
    pageLocation: String,
    pageData: List<String> = listOf(),
    pageReferrer: String? = "",
    locale: String? = null,
)

Property	Description	Type
pageType	The current page type	PageType
pageLocation	The current location. URL (for web), location (for SPA), or screen name (for mobile apps). Enables targeting the current page/screen.	String
pageData	Additional data for non-homepage pages: The SKU for a PRODUCT page, the category for a CATEGORY page, SKUs for the CART page, and the page ID in OTHER.	List
pageReferrer	The previous location. URL (for web), location (for SPA), or screen name (for mobile apps). Enables targeting the previous page/screen.	String?
locale	Page locale code	String?

ChooseOptions

data class ChooseOptions(  
    val isImplicitPageview: Boolean? = null,  
    val returnAnalyticsMetadata: Boolean? = null,  
    val isImplicitImpressionMode: Boolean? = null,  
)

Property	Description	Type
isImplicitPageview	Determine whether to report a new pageview with the given context. Default is `false`. Set to true to report a new pageview with the given context. Keep as false if the Dynamic Yield script is implemented on the page. It reports the new pageview from the browser.	Boolean
returnAnalyticsMetadata	Return additional metadata (display names & IDs for all entities). Useful for reporting to analytics tools. Set to true to return additional metadata (display names & IDs for all entities) for reporting to analytics tools.	Boolean
isImplicitImpressionMode	Report an impression of the chosen variation. This is set to `true` by default, which means that the user's impression of the variation is reported immediately when the variation is chosen. Pass this as false to report the impression explicitly in an Engagement call.	Boolean

Enums

Channel

enum class Channel(val valueStr: String) {
    APP("APP"),
    KIOSK("KIOSK"),
    DRIVE_THRU("DRIVE-THRU");
}

DeviceType

enum class DeviceType {
    SMARTPHONE,
    TABLET,
    KIOSK,
    ODMB;
}

PageType

enum class PageType {
    HOMEPAGE,
    CATEGORY,
    PRODUCT,
    CART,
    OTHER
}

SortOrderType

public enum SortOrderType 
    ASC,
    DESC
}

VideoProgressType

enum class VideoProgressType {
    VIDEO_STARTED,
    PREROLL_FINISHED,
    VIDEO_FINISHED,
    VIDEO_PROGRESS
}