Documentation
Preparing search index...
@saltcorn/data
base-plugin/viewtemplates/room
room
Variable room
room
:
{
authorize_join
:
(
opts
:
GenObj
,
room_id
:
string
,
user
:
GenObj
,
)
=>
Promise
<
boolean
>
;
configuration_workflow
:
(
req
:
Req
)
=>
Workflow
;
connectedObjects
:
(
configuration
:
GenObj
)
=>
Promise
<
any
>
;
description
:
string
;
get_state_fields
:
()
=>
{
name
:
string
;
primary_key
:
boolean
;
required
:
boolean
;
type
:
string
;
}
[]
;
name
:
string
;
noAutoTest
:
boolean
;
queries
:
(
__namedParameters
:
GenObj
,
)
=>
{
ackReadQuery
(
participant_field
:
string
,
participant_maxread_field
:
string
,
body
:
GenObj
,
)
:
Promise
<
|
{
json
:
{
error
:
string
;
success
?:
undefined
}
}
|
{
json
:
{
error
?:
undefined
;
success
:
string
}
}
,
>
;
fetchOlderMsgQuery
(
participant_field
:
string
,
body
:
GenObj
,
)
:
Promise
<
Row
|
null
>
;
getRowQuery
(
state_id
:
string
,
part_table_name
:
string
,
part_user_field
:
string
,
part_key_to_room
:
string
,
)
:
Promise
<
Row
|
null
>
;
optionsQuery
(
reftable_name
:
string
,
type
:
string
,
attributes
:
GenObj
,
where
:
GenObj
,
)
:
Promise
<
any
>
;
submitAjaxQuery
(
msg_relation
:
string
,
participant_field
:
string
,
body
:
GenObj
,
msgform
:
string
,
msgsender_field
:
string
,
participant_maxread_field
:
string
,
)
:
Promise
<
|
{
json
:
{
error
?:
undefined
;
msgid
:
{
error
:
string
}
|
{
success
:
PrimaryKeyValue
}
;
}
;
}
|
{
json
:
{
error
:
any
;
msgid
?:
undefined
}
}
,
>
;
updateQuery
(
partRow
:
GenObj
,
part_table_name
:
string
,
max_read_id
:
number
,
part_maxread_field
:
string
,
)
:
Promise
<
void
>
;
}
;
routes
:
{
ack_read
:
(
table_id
:
number
,
viewname
:
string
,
optsOne
:
GenObj
,
body
:
GenObj
,
optsTwo
:
{
req
:
Req
;
res
:
Res
}
,
__namedParameters
:
GenObj
,
)
=>
Promise
<
any
>
;
fetch_older_msg
:
(
table_id
:
number
,
viewname
:
string
,
optsTwo
:
GenObj
,
body
:
GenObj
,
__namedParameters
:
{
req
:
Req
;
res
:
Res
}
,
__namedParameters
:
GenObj
,
)
=>
Promise
<
|
{
json
:
{
error
:
string
;
new_fetch_older_lt
?:
undefined
;
prepend
?:
undefined
;
remove_fetch_older
?:
undefined
;
success
?:
undefined
;
}
;
}
|
{
json
:
{
error
?:
undefined
;
new_fetch_older_lt
:
number
;
prepend
:
string
;
remove_fetch_older
:
boolean
;
success
:
string
;
}
;
}
,
>
;
run_action
:
(
table_id
:
number
,
viewname
:
string
,
__namedParameters
:
GenObj
,
body
:
GenObj
,
__namedParameters
:
{
req
:
Req
;
res
:
Res
}
,
)
=>
Promise
<
any
>
;
submit_msg_ajax
:
(
table_id
:
number
,
viewname
:
string
,
optsOne
:
GenObj
,
body
:
GenObj
,
optsTwo
:
{
req
:
Req
;
res
:
Res
}
,
__namedParameters
:
GenObj
,
)
=>
Promise
<
any
>
;
}
;
run
:
(
table_id
:
number
,
viewname
:
string
,
optsOne
:
GenObj
,
state
:
GenObj
,
optsTwo
:
{
req
:
Req
;
res
:
Res
}
,
__namedParameters
:
GenObj
,
)
=>
Promise
<
any
>
;
virtual_triggers
:
(
table_id
:
number
,
viewname
:
string
,
opts
:
GenObj
,
)
=>
{
run
:
(
row
:
GenObj
)
=>
Promise
<
void
>
;
table_id
:
number
|
undefined
;
when_trigger
:
string
;
}
[]
;
getStringsForI18n
()
:
never
[]
;
}
Type Declaration
authorize_join
:
(
opts
:
GenObj
,
room_id
:
string
,
user
:
GenObj
)
=>
Promise
<
boolean
>
configuration_workflow
:
(
req
:
Req
)
=>
Workflow
connectedObjects
:
(
configuration
:
GenObj
)
=>
Promise
<
any
>
description
:
string
get_state_fields
:
()
=>
{
name
:
string
;
primary_key
:
boolean
;
required
:
boolean
;
type
:
string
}
[]
name
:
string
noAutoTest
:
boolean
queries
:
(
__namedParameters
:
GenObj
,
)
=>
{
ackReadQuery
(
participant_field
:
string
,
participant_maxread_field
:
string
,
body
:
GenObj
,
)
:
Promise
<
|
{
json
:
{
error
:
string
;
success
?:
undefined
}
}
|
{
json
:
{
error
?:
undefined
;
success
:
string
}
}
,
>
;
fetchOlderMsgQuery
(
participant_field
:
string
,
body
:
GenObj
,
)
:
Promise
<
Row
|
null
>
;
getRowQuery
(
state_id
:
string
,
part_table_name
:
string
,
part_user_field
:
string
,
part_key_to_room
:
string
,
)
:
Promise
<
Row
|
null
>
;
optionsQuery
(
reftable_name
:
string
,
type
:
string
,
attributes
:
GenObj
,
where
:
GenObj
,
)
:
Promise
<
any
>
;
submitAjaxQuery
(
msg_relation
:
string
,
participant_field
:
string
,
body
:
GenObj
,
msgform
:
string
,
msgsender_field
:
string
,
participant_maxread_field
:
string
,
)
:
Promise
<
|
{
json
:
{
error
?:
undefined
;
msgid
:
{
error
:
string
}
|
{
success
:
PrimaryKeyValue
}
;
}
;
}
|
{
json
:
{
error
:
any
;
msgid
?:
undefined
}
}
,
>
;
updateQuery
(
partRow
:
GenObj
,
part_table_name
:
string
,
max_read_id
:
number
,
part_maxread_field
:
string
,
)
:
Promise
<
void
>
;
}
routes
:
{
ack_read
:
(
table_id
:
number
,
viewname
:
string
,
optsOne
:
GenObj
,
body
:
GenObj
,
optsTwo
:
{
req
:
Req
;
res
:
Res
}
,
__namedParameters
:
GenObj
,
)
=>
Promise
<
any
>
;
fetch_older_msg
:
(
table_id
:
number
,
viewname
:
string
,
optsTwo
:
GenObj
,
body
:
GenObj
,
__namedParameters
:
{
req
:
Req
;
res
:
Res
}
,
__namedParameters
:
GenObj
,
)
=>
Promise
<
|
{
json
:
{
error
:
string
;
new_fetch_older_lt
?:
undefined
;
prepend
?:
undefined
;
remove_fetch_older
?:
undefined
;
success
?:
undefined
;
}
;
}
|
{
json
:
{
error
?:
undefined
;
new_fetch_older_lt
:
number
;
prepend
:
string
;
remove_fetch_older
:
boolean
;
success
:
string
;
}
;
}
,
>
;
run_action
:
(
table_id
:
number
,
viewname
:
string
,
__namedParameters
:
GenObj
,
body
:
GenObj
,
__namedParameters
:
{
req
:
Req
;
res
:
Res
}
,
)
=>
Promise
<
any
>
;
submit_msg_ajax
:
(
table_id
:
number
,
viewname
:
string
,
optsOne
:
GenObj
,
body
:
GenObj
,
optsTwo
:
{
req
:
Req
;
res
:
Res
}
,
__namedParameters
:
GenObj
,
)
=>
Promise
<
any
>
;
}
ack_read
:
(
table_id
:
number
,
viewname
:
string
,
optsOne
:
GenObj
,
body
:
GenObj
,
optsTwo
:
{
req
:
Req
;
res
:
Res
}
,
__namedParameters
:
GenObj
,
)
=>
Promise
<
any
>
fetch_older_msg
:
(
table_id
:
number
,
viewname
:
string
,
optsTwo
:
GenObj
,
body
:
GenObj
,
__namedParameters
:
{
req
:
Req
;
res
:
Res
}
,
__namedParameters
:
GenObj
,
)
=>
Promise
<
|
{
json
:
{
error
:
string
;
new_fetch_older_lt
?:
undefined
;
prepend
?:
undefined
;
remove_fetch_older
?:
undefined
;
success
?:
undefined
;
}
;
}
|
{
json
:
{
error
?:
undefined
;
new_fetch_older_lt
:
number
;
prepend
:
string
;
remove_fetch_older
:
boolean
;
success
:
string
;
}
;
}
,
>
run_action
:
(
table_id
:
number
,
viewname
:
string
,
__namedParameters
:
GenObj
,
body
:
GenObj
,
__namedParameters
:
{
req
:
Req
;
res
:
Res
}
,
)
=>
Promise
<
any
>
submit_msg_ajax
:
(
table_id
:
number
,
viewname
:
string
,
optsOne
:
GenObj
,
body
:
GenObj
,
optsTwo
:
{
req
:
Req
;
res
:
Res
}
,
__namedParameters
:
GenObj
,
)
=>
Promise
<
any
>
run
:
(
table_id
:
number
,
viewname
:
string
,
optsOne
:
GenObj
,
state
:
GenObj
,
optsTwo
:
{
req
:
Req
;
res
:
Res
}
,
__namedParameters
:
GenObj
,
)
=>
Promise
<
any
>
Throws
virtual_triggers
:
(
table_id
:
number
,
viewname
:
string
,
opts
:
GenObj
,
)
=>
{
run
:
(
row
:
GenObj
)
=>
Promise
<
void
>
;
table_id
:
number
|
undefined
;
when_trigger
:
string
;
}
[]
getStringsForI18n
:
function
getStringsForI18n
()
:
never
[]
Returns
never
[]
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Documentation
Loading...
Throws