Search
Preparing search index...
The search index is not available
Botpress SDK
Options
All
Public
Public/Protected
All
Inherited
Only exported
Menu
Globals
"botpress/sdk"
events
Module events
Index
Functions
find
Events
is
Incoming
Queue
Empty
register
Middleware
remove
Middleware
reply
ToEvent
save
User
Feedback
send
Event
update
Event
Functions
find
Events
find
Events
(
fields
:
Partial
<
StoredEvent
>
, searchParams
?:
EventSearchParams
)
:
Promise
<
StoredEvent
[]
>
Parameters
fields:
Partial
<
StoredEvent
>
Optional
searchParams:
EventSearchParams
Returns
Promise
<
StoredEvent
[]
>
is
Incoming
Queue
Empty
is
Incoming
Queue
Empty
(
event
:
IncomingEvent
)
:
boolean
Parameters
event:
IncomingEvent
Returns
boolean
register
Middleware
register
Middleware
(
middleware
:
MiddlewareDefinition
)
:
void
Parameters
middleware:
MiddlewareDefinition
Returns
void
remove
Middleware
remove
Middleware
(
middlewareName
:
any
)
:
void
Parameters
middlewareName:
any
Returns
void
reply
ToEvent
reply
ToEvent
(
eventDestination
:
EventDestination
, payloads
:
any
[]
, incomingEventId
?:
string
)
:
Promise
<
void
>
Parameters
eventDestination:
EventDestination
payloads:
any
[]
Optional
incomingEventId:
string
Returns
Promise
<
void
>
save
User
Feedback
save
User
Feedback
(
incomingEventId
:
string
, target
:
string
, feedback
:
number
, type
?:
string
)
:
Promise
<
boolean
>
Parameters
incomingEventId:
string
target:
string
feedback:
number
Optional
type:
string
Returns
Promise
<
boolean
>
true if feedback was successfully saved
send
Event
send
Event
(
event
:
Event
)
:
Promise
<
void
>
Parameters
event:
Event
Returns
Promise
<
void
>
update
Event
update
Event
(
id
:
string
, fields
:
Partial
<
StoredEvent
>
)
:
Promise
<
void
>
Parameters
id:
string
fields:
Partial
<
StoredEvent
>
Returns
Promise
<
void
>
Globals
"botpress/sdk"
IO
NDU
NLU
bots
cms
config
dialog
distributed
events
experimental
ghost
http
kvs
messaging
realtime
security
users
workspaces
find
Events
is
Incoming
Queue
Empty
register
Middleware
remove
Middleware
reply
ToEvent
save
User
Feedback
send
Event
update
Event
Generated using
TypeDoc