Class: MessageHandle

Makaio Framework

---

Makaio Framework / ai-adapters-core / MessageHandle

Class: MessageHandle

Defined in: ../../../adapters/core/src/message-handle/message-handle.ts:6

Constructors

Constructor

new MessageHandle(messageId, message, deliveryMode, messageHistory?, turnContext?): MessageHandle

Defined in: ../../../adapters/core/src/message-handle/message-handle.ts:29

Parameters

messageId

string

message

NormalizedMessageInput

deliveryMode

"replace" | "enqueue" | "immediate"

messageHistory?

object[]

Curated message history from sessionContext

turnContext?

Record<string, JsonValue>

Turn-scoped context from PreUserMessage hooks

Returns

MessageHandle

Properties

deferredAcknowledgement

protected readonly deferredAcknowledgement: DeferredPromise<boolean>

Defined in: ../../../adapters/core/src/message-handle/message-handle.ts:8

---

deferredCompletion

protected readonly deferredCompletion: DeferredPromise<MessageResult>

Defined in: ../../../adapters/core/src/message-handle/message-handle.ts:7

---

deliveryMode

readonly deliveryMode: "replace" | "enqueue" | "immediate"

Defined in: ../../../adapters/core/src/message-handle/message-handle.ts:32

---

mergedFrom?

optional mergedFrom?: string[]

Defined in: ../../../adapters/core/src/message-handle/message-handle.ts:16

If this is the merge winner, messageIds that were folded in

---

mergedInto?

optional mergedInto?: string

Defined in: ../../../adapters/core/src/message-handle/message-handle.ts:14

If this message was merged into another, the winner’s messageId

---

message

readonly message: NormalizedMessageInput

Defined in: ../../../adapters/core/src/message-handle/message-handle.ts:31

---

messageId

readonly messageId: string

Defined in: ../../../adapters/core/src/message-handle/message-handle.ts:30

---

state

state: MessageState

Defined in: ../../../adapters/core/src/message-handle/message-handle.ts:9

---

supersededBy?

optional supersededBy?: string

Defined in: ../../../adapters/core/src/message-handle/message-handle.ts:18

If this message was superseded by replace/immediate, the replacer’s messageId

Accessors

adapterSessionId

Get Signature

get adapterSessionId(): string | undefined

Defined in: ../../../adapters/core/src/message-handle/message-handle.ts:75

Get adapter session ID synchronously (undefined if not yet set)

Returns

string | undefined

The adapter session ID or undefined if not yet set

Set Signature

set adapterSessionId(value): void

Defined in: ../../../adapters/core/src/message-handle/message-handle.ts:82

Set adapter session ID (called by connector when processing starts)

Parameters

value

string | undefined

Returns

void

---

isProcessed

Get Signature

get isProcessed(): boolean

Defined in: ../../../adapters/core/src/message-handle/message-handle.ts:98

Returns

boolean

---

messageHistory

Get Signature

get messageHistory(): object[] | undefined

Defined in: ../../../adapters/core/src/message-handle/message-handle.ts:49

Curated message history from sessionContext

Returns

object[] | undefined

The message history array or undefined if not set

Set Signature

set messageHistory(value): void

Defined in: ../../../adapters/core/src/message-handle/message-handle.ts:54

Set messageHistory (used by merge strategies to propagate history)

Parameters

value

object[] | undefined

Returns

void

---

turnContext

Get Signature

get turnContext(): Record<string, JsonValue> | undefined

Defined in: ../../../adapters/core/src/message-handle/message-handle.ts:62

Turn-scoped context from PreUserMessage hooks

Returns

Record<string, JsonValue> | undefined

The turn context record or undefined if not set

Set Signature

set turnContext(value): void

Defined in: ../../../adapters/core/src/message-handle/message-handle.ts:67

Set turnContext (used by merge strategies to propagate context)

Parameters

value

Record<string, JsonValue> | undefined

Returns

void

Methods

cancel()

cancel(): Promise<boolean>

Defined in: ../../../adapters/core/src/message-handle/message-handle.ts:118

Cancel a pending message

Returns

Promise<boolean>

True if cancelled, false if already submitted/completed

---

getState()

getState(): MessageState

Defined in: ../../../adapters/core/src/message-handle/message-handle.ts:102

Returns

MessageState

---

markAcknowledged()

markAcknowledged(delivered?): void

Defined in: ../../../adapters/core/src/message-handle/message-handle.ts:134

Mark message as acknowledged

Parameters

delivered?

boolean = true

Whether message was successfully delivered to provider (e.g. false if immediate message arrived too late)

Returns

void

---

markCompleted()

markCompleted(result): void

Defined in: ../../../adapters/core/src/message-handle/message-handle.ts:146

Mark message turn as completed

Parameters

result

MessageResult

The result message or null if no result available

Returns

void

---

updateState()

updateState(state): void

Defined in: ../../../adapters/core/src/message-handle/message-handle.ts:110

Update message state

Parameters

state

MessageState

New message state

Returns

void

---

waitForAcknowledgment()

waitForAcknowledgment(timeoutMs?): Promise<boolean>

Defined in: ../../../adapters/core/src/message-handle/message-handle.ts:163

Parameters

timeoutMs?

number

Returns

Promise<boolean>

---

waitForAdapterSessionId()

waitForAdapterSessionId(): Promise<string>

Defined in: ../../../adapters/core/src/message-handle/message-handle.ts:93

Wait for adapter session ID to be set

Returns

Promise<string>

Promise resolving to session ID when processing starts

---

waitForCompletion()

waitForCompletion(timeoutMs?): Promise<MessageResult>

Defined in: ../../../adapters/core/src/message-handle/message-handle.ts:182

Parameters

timeoutMs?

number

Returns

Promise<MessageResult>