Mendix Client 4 API Documentation


mendix.sys.Remote

The mendix.sys.Remote subsystem provides an API to handle validations and instructions.

Methods

execute(instructions, caller)

This method is called to execute Runtime instructions.

Parameters

Name Type Description
instructions Object The instructions to execute.
caller Object The caller on which instructions like ‘open form’ and ‘close form’ are invoked.

hasValidations(response)

This method is called to check whether a Runtime response contains validation feedback.

Parameters

Name Type Description
response Object The Runtime response to check for validations.

Returns

Type Description
Boolean true if the response contains validation feedback.

getValidations(response)

This method is called to get the validation feedback from a Runtime response.

Parameters

Name Type Description
response Object The Runtime response to get validations from.

Returns

Type Description
ObjectValidation The validation feedback the response contains.

hasInstructions(response)

This method is called to check whether the Runtime response contains instructions.

Parameters

Name Type Description
response Object The Runtime response to check for instructions.

Returns

Type Description
Boolean true if the response contains instructions.

startup(callback)

This method is called to startup the subsystem.

Parameters

Name Type Description
callback Function The function to be called when startup is finished.

shutdown()

This method is called to shutdown the subsystem.

isLoaded()

This method is called to check whether the subsystem has been started.

Returns

Type Description
Boolean true if the subsystem has been started.