Skip to main content
Version: 2.0

Module

The Module interface defines the basic structure of a module in the Huma SDK.

Properties​

  • isEnabled: Specifies if the module is enabled.
  • moduleName: Specifies the module name.
  • analyticsName: Specifies the module analytics name.
  • moduleId: Specifies the module id.
  • moduleConfigId: Specifies the module unique config id.
  • renderCard: A flag that indicates if the module should be rendered on the home screen.
  • moduleUnit: Returns the unit of the module.
  • moduleUnitCard: Returns the unit of the card.
  • responsePrimitiveClasses: Response primitive class.
  • version: Module version.
  • order: Order of a module.
  • isQuestionnaireAction: Define if the module is a questionnaire type.
  • willHandleKeyAction: Defines if that module will handle key action itself and not required to clean key action automatically.

Methods​

  • ModuleCard(modifier: Modifier): A Composable function to create a Module Card.

Sub-Interfaces

CombinedModule​

The CombinedModule interface extends the Module interface and adds the combinedModuleConfigIds property.

CombinedModuleWithInput​

The CombinedModuleWithInput interface extends the CombinedModule interface and adds the openInput and onModuleInputSubmit methods.

ModuleWithGoal​

The ModuleWithGoal interface extends the Module interface and adds several properties and methods related to goals.

ModuleWithDetails​

The ModuleWithDetails interface extends the Module interface and adds several properties and methods related to module details.

ModuleWithInput​

The ModuleWithInput interface extends the Module interface and adds several properties and methods related to module input.

ModuleWithLocalNotifications​

The ModuleWithLocalNotifications interface extends the Module interface and adds several methods related to local notifications.

ModuleWithLifeEvent​

The ModuleWithLifeEvent interface extends the Module interface and adds several properties and methods related to life events.

ModuleWithCustomDescriptionMessage​

The ModuleWithCustomDescriptionMessage interface extends the Module interface and adds a method to get a custom description message.