UserInterface

interface UserInterface

User Interface feature — fetch dynamic UI configuration from the backend.

This interface provides operations to retrieve remote-driven UI elements:

  • Bottom navigation items

  • Menu items

  • Banner images

  • Tray notifications

These values allow the app to dynamically render navigation and content without requiring a client update.

⚠️ Note: All UI elements are tenant-configurable. The returned navigation, menus, banners, and notifications depend on the organization’s configuration and may differ across tenants.

Platform & threading

  • All functions are suspend and must be called from a coroutine.

  • Errors surface as Throwable and should be handled at call sites.

Typical flows

Functions

Link copied to clipboard
abstract suspend fun discardTrayNotifications(notificationId: String): TrayNotification

Discards a specific tray notification.

Link copied to clipboard
abstract suspend fun getBannerImages(): List<BannerItem>

Retrieves the banner images.

Link copied to clipboard

Retrieves the bottom navigation items.

Link copied to clipboard
abstract suspend fun getMenuItems(): List<MenuItem>

Retrieves the dynamic menu items.

Link copied to clipboard
abstract suspend fun getTrayNotifications(): List<TrayNotification>

Retrieves the tray notifications for the member.