MessageRole enum

Unified message role for AI/LLM conversations.

Consolidates the legacy AiMessageRole (chat UI layer) and LlmRole (provider layer) into a single canonical type. Both legacy enums remain available with @Deprecated annotations and will be removed in 5.0.

Use MessageRole.fromAiMessageRole / MessageRole.fromLlmRole (and the inverse helpers) to migrate existing code incrementally.

Inheritance

• Object
• Enum
• MessageRole

Available extensions

• EnumName

Values

user → const MessageRole

End-user message.

assistant → const MessageRole

Assistant / model response.

system → const MessageRole

System prompt or instruction.

tool → const MessageRole

Tool / function-call result.

Properties

hashCode → int

The hash code for this object.

no setter, inherited

index → int

A numeric identifier for the enumerated value.

no setter, inherited

name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

values → const List<MessageRole>

A constant List of the values in this enum, in order of their declaration.