express-embed-mobile-sdk-android-release

//sdk/com.adobe.express.embedsdk.wishesandgreetings.domain.model

Package-level declarations

Types

Name Summary
AcpAsset
@Serializable
data class AcpAsset(val id: String, val contentType: String = "", val licensingCategory: String = "", val path: String = "", val type: String = "", val task: AcpPageTask? = null, val pages: List<AcpPage>? = null, val names: Map<String, String>? = null, val links: Map<String, Link> = emptyMap(), val behaviors: List<String>? = null, var assetJson: String? = null, val totalAssetCount: Long = 0) : ContentAsset
AcpAssetList
@Serializable
data class AcpAssetList(val items: List<AcpAsset> = emptyList(), val links: Map<String, Link> = emptyMap())
AcpPage
@Serializable
data class AcpPage(val renditions: Map<String, AcpPageRendition>, val task: AcpPageTask)
AcpPageRendition
@Serializable
data class AcpPageRendition(val thumbnail: AcpRendition? = null, val preview: AcpRendition? = null)
AcpPageTask
@Serializable
data class AcpPageTask(val name: String, val size: AcpSize? = null)
AcpRendition
@Serializable
data class AcpRendition(val componentId: String, val hzRevision: String? = null, val width: Int, val height: Int, val mediaType: String)
AcpSize
@Serializable
data class AcpSize(val name: String)
CollectionSpec
@Serializable
data class CollectionSpec(val source: String = "", val assetTypes: List<String> = emptyList(), val tasks: List<String> = emptyList())
ContentAsset
interface ContentAsset
Source-agnostic asset contract consumed by convertToAsset and the paging sources.
ContentAssetList
data class ContentAssetList(val items: List<ContentAsset>, val nextLink: Link?)
Post-fetch, source-agnostic asset page.
ContentAssetType
enum ContentAssetType : Enum<ContentAssetType>
Content-service asset type discriminator.
ContentCollection
@Serializable
data class ContentCollection(val id: String, val parentDirectoryId: String = "", val ancestorAssetIds: List<String> = emptyList(), val contentType: String = "", val path: String = "", val names: Map<String, String> = emptyMap(), val links: Map<String, Link> = emptyMap(), val collectionSpec: Map<String, CollectionSpec> = emptyMap())
ContentCollectionList
@Serializable
data class ContentCollectionList(val items: List<ContentCollection> = emptyList(), val links: Map<String, Link> = emptyMap())
FilterUtils
object FilterUtils
ACP filter field names + region defaults for the Wishes & greetings browse path.
Link
@Serializable
data class Link(val href: String, val templated: Boolean = false, val name: String = "")
SearchTerms
class SearchTerms(var displayed: String = "", var filterQuery: List<String>? = null)
A single free-text + filter query for the ACP search/browse paths.
WishesAndGreetingsAsset
data class WishesAndGreetingsAsset(val assetType: ContentAssetType, val id: String, val collectionId: String, val thumbnailUrl: String?, val originalUrl: String, val compUrl: String?, val videoPreviewUrl: String?, val multipagePreviewUrl: List<String>, val isPremium: Boolean, val isMultiPage: Boolean, val isAnimated: Boolean, val isVideo: Boolean, val source: ContentAsset, val duration: Double, val title: String?, val names: String?, val keywords: List<String>?, val aspectRatio: Float? = null, val pages: List<AcpPage>? = null, val searchRank: WishesAndGreetingsAssetPosition, val totalAssetCount: Long, val isGentech: Boolean)
UI-facing template asset produced by convertToAsset.
WishesAndGreetingsAssetPosition
data class WishesAndGreetingsAssetPosition(val sourceIndex: Int, val assetIndex: Int)
Original (source-index, asset-index) position of an asset within its paged result.
WishesAndGreetingsBrowseState
sealed interface WishesAndGreetingsBrowseState
The domain-level result emitted by com.adobe.express.embedsdk.wishesandgreetings.domain.usecase.WishesAndGreetingsBrowseCollectionsUseCase for a single WishesAndGreetingsStockAssetsParams request.
WishesAndGreetingsCategory
data class WishesAndGreetingsCategory(val id: String, val label: String = "", @StringResval labelRes: Int? = null, val collectionId: String? = null, val searchTerm: String? = null)
A Wishes & greetings category pill. Remote catalog entries carry a display label; the bundled fallback catalog sets labelRes instead so its labels resolve through Android string resources.
WishesAndGreetingsCollection
data class WishesAndGreetingsCollection(val id: String, val name: String, val path: String, val heroes: List<WishesAndGreetingsAsset>, val source: ContentCollection, val assetType: ContentAssetType)
UI-facing collection (a row of hero templates) produced by the collection paging source.
WishesAndGreetingsContentRoot
enum WishesAndGreetingsContentRoot : Enum<WishesAndGreetingsContentRoot>
The Adobe Content Service root URNs the Wishes & greetings surface browses.
WishesAndGreetingsStockAssetsParams
data class WishesAndGreetingsStockAssetsParams(val dataSource: WishesAndGreetingsContentRoot, val searchTerms: SearchTerms, val breadcrumbs: List<WishesAndGreetingsCollection> = emptyList(), val collectionId: String? = null, val shuffle: Boolean = false)
The one-per-category browse request consumed by com.adobe.express.embedsdk.wishesandgreetings.domain.usecase.WishesAndGreetingsBrowseCollectionsUseCase.

Properties

Name Summary
WISHES_COLLECTION_LINK_PAGE_LIMIT
const val WISHES_COLLECTION_LINK_PAGE_LIMIT: Int = 30
Per-collection page size for the wishes browse grid (ported COLLECTION_LINK_PAGE_LIMIT).
WISHES_PRESENTATION_TASK_ID
const val WISHES_PRESENTATION_TASK_ID: String
Task id that marks a template as a presentation; suppressed from the wishes grid alongside video / animated / multi-page templates (ported from theo NativeHSTaskIds.PRESENTATION).

Functions

Name Summary
getLocalizedTitle
fun getLocalizedTitle(names: Map<String, String>, locale: Locale): String
Picks the names entry for locale (pass the SDK-configured UI locale), else the ACP i-default title, else "".