@greywallsoftware/veoci-js
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
API
Api
V1
Api
V2
constructor
container
form
object
session
Data
workflow
Api
Web
Utils
Veoci
Auth
VeociJS
APIConfig
APIV1
Config
APIV2
Config
APIWeb
Config
On
Auth
State
Changed
Veoci
Config
ACCESS_
TOKEN_
EXPIRATION_
THRESHOLD
AUTHORIZATION_
HEADER
AUTHORIZATION_
STORAGE_
KEY
Cancel
Token
MFA_
STORAGE_
KEY
REFRESH_
HEADER
REFRESH_
STORAGE_
KEY
REFRESH_
TOKEN_
EXPIRATION_
THRESHOLD
REFRESH_
TOKEN_
URL
TOKEN_
PREFIX
X_
VEOCI_
API_
AUTH
instance
run
Async
Callback
application
Json
Hierarchy
ApiV2
Index
Constructors
constructor
Methods
container
form
object
session
Data
workflow
Constructors
constructor
new
Api
V2
(
config
?:
APIV2Config
)
:
ApiV2
Parameters
Optional
config:
APIV2Config
Returns
ApiV2
Methods
container
container
(
containerId
:
string
)
:
object
Parameters
containerId:
string
Returns
object
breadcrumbs
:
function
breadcrumbs
(
__namedParameters
:
object
)
:
Promise
<
any
>
Parameters
__namedParameters:
object
container
Type
:
string
object
Id
:
undefined
|
string
object
Type
:
undefined
|
string
Returns
Promise
<
any
>
forms
:
object
get
:
function
get
(
__namedParameters
?:
object
)
:
Promise
<
any
>
Parameters
Default value
__namedParameters:
object
= {}
fields
:
undefined
|
string
query
By
:
undefined
|
string
Returns
Promise
<
any
>
form
form
(
formId
:
string
, containerId
:
string
)
:
object
Parameters
formId:
string
containerId:
string
Returns
object
entry
:
function
entry
(
entryId
:
string
)
:
object
Parameters
entryId:
string
Returns
object
create
:
function
create
(
__namedParameters
:
object
)
:
undefined
|
Promise
<
any
>
Parameters
__namedParameters:
object
mode
:
string
values
:
object
Returns
undefined
|
Promise
<
any
>
evaluate
:
function
evaluate
(
__namedParameters
:
object
)
:
Promise
<
any
>
Parameters
__namedParameters:
object
canceller
:
Function
mode
:
string
values
:
object
Returns
Promise
<
any
>
get
:
function
get
(
)
:
undefined
|
Promise
<
any
>
Returns
undefined
|
Promise
<
any
>
init
:
function
init
(
)
:
undefined
|
Promise
<
any
>
Returns
undefined
|
Promise
<
any
>
patch
:
function
patch
(
__namedParameters
:
object
)
:
undefined
|
Promise
<
any
>
Parameters
__namedParameters:
object
values
:
object
Returns
undefined
|
Promise
<
any
>
update
:
function
update
(
__namedParameters
:
object
)
:
undefined
|
Promise
<
any
>
Parameters
__namedParameters:
object
values
:
object
Returns
undefined
|
Promise
<
any
>
entries
:
object
groups
:
function
groups
(
__namedParameters
:
object
)
:
Promise
<
any
>
Parameters
__namedParameters:
object
count
:
number
filters
:
string
start
:
number
Returns
Promise
<
any
>
structure
:
object
get
:
function
get
(
)
:
Promise
<
any
>
Returns
Promise
<
any
>
object
object
(
objectId
:
string
, containerId
:
string
)
:
object
Parameters
objectId:
string
containerId:
string
Returns
object
actions
:
object
evaluate
:
function
evaluate
(
__namedParameters
:
object
)
:
Promise
<
any
>
Parameters
__namedParameters:
object
action
Id
:
string
object
Ids
:
any
[]
parent
Id
:
string
scheduled
:
boolean
Returns
Promise
<
any
>
get
:
function
get
(
params
:
any
)
:
Promise
<
any
>
Parameters
params:
any
Returns
Promise
<
any
>
session
Data
session
Data
(
)
:
Promise
<
any
>
Fetches the session data for the logged in user
Returns
Promise
<
any
>
workflow
workflow
(
workflowId
:
string
, containerId
:
string
)
:
object
Parameters
workflowId:
string
containerId:
string
Returns
object
entry
:
function
entry
(
entryId
?:
undefined
|
string
)
:
object
Parameters
Optional
entryId:
undefined
|
string
Returns
object
create
:
function
create
(
__namedParameters
:
object
)
:
Promise
<
any
>
Parameters
__namedParameters:
object
entry
:
object
Returns
Promise
<
any
>
evaluate
:
function
evaluate
(
__namedParameters
:
object
)
:
Promise
<
any
>
Parameters
__namedParameters:
object
entry
:
object
step
Id
:
string
Returns
Promise
<
any
>
get
:
function
get
(
stepId
?:
undefined
|
string
)
:
Promise
<
any
>
Parameters
Optional
stepId:
undefined
|
string
Returns
Promise
<
any
>
init
:
function
init
(
)
:
undefined
|
Promise
<
any
>
Returns
undefined
|
Promise
<
any
>
update
:
function
update
(
__namedParameters
:
object
)
:
Promise
<
any
>
Parameters
__namedParameters:
object
action
:
string
entry
:
object
next
Step
Id
:
string
step
Id
:
string
Returns
Promise
<
any
>
structure
:
object
get
:
function
get
(
)
:
Promise
<
any
>
Returns
Promise
<
any
>
Generated using
TypeDoc
Fetches the session data for the logged in user