Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Cache
indextrue
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClientsWordListMobileClient

servoy sSummary12%30%58%height: 30px;3Property SummaryThe first form that loads when a solution is deployed.The i18n database server connection and database table that stores the i18n keys for a solution.The name of the login form that loads when a solution is deployed.Get the first module that is also a login solution.The list of modules that have been added to a solution.Flag that tells if authentication is needed in order to access the solution.The type of a solution; can be "Normal" (non-module), "Module", "Web client only", "Smart client only", "Login", "Authenticator", "Pre-import hook module", "Post-import hook module", "Mobile".The custom CSS used by the solution (a MEDIA lib entry).The direction that text is displayed.The menu bar title of a solution.

servoy sSummary12%30%58%height: 30px;3Event SummaryThe method that is executed when a solution closes.voidMethod that is executed when data broadcast occurs.The method that is executed when a solution opens and an error occurs.voidThe method that is executed when a solution opens.

propertyservoy sDetail2100%height:30px2Property DetailsfirstFormname

firstForm

dessIndentThe first form that loads when a solution is deployed. NOTE: If the Login form is specified, then the firstForm is the first form that will load next after the loginForm.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow i18nDataSourcename

i18nDataSource

dessIndentThe i18n database server connection and database table that stores the i18n keys for a solution.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
loginFormname

loginForm

dessIndentThe name of the login form that loads when a solution is deployed.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow 
loginSolutionNamename

loginSolutionName

dessIndentGet the first module that is also a login solution.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
modulesNamesname

modulesNames

dessIndentThe list of modules that have been added to a solution.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow 
mustAuthenticatename

mustAuthenticate

dessIndentFlag that tells if authentication is needed in order to access the solution. If unchecked, the Smart Client will always require authentication, regardless of this setting. If checked, authentication is required, and either a provided loginSolution or otherwise the default Servoy login mechanism will be used. If default Servoy login mechanism is used, the "servoy.webclient.basic.authentication" setting on the Admin Page can be used to enable the use of the standard browser basic authentication.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow 
solutionTypename

solutionType

dessIndentThe type of a solution; can be "Normal" (non-module), "Module", "Web client only", "Smart client only", "Login", "Authenticator", "Pre-import hook module", "Post-import hook module", "Mobile". These constants are defined in SolutionMetaData class.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow 
styleSheetname

styleSheet

dessIndentThe custom CSS used by the solution (a MEDIA lib entry). It can reference other media resources (even additional .css through relative '@import' statements). For NGClient - this CSS will be available directly in the browser.ret

Returns

sIndent
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow 
textOrientationname

textOrientation

dessIndentThe direction that text is displayed. Options include: DEFAULT left to right right to left locale specificret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
titleTextname

titleText

dessIndentThe menu bar title of a solution.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 

eventservoy sDetail2100%height:30px2Event DetailsonClosename

onClose(force)

dessIndentThe method that is executed when a solution closes. The default is -none-.prs

Parameters

sIndentforceif false then solution close can be stopped by returning false
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow onDataBroadcastname

onDataBroadcast(dataSource, action, pks, cached)

dessIndentMethod that is executed when data broadcast occurs. The default is -none-.prs

Parameters

sIndentdataSourcetable data sourceactionsee SQL_ACTION_TYPES constantspksaffected primary keyscacheddata was cached
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
onErrorname

onError(ex)

dessIndentThe method that is executed when a solution opens and an error occurs. The default is -none.prs

Parameters

sIndentexexception to handle
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
onOpenname

onOpen(arg, queryParams)

dessIndentThe method that is executed when a solution opens. The default is -none-.prs

Parameters

sIndentargstartup argument part of the deeplink url with which the Client was startedqueryParamsall query parameters of the deeplink url with which the Client was started
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow