Mar 20, 2024 00:15 Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients SampleSupported Clients
NGClient
Methods Summary
Boolean
addFoundSetFilterParam(foundset, query, filterName)
Add a filter parameter that is permanent per user session to limit a specified foundset of records.
Object
copyObject(value)
Can be used to deep copy a custom value.
JSDataSet
getDataSetByQuery(query, max_returned_rows)
Performs a sql query with a query builder object.
Array
getDatasourcePKs(datasource)
This will generate a list of primary keys names for the given data source.
String
getMediaUrl(bytes)
This will generate a url from a byte array so that the client can get the bytes from that url.
QBSelect
getQuerySelect(dataSource)
Get select query for dataSource
JSFoundSet
getViewFoundSet(name, query)
Boolean
hideForm(formName)
Hide a form directly on the server for instance when a tab will change on the client, so it won't need to do a round trip
for hiding the form through the browser's component.
Methods Details
addFoundSetFilterParam(foundset, query, filterName)
Add a filter parameter that is permanent per user session to limit a specified foundset of records.
This is similar as calling foundset.js_addFoundSetFilterParam, but the main difference is that this
works also on related foundsets.
JSFoundSet
foundset
The foundset to add the filter param/query to
QBSelect
query
The query repesenting the filter
String
filterName
a name given to this foundset filter
copyObject(value)
Can be used to deep copy a custom value.
Object
value
the value to be copied
var eventSourceCopy = servoyApi.copyObject(eventSource);
getDataSetByQuery(query, max_returned_rows)
Performs a sql query with a query builder object.
Will throw an exception if anything did go wrong when executing the query.
Will use any data filter defined on table.
QBSelect
query
QBSelect query.
Number
max_returned_rows
The maximum number of rows returned by the query.
var dataset = servoyApi.getDataSetByQuery(qbselect, 10);
getDatasourcePKs(datasource)
This will generate a list of primary keys names for the given data source.
String
datasource
the data source
var pkNames = servoyApi.getDatasourcePKs(datasource);
getMediaUrl(bytes)
This will generate a url from a byte array so that the client can get the bytes from that url.
Array
bytes
The value where an url should be created for
var url = servoyApi.getMediaUrl(bytes);
getQuerySelect(dataSource)
Get select query for dataSource
String
dataSource
the dataSource
getViewFoundSet(name, query)
String
name
;
QBSelect
query
;
hideForm(formName)
Hide a form directly on the server for instance when a tab will change on the client, so it won't need to do a round trip
for hiding the form through the browser's component.
Object
formName
the form to hide
servoyApi.hideForm(formToHideName)