Faimulus TypeScript API / @faimulus/driver-sdk / ChannelDriverContext

Interface: ChannelDriverContext

Host services scoped to one channel instance.

Properties

config

readonly config: JsonObject

---

dataDirectory

readonly dataDirectory: string

---

instanceId

readonly instanceId: string

---

log

readonly log: ChannelLogger

---

secrets

readonly secrets: ScopedChannelSecretStore

---

signal

readonly signal: AbortSignal

---

store

readonly store: ScopedChannelStore

Methods

listWorkflows()

listWorkflows(): Promise<readonly ChannelWorkflowDescriptor[]>

Returns

Promise<readonly ChannelWorkflowDescriptor[]>

---

publishEvent()

publishEvent(event): Promise<void>

Parameters

event

ChannelEvent

Returns

Promise<void>

---

publishStatus()

publishStatus(status): Promise<void>

Parameters

status

ChannelStatus

Returns

Promise<void>

---

resolveInteractionRequest()

resolveInteractionRequest(requestId, response): Promise<ChannelInteractionResolvedRun>

Parameters

requestId

string

response

JsonValue

Returns

Promise<ChannelInteractionResolvedRun>

---

submitMessage()

submitMessage(request): Promise<ChannelSubmittedRun>

Parameters

request

ChannelMessageSubmission

Returns

Promise<ChannelSubmittedRun>