Topics   All   Mac OS X (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server (Not)   Client   Old   Guides   Examples
New in version: 6.2   6.3   6.4   6.5   7.0   7.1   7.2   7.3   7.4   7.5    Statistic  

FM.RunScriptIdle

Runs a script after idle period.

Component Version macOS Windows Server FileMaker Cloud FileMaker iOS SDK
FM 3.3 Yes Yes No No Yes

MBS( "FM.RunScriptIdle"; DelaySeconds; FileName; ScriptName { ; ScriptParameter } )

Parameters

Parameter Description Example value
DelaySeconds The Number of Seconds to wait before running the script. Moving the mouse or using keyboard will reset the counter. 10
FileName The name of the file that contains the script to be run Get(Filename)
ScriptName The exact name of the script to run "TestScript"
ScriptParameter Optional
The Script Parameter to pass to the script

Result

Returns OK on success or error message on failure.

Description

Runs a script after idle period.
This script is called in FileMaker whenever no user activity has been for the given amount of time.
You can also pass a text string to the Script as a Parameter. The parameter can be retrieved by using Get(ScriptParameter) in the script that plug-in is calling.
see also Schedule.StartScriptOnIdle, FM.StopScriptIdle, FM.RunScript and FM.RunScriptLater.

With plugin version 6.0 or newer the script name can be a script ID number. In that case the plugin queries the script name for the given script ID. This allows to call scripts by ID and avoid problems if scripts are later renamed.

Examples

Start idle script:

Set Variable [$r; Value:MBS( "FM.RunScriptIdle"; 10; Get(FileName); "Trigger")]

See also

Example Databases


FM.RunScript   -   FM.RunScriptLater

Feedback: Report problem or ask question.




Links
MBS Xojo PDF Plugins