@japofc/baileys - v2.4.7
GitHub
npm
Preparing search index...
ConversationFlow
Interface ConversationFlow
interface
ConversationFlow
{
size
:
number
;
answer
(
chat
:
string
,
user
:
string
,
text
:
string
,
sock
?:
unknown
,
)
:
Promise
<
"cancelled"
|
"back"
|
"invalid"
|
"complete"
|
"next"
|
null
>
;
bind
(
sock
:
unknown
)
:
()
=>
void
;
cancel
(
chat
:
string
,
user
:
string
,
reason
?:
string
)
:
boolean
;
clear
()
:
void
;
define
(
name
:
string
,
steps
:
FlowStep
[]
)
:
ConversationFlow
;
getSession
(
chat
:
string
,
user
:
string
)
:
FlowSessionInfo
|
null
;
handler
(
upsert
:
{
messages
:
unknown
[]
}
,
sock
?:
unknown
)
:
Promise
<
void
>
;
isActive
(
chat
:
string
,
user
:
string
)
:
boolean
;
onCancel
(
cb
:
(
event
:
FlowEndEvent
)
=>
void
)
:
()
=>
void
;
onComplete
(
cb
:
(
event
:
FlowEndEvent
)
=>
void
)
:
()
=>
void
;
onStep
(
cb
:
(
info
:
{
chat
:
string
;
flow
:
string
;
prompt
:
string
;
step
:
string
;
user
:
string
;
}
,
)
=>
void
,
)
:
()
=>
void
;
start
(
sock
:
unknown
,
chat
:
string
,
user
:
string
,
flowName
:
string
,
seed
?:
Record
<
string
,
unknown
>
,
)
:
Promise
<
unknown
>
;
unbind
()
:
void
;
}
Index
Properties
size
Methods
answer
bind
cancel
clear
define
get
Session
handler
is
Active
on
Cancel
on
Complete
on
Step
start
unbind
Properties
Readonly
size
size
:
number
Methods
answer
answer
(
chat
:
string
,
user
:
string
,
text
:
string
,
sock
?:
unknown
,
)
:
Promise
<
"cancelled"
|
"back"
|
"invalid"
|
"complete"
|
"next"
|
null
>
Parameters
chat
:
string
user
:
string
text
:
string
Optional
sock
:
unknown
Returns
Promise
<
"cancelled"
|
"back"
|
"invalid"
|
"complete"
|
"next"
|
null
>
bind
bind
(
sock
:
unknown
)
:
()
=>
void
Parameters
sock
:
unknown
Returns
()
=>
void
cancel
cancel
(
chat
:
string
,
user
:
string
,
reason
?:
string
)
:
boolean
Parameters
chat
:
string
user
:
string
Optional
reason
:
string
Returns
boolean
clear
clear
()
:
void
Returns
void
define
define
(
name
:
string
,
steps
:
FlowStep
[]
)
:
ConversationFlow
Parameters
name
:
string
steps
:
FlowStep
[]
Returns
ConversationFlow
get
Session
getSession
(
chat
:
string
,
user
:
string
)
:
FlowSessionInfo
|
null
Parameters
chat
:
string
user
:
string
Returns
FlowSessionInfo
|
null
handler
handler
(
upsert
:
{
messages
:
unknown
[]
}
,
sock
?:
unknown
)
:
Promise
<
void
>
Parameters
upsert
:
{
messages
:
unknown
[]
}
Optional
sock
:
unknown
Returns
Promise
<
void
>
is
Active
isActive
(
chat
:
string
,
user
:
string
)
:
boolean
Parameters
chat
:
string
user
:
string
Returns
boolean
on
Cancel
onCancel
(
cb
:
(
event
:
FlowEndEvent
)
=>
void
)
:
()
=>
void
Parameters
cb
:
(
event
:
FlowEndEvent
)
=>
void
Returns
()
=>
void
on
Complete
onComplete
(
cb
:
(
event
:
FlowEndEvent
)
=>
void
)
:
()
=>
void
Parameters
cb
:
(
event
:
FlowEndEvent
)
=>
void
Returns
()
=>
void
on
Step
onStep
(
cb
:
(
info
:
{
chat
:
string
;
flow
:
string
;
prompt
:
string
;
step
:
string
;
user
:
string
;
}
,
)
=>
void
,
)
:
()
=>
void
Parameters
cb
:
(
info
:
{
chat
:
string
;
flow
:
string
;
prompt
:
string
;
step
:
string
;
user
:
string
;
}
,
)
=>
void
Returns
()
=>
void
start
start
(
sock
:
unknown
,
chat
:
string
,
user
:
string
,
flowName
:
string
,
seed
?:
Record
<
string
,
unknown
>
,
)
:
Promise
<
unknown
>
Parameters
sock
:
unknown
chat
:
string
user
:
string
flowName
:
string
Optional
seed
:
Record
<
string
,
unknown
>
Returns
Promise
<
unknown
>
unbind
unbind
()
:
void
Returns
void
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Properties
size
Methods
answer
bind
cancel
clear
define
get
Session
handler
is
Active
on
Cancel
on
Complete
on
Step
start
unbind
GitHub
npm
@japofc/baileys - v2.4.7
Loading...