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"
cms
Module cms
Index
Type aliases
Template
Item
Functions
create
OrUpdate
Content
Element
delete
Content
Elements
get
All
Content
Types
get
Content
Element
get
Content
Elements
get
File
Path
list
Content
Elements
read
File
render
Element
render
Template
save
File
Type aliases
Template
Item
Template
Item
:
Object
|
Object
[]
|
string
[]
|
string
Functions
create
OrUpdate
Content
Element
create
OrUpdate
Content
Element
(
botId
:
string
, contentTypeId
:
string
, formData
:
object
, contentElementId
?:
string
, language
?:
string
)
:
Promise
<
string
>
Parameters
botId:
string
contentTypeId:
string
formData:
object
Optional
contentElementId:
string
Optional
language:
string
Returns
Promise
<
string
>
delete
Content
Elements
delete
Content
Elements
(
botId
:
string
, contentElementIds
:
string
[]
)
:
Promise
<
void
>
Parameters
botId:
string
contentElementIds:
string
[]
Returns
Promise
<
void
>
get
All
Content
Types
get
All
Content
Types
(
botId
?:
string
)
:
Promise
<
ContentType
[]
>
Parameters
Optional
botId:
string
Returns
Promise
<
ContentType
[]
>
get
Content
Element
get
Content
Element
(
botId
:
string
, id
:
string
, language
?:
string
)
:
Promise
<
ContentElement
>
Parameters
botId:
string
id:
string
Optional
language:
string
Returns
Promise
<
ContentElement
>
A content element
get
Content
Elements
get
Content
Elements
(
botId
:
string
, ids
:
string
[]
, language
?:
string
)
:
Promise
<
ContentElement
[]
>
Parameters
botId:
string
ids:
string
[]
Optional
language:
string
Returns
Promise
<
ContentElement
[]
>
get
File
Path
get
File
Path
(
botId
:
string
, fileName
:
string
)
:
string
Parameters
botId:
string
fileName:
string
Returns
string
list
Content
Elements
list
Content
Elements
(
botId
:
string
, contentTypeId
?:
string
, searchParams
?:
SearchParams
, language
?:
string
)
:
Promise
<
ContentElement
[]
>
Parameters
botId:
string
Optional
contentTypeId:
string
Optional
searchParams:
SearchParams
Optional
language:
string
Returns
Promise
<
ContentElement
[]
>
read
File
read
File
(
botId
:
any
, fileName
:
any
)
:
Promise
<
Buffer
>
Parameters
botId:
any
fileName:
any
Returns
Promise
<
Buffer
>
render
Element
render
Element
(
contentId
:
string
, args
:
any
, eventDestination
:
EventDestination
)
:
Promise
<
any
[]
>
Parameters
contentId:
string
args:
any
eventDestination:
EventDestination
Returns
Promise
<
any
[]
>
An array of payloads
render
Template
render
Template
(
item
:
TemplateItem
, context
:
any
)
:
TemplateItem
Parameters
item:
TemplateItem
context:
any
Returns
TemplateItem
save
File
save
File
(
botId
:
string
, fileName
:
string
, content
:
Buffer
)
:
Promise
<
string
>
Parameters
botId:
string
fileName:
string
content:
Buffer
Returns
Promise
<
string
>
Globals
"botpress/sdk"
IO
NDU
NLU
bots
cms
config
dialog
distributed
events
experimental
ghost
http
kvs
messaging
realtime
security
users
workspaces
Template
Item
create
OrUpdate
Content
Element
delete
Content
Elements
get
All
Content
Types
get
Content
Element
get
Content
Elements
get
File
Path
list
Content
Elements
read
File
render
Element
render
Template
save
File
Generated using
TypeDoc