Skip to main content

Enums

This page documents all the enumeration types available in the MentraOS SDK. Enums are used to define sets of named constants that represent distinct values throughout the SDK.

AppType

Defines the different types or roles an app can have within the MentraOS system.

AppState

Represents the lifecycle states of an app on the user’s device.

Language

Defines supported language codes (BCP 47 format).

LayoutType

Identifies the different predefined UI layout structures available for display.

ViewType

Specifies the target area on the AR display where a layout should appear.

DashboardMode

Defines the different display modes available on the MentraOS dashboard.
Values:
  • MAIN: The default compact dashboard mode that appears as a small overlay
  • EXPANDED: The full-screen dashboard mode that users can open for detailed information
  • ALWAYS_ON: (Coming soon) A persistent compact overlay mode

AppSettingType

Defines the types of interactive settings that can be configured for an app in the MentraOS settings UI. Used within the AppConfig interface.

StreamType

Identifies the different types of real-time data streams and events Apps can subscribe to.

WebhookRequestType

Identifies the type of request being sent from MentraOS Cloud to an app server’s webhook endpoint.

Message Type Enums

These enums are used to identify the types of messages exchanged between different components of the MentraOS system.

GlassesToCloudMessageType

Message types sent FROM glasses TO cloud.

CloudToGlassesMessageType

Message types sent FROM cloud TO glasses.

AppToCloudMessageType

Message types sent FROM App TO cloud.

CloudToAppMessageType

Message types sent FROM cloud TO App.