Interface BotConversations

Hierarchy

BotConversations

Index

Methods

Methods

create

create(userId: uuid): Promise<Conversation>

- Defined in botpress.d.ts:2287
Parameters
- userId: uuid
Returns Promise<Conversation>

The created conversation

createMapping

createMapping(channel: string, localId: uuid, foreignId: string): Promise<void>

- Defined in botpress.d.ts:2348
Parameters
- channel: string
- localId: uuid
- foreignId: string
Returns Promise<void>

delete

delete(filters: ConversationDeleteFilters): Promise<number>

- Defined in botpress.d.ts:2299
Parameters
- filters: ConversationDeleteFilters
Returns Promise<number>

The number of deleted rows

deleteMapping

deleteMapping(channel: string, localId: uuid, foreignId: string): Promise<boolean>

- Defined in botpress.d.ts:2354
Parameters
- channel: string
- localId: uuid
- foreignId: string
Returns Promise<boolean>

true if a conversation was deleted

get

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

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

The matching conversation or undefined if none were found

getForeignId

getForeignId(channel: string, localId: uuid): Promise<string | undefined>

- Defined in botpress.d.ts:2359
Parameters
- channel: string
- localId: uuid
Returns Promise<string | undefined>

getLocalId

getLocalId(channel: string, foreignId: string): Promise<string | undefined>

- Defined in botpress.d.ts:2364
Parameters
- channel: string
- foreignId: string
Returns Promise<string | undefined>

list

list(filters: ConversationListFilters): Promise<RecentConversation[]>

- Defined in botpress.d.ts:2319
Parameters
- filters: ConversationListFilters
Returns Promise<RecentConversation[]>

recent

recent(userId: uuid): Promise<Conversation>

- Defined in botpress.d.ts:2328
Parameters
- userId: uuid
Returns Promise<Conversation>

Generated using TypeDoc