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"
http
Module http
Index
Type aliases
Router
Extension
Functions
create
Router
For
Bot
create
Short
Link
decode
External
Token
delete
Router
For
Bot
delete
Short
Link
extract
External
Token
get
Axios
Config
For
Bot
has
Permission
need
Permission
Type aliases
Router
Extension
Router
Extension
:
object
&
Router
Functions
create
Router
For
Bot
create
Router
For
Bot
(
routerName
:
string
, options
?:
RouterOptions
)
:
RouterExtension
Parameters
routerName:
string
Optional
options:
RouterOptions
Returns
RouterExtension
create
Short
Link
create
Short
Link
(
name
:
string
, destination
:
string
, params
?:
any
)
:
void
Parameters
name:
string
destination:
string
Optional
params:
any
Returns
void
decode
External
Token
decode
External
Token
(
token
:
string
)
:
Promise
<
any
>
Parameters
token:
string
Returns
Promise
<
any
>
The decoded payload
delete
Router
For
Bot
delete
Router
For
Bot
(
routerName
:
string
)
:
any
Parameters
routerName:
string
Returns
any
delete
Short
Link
delete
Short
Link
(
name
:
any
)
:
void
Parameters
name:
any
Returns
void
extract
External
Token
extract
External
Token
(
req
:
Request
, res
:
Response
, next
:
NextFunction
)
:
Promise
<
void
>
Parameters
req:
Request
res:
Response
next:
NextFunction
Returns
Promise
<
void
>
get
Axios
Config
For
Bot
get
Axios
Config
For
Bot
(
botId
:
string
, options
?:
AxiosOptions
)
:
Promise
<
AxiosBotConfig
>
Parameters
botId:
string
Optional
options:
AxiosOptions
Returns
Promise
<
AxiosBotConfig
>
The configuration to use
has
Permission
has
Permission
(
req
:
any
, operation
:
string
, resource
:
string
, noAudit
?:
boolean
)
:
Promise
<
boolean
>
Parameters
req:
any
operation:
string
resource:
string
Optional
noAudit:
boolean
Returns
Promise
<
boolean
>
need
Permission
need
Permission
(
operation
:
string
, resource
:
string
)
:
function
Parameters
operation:
string
resource:
string
Returns
function
(
req
:
Request
, res
:
Response
, next
:
NextFunction
)
:
Promise
<
void
>
Parameters
req:
Request
res:
Response
next:
NextFunction
Returns
Promise
<
void
>
Globals
"botpress/sdk"
IO
NDU
NLU
bots
cms
config
dialog
distributed
events
experimental
ghost
http
kvs
messaging
realtime
security
users
workspaces
Router
Extension
create
Router
For
Bot
create
Short
Link
decode
External
Token
delete
Router
For
Bot
delete
Short
Link
extract
External
Token
get
Axios
Config
For
Bot
has
Permission
need
Permission
Generated using
TypeDoc