Page History

Cache

index	true
refresh	100d
showRefresh	true
id	doc

...


title	Refresh page
showDate	true
retry	Enable

...

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordList

...

SmartClient

sWordList

...

WebClient

sWordList

...

NGClient

...

servoy sSummary

12%

30%

58%

height: 30px;

3

Constants Summary

Constant that is returned as a JSEvent type when in the callback method when it executed normally.

Constant that is returned as a JSEvent type when in the callback method when an exception occurred.

...

servoy sSummary12%30%58%height: 30px;3Methods SummaryGets the id of the client.Get a data-provider value.Get a data-provider value.returns true if this client is still valid/usable.voidQueues a method call on the remote server, without a callback method.voidQueues a method call on the remote server.Set a data-provider value.Set a data-provider value.voidcloses the client.voidcloses the client.

...

constantservoy sDetail2100%height:30px2Constants DetailsCALLBACK_EVENTname

CALLBACK_EVENT

des

sIndent

Constant that is returned as a JSEvent type when in the callback method when it executed normally.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

...

CALLBACK_EXCEPTION_EVENT

name

CALLBACK_EXCEPTION_EVENT

des

sIndent

Constant that is returned as a JSEvent type when in the callback method when an exception occurred.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

...

functionservoy sDetail2100%height:30px2Methods DetailsgetClientIDname

getClientID()

des

sIndent

Gets the id of the client.

This client id can be used to find the client from the headless client plugin.
Note that this client id is not the same id as the id displayed on the Aplicationb Server admin page.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

...

getDataProviderValue

name

getDataProviderValue(contextName, dataprovider)

des

sIndent

Get a data-provider value.

prs

Parameters

sIndent

contextName

The context of the given method, null if it is global method or a form name for a form method

dataprovider

the data-provider name as seen in Servoy

ret

Returns

sIndent

the value for the data-provider.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

...

getDataProviderValue

name

getDataProviderValue(contextName, dataprovider, methodName)

des

sIndent

Get a data-provider value.

prs

Parameters

sIndent

contextName

The context of the given method; null if it is global method or a form name for a form method.

dataprovider

the data-provider name as seen in Servoy.

methodName

if this is specified, the data-provider's value will only be returned if the specified method is running in this headless client because the currently running client requested it to. Otherwise undefined is returned.

ret

Returns

sIndent

the value of the data-provider.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

...

isValid

name

isValid()

des

sIndent

returns true if this client is still valid/usable.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

queueMethod

name

queueMethod(contextName, methodName, args)

des

sIndent

Queues a method call on the remote server, without a callback method.
Please note that calling queueMethod without a callback does not return anything: no result of the remote method or no exception if something went wrong.

prs

Parameters

sIndent

contextName

The context of the given method, null if it is global method or a form name for a form method.

methodName

The method name.

args

The arguments that should be passed to the method.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

...

queueMethod

name

queueMethod(contextName, methodName, args, notifyCallBackMethod)

des

sIndent

Queues a method call on the remote server. The callback method will be called when the method is executed on the server
and the return value is given as the JSEvent.data object with the JSEvent.getType() value of JSClient.CALLBACK_EVENT.

...

If an exception is thrown somewhere then the callback method will be called with
the exception as the JSEvent data object with the JSEvent.getType() value of JSClient.CALLBACK_EXCEPTION_EVENT
The second argument that is give back is the JSClient instance that did the call.

prs

Parameters

sIndent

contextName

The context of the given method, null if it is global method or a form name for a form method.

methodName

The method name.

args

The arguments that should be passed to the method.

notifyCallBackMethod

The callback method that is called when the execution is finished.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

...

setDataProviderValue

name

setDataProviderValue(contextName, dataprovider, value)

des

sIndent

Set a data-provider value.

prs

Parameters

sIndent

contextName

The context of the given method, null if it is global method or a form name for a form method.

dataprovider

the data-provider name as seen in Servoy.

value

the value to set.

ret

Returns

sIndent

the old value or null if no change.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

...

setDataProviderValue

name

setDataProviderValue(contextName, dataprovider, value, methodName)

des

sIndent

Set a data-provider value.

prs

Parameters

sIndent

contextName

The context of the given method, null if it is global method or a form name for a form method

dataprovider

the data-provider name as seen in Servoy

value

the value to set

methodName

if this is specified, the data-provider's value will only be set if the specified method is running in this headless client because the currently running client requested it to. Otherwise the value is not set into the data-provider and undefined is returned.

ret

Returns

sIndent

the old value or null if no change

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

...

shutdown

name

shutdown()

des

sIndent

closes the client.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

...

shutdown

name

shutdown(force)

des

sIndent

closes the client.

prs

Parameters

sIndent

force

;

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

...

Child pages

Versions Compared

Old Version 22

New Version Current

Key

CALLBACK_EVENT

CALLBACK_EXCEPTION_EVENT

getClientID()

getDataProviderValue(contextName, dataprovider)

getDataProviderValue(contextName, dataprovider, methodName)

isValid()

queueMethod(contextName, methodName, args)

queueMethod(contextName, methodName, args, notifyCallBackMethod)

setDataProviderValue(contextName, dataprovider, value)

setDataProviderValue(contextName, dataprovider, value, methodName)

shutdown()

shutdown(force)