Interface BotMessages

Hierarchy

BotMessages

Index

Methods

Methods

create

create(conversationId: uuid, payload: any, authorId?: string, eventId?: string, incomingEventId?: string): Promise<Message>

- Defined in botpress.d.ts:2407
Parameters
- conversationId: uuid
- payload: any
- Optional authorId: string
- Optional eventId: string
- Optional incomingEventId: string
Returns Promise<Message>

The created message

delete

delete(filters: MessageDeleteFilters): Promise<number>

- Defined in botpress.d.ts:2426
Parameters
- filters: MessageDeleteFilters
Returns Promise<number>

The number of deleted rows

get

get(id: uuid): Promise<Message | undefined>

- Defined in botpress.d.ts:2436
Parameters
- id: uuid
Returns Promise<Message | undefined>

The matching message or undefined if none were found

list

list(filters: MessageListFilters): Promise<Message[]>

- Defined in botpress.d.ts:2446
Parameters
- filters: MessageListFilters
Returns Promise<Message[]>

receive

receive(conversationId: uuid, payload: any, args?: MessageArgs): Promise<Message>

- Defined in botpress.d.ts:2396
Parameters
- conversationId: uuid
- payload: any
- Optional args: MessageArgs
Returns Promise<Message>

send

send(conversationId: uuid, payload: any, args?: MessageArgs): Promise<Message>

- Defined in botpress.d.ts:2383
Parameters
- conversationId: uuid
- payload: any
- Optional args: MessageArgs
Returns Promise<Message>

Generated using TypeDoc