Interface MessagingClient

Hierarchy

MessagingClient

Index

Properties

Methods

Properties

clientId

clientId: uuid

clientToken

clientToken: string | undefined

webhookToken

webhookToken: string | undefined

Methods

createConversation

createConversation(userId: uuid): Promise<Conversation>

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

info of the newly created conversation

createMessage

createMessage(conversationId: uuid, authorId: uuid | undefined, payload: any, flags?: object): Promise<Message>

- Defined in botpress.d.ts:1821
Parameters
- conversationId: uuid
- authorId: uuid | undefined
- payload: any
- Optional flags: object
  - incomingId: uuid
Returns Promise<Message>

info of the created message

createUser

createUser(): Promise<MessagingUser>

- Defined in botpress.d.ts:1783
Returns Promise<MessagingUser>

info of the newly created user

deleteMessage

deleteMessage(id: uuid): Promise<boolean>

- Defined in botpress.d.ts:1849
Parameters
- id: uuid
Returns Promise<boolean>

true if a message was deleted

deleteMessagesByConversation

deleteMessagesByConversation(conversationId: uuid): Promise<number>

- Defined in botpress.d.ts:1856
Parameters
- conversationId: uuid
Returns Promise<number>

amount of messages deleted

getConversation

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

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

info of the conversation or undefined if not found

getMessage

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

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

info of the message or undefined if not found

getUser

getUser(id: uuid): Promise<MessagingUser | undefined>

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

info of the user or undefined if not found

listConversations

listConversations(userId: uuid, limit?: number): Promise<Conversation[]>

- Defined in botpress.d.ts:1811
Parameters
- userId: uuid
- Optional limit: number
Returns Promise<Conversation[]>

an array of conversations

listEndpoints

listEndpoints(conversationId: uuid): Promise<Endpoint[]>

- Defined in botpress.d.ts:1871
Parameters
- conversationId: uuid
Returns Promise<Endpoint[]>

an array of endpoints that are linked to the provided conversation

listMessages

listMessages(conversationId: uuid, limit?: number): Promise<Message[]>

- Defined in botpress.d.ts:1842
Parameters
- conversationId: uuid
- Optional limit: number
Returns Promise<Message[]>

an array of conversations

mapEndpoint

mapEndpoint(endpoint: Endpoint): Promise<uuid>

- Defined in botpress.d.ts:1864
Parameters
- endpoint: Endpoint
Returns Promise<uuid>

a conversation id associated to the endpoint

Generated using TypeDoc