AFCore/com.advantahealth.api.ui.model/MenuItem

MenuItem

class MenuItem(var id: String? = null, var name: String? = null, var key: String? = null, var iconUrl: String? = null, var action: String? = null, var webUrl: String? = null, var sectionId: String? = null, var sectionTitle: String? = null, var sectionType: String? = null, var accessibilityLabel: String? = null)

MenuItem — represents a menu entry in the application.

Returned by com.advantahealth.api.ui.UserInterface.getMenuItems and typically displayed in sidebars, settings menus, or quick actions.

For Wellness-tab tile gating, items are matched against the local catalog by lowercased substring on key/name/action.

Android (Kotlin)

val menuItems = AFCore.userInterface().getMenuItems()
drawerMenu.update(menuItems)

iOS (Swift)

let menuItems = try await AFCore.shared.userInterface().getMenuItems()
self.drawerMenu.render(menuItems)

Constructors

MenuItem

constructor(id: String? = null, name: String? = null, key: String? = null, iconUrl: String? = null, action: String? = null, webUrl: String? = null, sectionId: String? = null, sectionTitle: String? = null, sectionType: String? = null, accessibilityLabel: String? = null)

constructor(id: String?, name: String?, key: String?, iconUrl: String?, action: String?, webUrl: String?)

The 1.11 constructor. Kotlin default arguments do not reach Swift, so without it a Swift caller written against 1.11 (a preview, a test fake) would stop compiling.

Properties

accessibilityLabel

var accessibilityLabel: String?

Screen-reader label, or null to use name.

action

var action: String?

Optional action string the host resolves on selection (e.g. a deep link or feature key), or null.

iconUrl

var iconUrl: String?

Absolute URL of the entry's icon, or null when none is set.

var id: String?

Unique identifier of the menu entry, or null when omitted.

key

var key: String?

Stable key used for analytics and routing, or null: the app route (for example MY_DASHBOARD), WEB for a web page, or an action such as LOGOUT. null when the entry leads somewhere the SDK has no key for.

name

var name: String?

Display name shown for the entry, or null.

sectionId

var sectionId: String?

AIDE section the entry belongs to, or null. Items arrive in reading order, so consecutive items with the same section form that section.

sectionTitle

var sectionTitle: String?

Title of that section, or null.

sectionType

var sectionType: String?

Layout the section asks for: featured-card, tile-grid or link-list, or null. Hosts should render an unknown type as a list.