MMScript

Trigger and schedule scripts

<- Back to MMScript function list

MMScript_CreateIdleScriptEvent

Description

Use this function to create a Script Event that occurs after the user has been idle for a specific amount of time. A Repeating Idle Script Event will only occur once per idle state. In other words, say you have a Script Event set to occur when the user is idle for 30 seconds, and a user went idle at 10:01:00. Your Idle Script would be called at 10:01:30 but would not be called at 10:02:00 or 10:02:30, etc. Only after the user became active again and then idle again for 30 seconds would your Idle Script be called again.

Return Type
Text
Format
MMScript_CreateIdleScriptEvent ( EventName ; Script ; IdleTime ; DB ; EventValue ; Repeat ; Persistent )
Required Parameters
  • EventName

    The Name of the Event you are Creating.

  • Script

    The Script to call.

  • IdleTime

    The amount of time the user must be idle before this Event occurs (Format: "1h 2d 3m 45s").

Optional Parameters
  • DB

    The Database that contains the Script.

  • EventValue

    Any user defined Value you can retrieve when the Event occurs.

  • Repeat

    True or False if you want the Event to Repeat until you cancel it.

  • Persistent

    True or False if you want this Event to be saved between FileMaker sessions.

Related Items
MMScript_CancelScriptEvent, MMScript_CreateDateTimeScriptEvent, MMScript_CreateImmediateScriptEvent, MMScript_CreateIntervalScriptEvent, MMScript_CreateXMLScriptEvent, MMScript_IsUserIdle, MMScript_ListScriptEvents