Documentation
Preparing search index...
@saltcorn/data
base-plugin/viewtemplates/edit
edit
Variable edit
edit
:
{
authorise_get
:
(
param0
:
{
query
:
GenObj
;
req
:
Req
;
table_id
:
string
|
number
}
,
param1
:
GenObj
,
)
=>
Promise
<
any
>
;
authorise_post
:
(
param0
:
{
body
:
GenObj
;
req
:
Req
;
table_id
:
string
|
number
}
,
param1
:
GenObj
,
)
=>
Promise
<
any
>
;
authorizeDataStream
:
(
view
:
any
,
id
:
any
,
fieldName
:
string
,
user
:
any
,
targetOpts
:
any
,
)
=>
Promise
<
boolean
>
;
configCheck
:
(
view
:
View
,
)
=>
Promise
<
{
errors
:
string
[]
;
warnings
:
string
[]
}
>
;
configuration_workflow
:
(
req
:
Req
)
=>
Workflow
;
connectedObjects
:
(
configuration
:
GenObj
)
=>
Promise
<
ConnectedObjects
>
;
createBasicView
:
(
param0
:
GenObj
)
=>
Promise
<
any
>
;
description
:
string
;
get_state_fields
:
(
table_id
:
string
|
number
,
viewname
:
string
,
param2
:
GenObj
,
)
=>
Promise
<
{
name
:
string
;
primary_key
:
boolean
;
type
:
string
}
[]
>
;
initial_config
:
(
__namedParameters
:
{
exttable_name
?:
string
;
table_id
?:
number
}
,
)
=>
Promise
<
any
>
;
name
:
string
;
openDataStream
:
(
tableId
:
string
|
number
,
viewName
:
string
,
id
:
any
,
fieldName
:
string
,
fieldView
:
string
,
user
:
any
,
configuration
:
GenObj
,
targetOpts
:
any
,
)
=>
Promise
<
any
>
;
queries
:
(
param0
:
GenObj
,
)
=>
{
actionQuery
()
:
Promise
<
any
>
;
authorizeGetQuery
(
query
:
GenObj
,
table_id
:
string
|
number
,
)
:
Promise
<
string
|
number
|
boolean
|
null
|
undefined
>
;
authorizePostQuery
(
body
:
GenObj
,
table_id
:
string
|
number
,
)
:
Promise
<
boolean
|
""
|
null
>
;
editManyQuery
(
state
:
GenObj
,
__namedParameters
:
GenObj
,
)
:
Promise
<
{
fields
:
Field
[]
;
rows
:
Row
[]
;
table
:
Table
}
>
;
editQuery
(
state
:
GenObj
,
mobileReferrer
:
string
|
undefined
,
isPreview
:
boolean
,
hiddenLoginDest
:
any
,
)
:
Promise
<
string
>
;
getRowByIdQuery
(
id
:
any
)
:
Promise
<
Row
|
null
>
;
getRowQuery
(
table_id
:
string
|
number
,
view_select
:
any
,
row_id
:
any
,
order_field
?:
string
,
)
:
Promise
<
Row
[]
>
;
optionsQuery
(
reftable_name
:
string
,
type
:
any
,
attributes
:
any
,
where
:
GenObj
,
)
:
Promise
<
Row
[]
>
;
saveFileFromContentsQuery
(
fieldVal
:
string
,
fieldId
:
number
,
fieldView
:
string
,
row
:
GenObj
,
filename
:
string
,
encoding
?:
string
,
)
:
Promise
<
string
>
;
saveFileQuery
(
fieldVal
:
string
,
fieldId
:
number
,
fieldView
:
string
,
row
:
GenObj
,
)
:
Promise
<
string
>
;
tryInsertQuery
(
row
:
GenObj
,
)
:
Promise
<
{
error
:
string
}
|
{
success
:
PrimaryKeyValue
}
>
;
tryUpdateQuery
(
row
:
GenObj
,
id
:
any
)
:
Promise
<
any
>
;
updateMatchingQuery
(
where
:
GenObj
,
updateVals
:
GenObj
,
repeatFields
:
any
[]
,
childRows
:
GenObj
,
)
:
Promise
<
|
any
[]
|
{
error
?:
undefined
;
inEditError
?:
undefined
;
rowError
:
any
}
|
{
error
?:
undefined
;
inEditError
:
any
;
rowError
?:
undefined
}
|
{
error
:
any
;
inEditError
?:
undefined
;
rowError
?:
undefined
}
,
>
;
}
;
routes
:
{
run_action
:
(
table_id
:
string
|
number
,
viewname
:
string
,
__namedParameters
:
GenObj
,
body
:
GenObj
,
__namedParameters
:
{
req
:
Req
;
res
:
Res
}
,
__namedParameters
:
GenObj
,
)
=>
Promise
<
any
>
;
update_matching_rows
:
(
table_id
:
string
|
number
,
viewname
:
string
,
__namedParameters
:
GenObj
,
body
:
GenObj
,
__namedParameters
:
{
redirect
?:
string
;
req
:
Req
;
res
:
Res
}
,
__namedParameters
:
GenObj
,
)
=>
Promise
<
void
>
;
}
;
run
:
(
table_id
:
string
|
number
,
viewname
:
string
,
cfg
:
GenObj
,
state
:
GenObj
,
param4
:
{
hiddenLoginDest
?:
any
;
isPreview
?:
boolean
;
req
:
Req
;
res
:
Res
}
,
param5
:
GenObj
,
)
=>
Promise
<
any
>
;
runMany
:
(
table_id
:
string
|
number
,
viewname
:
string
,
param2
:
GenObj
,
state
:
GenObj
,
extra
:
any
,
param5
:
GenObj
,
)
=>
Promise
<
any
[]
>
;
runPost
:
(
table_id
:
string
|
number
,
viewname
:
string
,
param2
:
GenObj
,
state
:
GenObj
,
body
:
GenObj
,
param5
:
{
redirect
?:
string
;
req
:
Req
;
res
:
Res
}
,
param6
:
GenObj
,
remote
?:
boolean
,
)
=>
Promise
<
void
>
;
virtual_triggers
:
(
table_id
:
string
|
number
,
viewname
:
string
,
param2
:
GenObj
,
)
=>
{
run
:
(
row
:
GenObj
,
__namedParameters
:
GenObj
)
=>
Promise
<
void
>
;
table_id
:
string
|
number
;
when_trigger
:
string
;
}
[]
;
getStringsForI18n
(
param0
:
GenObj
)
:
string
[]
;
interpolate_title_string
(
table_id
:
string
|
number
,
title
:
string
,
state
:
GenObj
,
)
:
Promise
<
string
>
;
}
Type Declaration
authorise_get
:
(
param0
:
{
query
:
GenObj
;
req
:
Req
;
table_id
:
string
|
number
}
,
param1
:
GenObj
,
)
=>
Promise
<
any
>
authorise_post
:
(
param0
:
{
body
:
GenObj
;
req
:
Req
;
table_id
:
string
|
number
}
,
param1
:
GenObj
,
)
=>
Promise
<
any
>
authorizeDataStream
:
(
view
:
any
,
id
:
any
,
fieldName
:
string
,
user
:
any
,
targetOpts
:
any
,
)
=>
Promise
<
boolean
>
configCheck
:
(
view
:
View
)
=>
Promise
<
{
errors
:
string
[]
;
warnings
:
string
[]
}
>
configuration_workflow
:
(
req
:
Req
)
=>
Workflow
connectedObjects
:
(
configuration
:
GenObj
)
=>
Promise
<
ConnectedObjects
>
createBasicView
:
(
param0
:
GenObj
)
=>
Promise
<
any
>
description
:
string
get_state_fields
:
(
table_id
:
string
|
number
,
viewname
:
string
,
param2
:
GenObj
,
)
=>
Promise
<
{
name
:
string
;
primary_key
:
boolean
;
type
:
string
}
[]
>
initial_config
:
(
__namedParameters
:
{
exttable_name
?:
string
;
table_id
?:
number
}
,
)
=>
Promise
<
any
>
name
:
string
openDataStream
:
(
tableId
:
string
|
number
,
viewName
:
string
,
id
:
any
,
fieldName
:
string
,
fieldView
:
string
,
user
:
any
,
configuration
:
GenObj
,
targetOpts
:
any
,
)
=>
Promise
<
any
>
queries
:
(
param0
:
GenObj
,
)
=>
{
actionQuery
()
:
Promise
<
any
>
;
authorizeGetQuery
(
query
:
GenObj
,
table_id
:
string
|
number
,
)
:
Promise
<
string
|
number
|
boolean
|
null
|
undefined
>
;
authorizePostQuery
(
body
:
GenObj
,
table_id
:
string
|
number
,
)
:
Promise
<
boolean
|
""
|
null
>
;
editManyQuery
(
state
:
GenObj
,
__namedParameters
:
GenObj
,
)
:
Promise
<
{
fields
:
Field
[]
;
rows
:
Row
[]
;
table
:
Table
}
>
;
editQuery
(
state
:
GenObj
,
mobileReferrer
:
string
|
undefined
,
isPreview
:
boolean
,
hiddenLoginDest
:
any
,
)
:
Promise
<
string
>
;
getRowByIdQuery
(
id
:
any
)
:
Promise
<
Row
|
null
>
;
getRowQuery
(
table_id
:
string
|
number
,
view_select
:
any
,
row_id
:
any
,
order_field
?:
string
,
)
:
Promise
<
Row
[]
>
;
optionsQuery
(
reftable_name
:
string
,
type
:
any
,
attributes
:
any
,
where
:
GenObj
,
)
:
Promise
<
Row
[]
>
;
saveFileFromContentsQuery
(
fieldVal
:
string
,
fieldId
:
number
,
fieldView
:
string
,
row
:
GenObj
,
filename
:
string
,
encoding
?:
string
,
)
:
Promise
<
string
>
;
saveFileQuery
(
fieldVal
:
string
,
fieldId
:
number
,
fieldView
:
string
,
row
:
GenObj
,
)
:
Promise
<
string
>
;
tryInsertQuery
(
row
:
GenObj
,
)
:
Promise
<
{
error
:
string
}
|
{
success
:
PrimaryKeyValue
}
>
;
tryUpdateQuery
(
row
:
GenObj
,
id
:
any
)
:
Promise
<
any
>
;
updateMatchingQuery
(
where
:
GenObj
,
updateVals
:
GenObj
,
repeatFields
:
any
[]
,
childRows
:
GenObj
,
)
:
Promise
<
|
any
[]
|
{
error
?:
undefined
;
inEditError
?:
undefined
;
rowError
:
any
}
|
{
error
?:
undefined
;
inEditError
:
any
;
rowError
?:
undefined
}
|
{
error
:
any
;
inEditError
?:
undefined
;
rowError
?:
undefined
}
,
>
;
}
routes
:
{
run_action
:
(
table_id
:
string
|
number
,
viewname
:
string
,
__namedParameters
:
GenObj
,
body
:
GenObj
,
__namedParameters
:
{
req
:
Req
;
res
:
Res
}
,
__namedParameters
:
GenObj
,
)
=>
Promise
<
any
>
;
update_matching_rows
:
(
table_id
:
string
|
number
,
viewname
:
string
,
__namedParameters
:
GenObj
,
body
:
GenObj
,
__namedParameters
:
{
redirect
?:
string
;
req
:
Req
;
res
:
Res
}
,
__namedParameters
:
GenObj
,
)
=>
Promise
<
void
>
;
}
run
:
(
table_id
:
string
|
number
,
viewname
:
string
,
cfg
:
GenObj
,
state
:
GenObj
,
param4
:
{
hiddenLoginDest
?:
any
;
isPreview
?:
boolean
;
req
:
Req
;
res
:
Res
}
,
param5
:
GenObj
,
)
=>
Promise
<
any
>
runMany
:
(
table_id
:
string
|
number
,
viewname
:
string
,
param2
:
GenObj
,
state
:
GenObj
,
extra
:
any
,
param5
:
GenObj
,
)
=>
Promise
<
any
[]
>
runPost
:
(
table_id
:
string
|
number
,
viewname
:
string
,
param2
:
GenObj
,
state
:
GenObj
,
body
:
GenObj
,
param5
:
{
redirect
?:
string
;
req
:
Req
;
res
:
Res
}
,
param6
:
GenObj
,
remote
?:
boolean
,
)
=>
Promise
<
void
>
virtual_triggers
:
(
table_id
:
string
|
number
,
viewname
:
string
,
param2
:
GenObj
,
)
=>
{
run
:
(
row
:
GenObj
,
__namedParameters
:
GenObj
)
=>
Promise
<
void
>
;
table_id
:
string
|
number
;
when_trigger
:
string
;
}
[]
getStringsForI18n
:
function
getStringsForI18n
(
param0
:
GenObj
)
:
string
[]
Parameters
param0
:
GenObj
Returns
string
[]
interpolate_title_string
:
function
interpolate_title_string
(
table_id
:
string
|
number
,
title
:
string
,
state
:
GenObj
,
)
:
Promise
<
string
>
Parameters
table_id
:
string
|
number
title
:
string
state
:
GenObj
Returns
Promise
<
string
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Documentation
Loading...