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

Interface: ChannelInstance

Runtime object created by a driver for one configured instance.

Methods

executeAction()?

optional executeAction(action, input?): Promise<void | JsonValue>

Parameters

action

string

input?

JsonValue

Returns

Promise<void | JsonValue>

---

handleCompletion()?

optional handleCompletion(completion): Promise<void>

Parameters

completion

ChannelRunCompletion

Returns

Promise<void>

---

handleInteractionRequest()?

optional handleInteractionRequest(request): Promise<void>

Parameters

request

ChannelInteractionRequest

Returns

Promise<void>

---

sendMessage()?

optional sendMessage(request): Promise<ChannelOutboundReceipt>

Parameters

request

ChannelOutboundRequest

Returns

Promise<ChannelOutboundReceipt>

---

start()

start(): Promise<void>

Returns

Promise<void>

---

status()

status(): Promise<ChannelStatus>

Returns

Promise<ChannelStatus>

---

stop()

stop(): Promise<void>

Returns

Promise<void>