ChatInstance - Photon

Properties

required

Unified History API. Sub-APIs:

history.user — cross-platform per-user transcript store (throws if not configured)
history.thread — per-thread message listing
history.channel — channel-level messages and thread listings

required

Cross-platform per-user transcript store. Deprecated alias for ChatInstance.history.user — throws on access when user history was not configured (history.user or legacy transcripts + identity).

Deprecated: Use ChatInstance.history.user instead.

Methods

abortTurn()

abortTurn(threadId: string): Promise<void>

Abort active work for a conversation, including work running in another process that shares the configured state adapter.

Parameters

string

required

Returns

Promise<void>

getLogger()

getLogger(prefix?: string): Logger

Get the configured logger, optionally with a child prefix

Parameters

string

Returns

Logger

getState()

getState(): StateAdapter

Returns

StateAdapter

getUserName()

getUserName(): string

Returns

string

handleIncomingMessage()

handleIncomingMessage(adapter: Adapter, threadId: string, message: Message): Promise<void>

Parameters

Adapter

required

string

required

Message

required

Returns

Promise<void>

processAction()

processAction(event: Omit<ActionEvent<unknown>, "thread" | "openModal"> & { adapter: Adapter }, options: WebhookOptions | undefined): Promise<void>

Process an incoming action event (button click) from an adapter. Handles waitUntil registration and error catching internally.

Parameters

Omit<ActionEvent<unknown>, "thread" | "openModal"> & { adapter: Adapter }

required

Type: ActionEventAdapterThe action event (without thread field, will be added)

WebhookOptions | undefined

required

Type: WebhookOptionsWebhook options including waitUntil

Returns

Promise<void>

processAgentSessionStopped()

processAgentSessionStopped(event: AgentSessionStoppedEvent, options?: WebhookOptions): void

Parameters

AgentSessionStoppedEvent

required

WebhookOptions

processAgentSessionTitleChanged()

processAgentSessionTitleChanged(event: AgentSessionTitleChangedEvent, options?: WebhookOptions): void

Parameters

AgentSessionTitleChangedEvent

required

WebhookOptions

processAppContextChanged()

processAppContextChanged(event: AppContextChangedEvent, options?: WebhookOptions): void

Parameters

AppContextChangedEvent

required

WebhookOptions

processAppHomeOpened()

processAppHomeOpened(event: AppHomeOpenedEvent, options?: WebhookOptions): void

Parameters

AppHomeOpenedEvent

required

WebhookOptions

processAssistantContextChanged()

processAssistantContextChanged(event: AssistantContextChangedEvent, options?: WebhookOptions): void

Parameters

AssistantContextChangedEvent

required

WebhookOptions

processAssistantThreadStarted()

processAssistantThreadStarted(event: AssistantThreadStartedEvent, options?: WebhookOptions): void

Parameters

AssistantThreadStartedEvent

required

WebhookOptions

processInstalled()

processInstalled(event: InstalledEvent, options?: WebhookOptions): void

Optional so custom ChatInstance implementations predating it keep compiling.

Parameters

InstalledEvent

required

WebhookOptions

processMemberJoinedChannel()

processMemberJoinedChannel(event: MemberJoinedChannelEvent, options?: WebhookOptions): void

Parameters

MemberJoinedChannelEvent

required

WebhookOptions

processMessage()

processMessage(adapter: Adapter, threadId: string, message: Message<unknown> | () => Promise<Message<unknown>>, options?: WebhookOptions): Promise<void>

Process an incoming message from an adapter. Handles waitUntil registration and error catching internally.

Parameters

Adapter

required

The adapter that received the message

string

required

The thread ID

Message<unknown> | () => Promise<Message<unknown>>

required

Type: MessageMessageEither a parsed message, or a factory function for lazy async parsing

WebhookOptions

Webhook options including waitUntil

Returns

Promise<void>

processMessageDeleted()

processMessageDeleted(event: Omit<MessageDeletedEvent<unknown>, "platform" | "adapter"> & { adapter: Adapter; platform: string }, options?: WebhookOptions): Promise<void>

Process an incoming message delete from an adapter. Handles waitUntil registration and error catching internally.

Parameters

Omit<MessageDeletedEvent<unknown>, "platform" | "adapter"> & { adapter: Adapter…

required

Type: MessageDeletedEventAdapterThe normalized delete event

WebhookOptions

Webhook options including waitUntil

Returns

Promise<void>

processMessageUpdated()

processMessageUpdated(event: { adapter: Adapter; message: Message<unknown> | () => Promise<Message<unknown>>; previousMessage: Message<unknown> | () => Promise<Message<unknown>>; threadId: string }, options?: WebhookOptions): Promise<void>

Process an incoming message update from an adapter. Handles waitUntil registration and error catching internally.

Parameters

{ adapter: Adapter; message: Message<unknown> | () => Promise<Message<unknown>>…

required

Type: AdapterMessageMessageMessageMessage

WebhookOptions

Webhook options including waitUntil

Returns

Promise<void>

processModalClose()

processModalClose(event: Omit<ModalCloseEvent, "relatedThread" | "relatedMessage" | "relatedChannel">, contextId?: string, options?: WebhookOptions): void

Process a modal close event from an adapter.

Parameters

Omit<ModalCloseEvent, "relatedThread" | "relatedMessage" | "relatedChannel">

required

Type: ModalCloseEventThe modal close event (without relatedThread/relatedMessage/relatedChannel)

string

Context ID for retrieving stored thread/message/channel context

WebhookOptions

Webhook options

processModalSubmit()

processModalSubmit(event: Omit<ModalSubmitEvent, "relatedThread" | "relatedMessage" | "relatedChannel">, contextId?: string, options?: WebhookOptions): Promise<ModalResponse | undefined>

Process a modal submit event from an adapter.

Parameters

Omit<ModalSubmitEvent, "relatedThread" | "relatedMessage" | "relatedChannel">

required

Type: ModalSubmitEventThe modal submit event (without relatedThread/relatedMessage/relatedChannel)

string

Context ID for retrieving stored thread/message/channel context

WebhookOptions

Webhook options

Returns

ModalResponse

processOptionsLoad()

processOptionsLoad(event: OptionsLoadEvent, options?: WebhookOptions): Promise<OptionsLoadResult | undefined>

Process an interactive options load event from an adapter. Returns normalized select options for the adapter to render.

Parameters

OptionsLoadEvent

required

WebhookOptions

Returns

OptionsLoadResult

processReaction()

processReaction(event: Omit<ReactionEvent<unknown>, "thread" | "adapter"> & { adapter: Adapter<unknown, unknown> }, options?: WebhookOptions): void | Promise<void>

Process an incoming reaction event from an adapter. Handles waitUntil registration and error catching internally.

Parameters

Omit<ReactionEvent<unknown>, "thread" | "adapter"> & { adapter: Adapter<unknown…

required

Type: ReactionEventAdapterThe reaction event (without adapter field, will be added)

WebhookOptions

Webhook options including waitUntil

Returns

void | Promise<void>

processSlashCommand()

processSlashCommand(event: Omit<SlashCommandEvent<Record<string, unknown>>, "channel" | "openModal"> & { adapter: Adapter; channelId: string }, options: WebhookOptions | undefined): void | Promise<void>

Process an incoming slash command from an adapter. Handles waitUntil registration and error catching internally.

Parameters

Omit<SlashCommandEvent<Record<string, unknown>>, "channel" | "openModal"> & { a…

required

Type: SlashCommandEventAdapterThe slash command event

WebhookOptions | undefined

required

Type: WebhookOptionsWebhook options including waitUntil

Returns

void | Promise<void>

processUninstalled()

processUninstalled(event: UninstalledEvent, options?: WebhookOptions): void

Optional so custom ChatInstance implementations predating it keep compiling.

Parameters

UninstalledEvent

required

WebhookOptions

​Properties

​Methods

​abortTurn()

​Parameters

​Returns

​getLogger()

​Parameters

​Returns

​getState()

​Returns

​getUserName()

​Returns

​handleIncomingMessage()

​Parameters

​Returns

​processAction()

​Parameters

​Returns

​processAgentSessionStopped()

​Parameters

​processAgentSessionTitleChanged()

​Parameters

​processAppContextChanged()

​Parameters

​processAppHomeOpened()

​Parameters

​processAssistantContextChanged()

​Parameters

​processAssistantThreadStarted()

​Parameters

​processInstalled()

​Parameters

​processMemberJoinedChannel()

​Parameters

​processMessage()

​Parameters

​Returns

​processMessageDeleted()

​Parameters

​Returns

​processMessageUpdated()

​Parameters

​Returns

​processModalClose()

​Parameters

​processModalSubmit()

​Parameters

​Returns

​processOptionsLoad()

​Parameters

​Returns

​processReaction()

​Parameters

​Returns

​processSlashCommand()

​Parameters

​Returns

​processUninstalled()

​Parameters

Properties

Methods

abortTurn()

Parameters

Returns

getLogger()

Parameters

Returns

getState()

Returns

getUserName()

Returns

handleIncomingMessage()

Parameters

Returns

processAction()

Parameters

Returns

processAgentSessionStopped()

Parameters

processAgentSessionTitleChanged()

Parameters

processAppContextChanged()

Parameters

processAppHomeOpened()

Parameters

processAssistantContextChanged()

Parameters

processAssistantThreadStarted()

Parameters

processInstalled()

Parameters

processMemberJoinedChannel()

Parameters

processMessage()

Parameters

Returns

processMessageDeleted()

Parameters

Returns

processMessageUpdated()

Parameters

Returns

processModalClose()

Parameters

processModalSubmit()

Parameters

Returns

processOptionsLoad()

Parameters

Returns

processReaction()

Parameters

Returns

processSlashCommand()

Parameters

Returns

processUninstalled()

Parameters