AFCore/com.advantahealth.api.content.model

Package-level declarations

Content items, menu pages and sections, targets and images.

Types

ContentActionType

enum ContentActionType : Enum<ContentActionType>

How a ContentItem.actionUrl is opened.

ContentImageRendition

enum ContentImageRendition : Enum<ContentImageRendition>

A pre-rendered size of a content image on the image server. Every rendition is a WebP.

ContentItem

data class ContentItem(val itemKey: String?, val title: String?, val subtitle: String?, val displayOrder: Int, val actionType: ContentActionType, val actionUrl: String?, val accessibilityLabel: String?, val iconMedia: ContentMedia?, val bannerMedia: ContentMedia?, val ctaText: String?, val secondaryUrl: String?, val overlayPosition: ContentOverlayPosition, val overlayLogoEnabled: Boolean, val overlayCaption: String?, val overlaySubCaption: String?, val altText: String?, val contentTypeKey: String?, val renderer: ContentRenderer?, val payloadJson: String?)

One personalized content item - a bottom-navigation tab, a banner slide, or the menu page.

ContentMedia

data class ContentMedia(val assetId: String?, val publicHash: String?, val width: Int?, val height: Int?, val contentType: String?, imageBaseUrl: String?)

An image attached to a content item, served publicly (no auth header) by the image server of the SDK's environment.

ContentMenuEntry

data class ContentMenuEntry(val id: String?, val type: String?, val label: String?, val description: String?, val accessibilityLabel: String?, val icon: ContentVisual?, val image: ContentVisual?, val target: ContentTarget?)

One tappable entry of a ContentMenuSection.

ContentMenuPage

data class ContentMenuPage(val pageId: String?, val schemaVersion: String?, val title: String?, val subtitle: String?, val headerAvatar: ContentVisual?, val headerTrailingTarget: ContentTarget?, val sections: List<ContentMenuSection>)

The Explore / Menu page (menu-v3): titled sections of entries, each with a typed ContentTarget. The server has already removed the entries the member is not entitled to.

ContentMenuSection

data class ContentMenuSection(val id: String?, val type: String?, val title: String?, val subtitle: String?, val entries: List<ContentMenuEntry>)

A section of the ContentMenuPage.

ContentOverlayPosition

enum ContentOverlayPosition : Enum<ContentOverlayPosition>

Where a banner's caption overlay sits on the image.

ContentPage

data class ContentPage(val placement: ContentPlacement?, val surfaceCode: String?, val locale: String?, val items: List<ContentItem>, val eTag: String?)

The personalized content of one placement and surface.

ContentPlacement

enum ContentPlacement : Enum<ContentPlacement>

Where a piece of personalized content is rendered. Each placement is a separate ContentApi resource.

ContentRenderer

data class ContentRenderer(val rendererKey: String?, val payloadSchemaVersion: String?, val minimumSdkVersion: String?, val requiredCapabilities: List<String>)

The renderer contract the server attached to a content item - which client component draws it and what that component must support.

ContentTarget

data class ContentTarget(val kind: ContentTargetKind, val rawKind: String?, val routeKey: String?, val parameters: Map<String, String>, val url: String?, val openMode: String?, val carePathId: String?, val entryId: String?, val anchor: String?, val actionKey: String?)

Where a menu entry goes. Only the fields that belong to kind are set.

ContentTargetKind

enum ContentTargetKind : Enum<ContentTargetKind>

What a ContentTarget points at.

ContentVisual

data class ContentVisual(val kind: String?, val value: String?, val altText: String?)

An icon or image reference of the menu page.