GitHub
Preparing search index...
The search index is not available
Documentation
Documentation
@forgerock/journey-client
index
JourneyClient
Interface JourneyClient
The journey client instance returned by the
journey()
function.
interface
JourneyClient
{
getState
:
()
=>
unknown
;
next
:
(
step
:
JourneyStep
,
options
?:
NextOptions
)
=>
Promise
<
JourneyResult
>
;
redirect
:
(
step
:
JourneyStep
)
=>
Promise
<
void
>
;
resume
:
(
url
:
string
,
options
?:
ResumeOptions
)
=>
Promise
<
JourneyResult
>
;
start
:
(
options
?:
StartParam
)
=>
Promise
<
JourneyResult
>
;
subscribe
:
(
listener
:
()
=>
void
)
=>
()
=>
void
;
terminate
:
(
options
?:
{
query
?:
Record
<
string
,
string
>
}
,
)
=>
Promise
<
void
|
GenericError
>
;
}
Index
Properties
get
State
next
redirect
resume
start
subscribe
terminate
Properties
get
State
getState
:
()
=>
unknown
next
next
:
(
step
:
JourneyStep
,
options
?:
NextOptions
)
=>
Promise
<
JourneyResult
>
redirect
redirect
:
(
step
:
JourneyStep
)
=>
Promise
<
void
>
resume
resume
:
(
url
:
string
,
options
?:
ResumeOptions
)
=>
Promise
<
JourneyResult
>
start
start
:
(
options
?:
StartParam
)
=>
Promise
<
JourneyResult
>
subscribe
subscribe
:
(
listener
:
()
=>
void
)
=>
()
=>
void
terminate
terminate
:
(
options
?:
{
query
?:
Record
<
string
,
string
>
}
,
)
=>
Promise
<
void
|
GenericError
>
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
On This Page
Properties
get
State
next
redirect
resume
start
subscribe
terminate
GitHub
Documentation
Loading...
The journey client instance returned by the
journey()function.