Topics   All   MacOS (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server   Client   Old   Deprecated   Guides   Examples   Videos
New in version: 11.4   11.5   12.0   12.1   12.2   12.3   12.4   12.5   13.0   13.1    Statistic    FMM    Blog  

ProcessActivity.beginActivity

Begins an activity.

Component Version macOS Windows Linux Server iOS SDK
Process 5.2 ✅ Yes ✅ Yes ❌ No ✅ Yes, on macOS and Windows ✅ Yes
MBS( "ProcessActivity.beginActivity"; activity; Reason )   More

Parameters

Parameter Description Example
activity The activity as a number or a text. The plugin allows you to pass texts like IdleDisplaySleepDisabled, IdleSystemSleepDisabled, UserInitiated, UserInitiatedAllowingIdleSystemSleep, Background and LatencyCritical. Those texts can be combined. "IdleDisplaySleepDisabled"
Reason The reason text. "Doing backup"

Result

Returns reference number or error.

Description

Begins an activity.
Pass in an activity to this function, and a non-empty reason string. Indicate completion of the activity by calling the corresponding ProcessActivity.endActivity function with the result of this function. The reason string is used for debugging.
Requires macOS 10.9 and newer.
This function allows to deactivate App Nap for FileMaker. So when a script has to do some work, you can disable system/display sleep here which also disables app nap.

Added Windows support with version 13.0. Supported flags are IdleDisplaySleepDisabled, IdleSystemSleepDisabled, UserInitiated and UserInteractive.

Examples

Start an activity:

MBS( "ProcessActivity.beginActivity"; "IdleSystemSleepDisabled UserInitiated"; "Doing Backup in FileMaker" )

Avoid display sleep:

MBS( "ProcessActivity.beginActivity"; "IdleDisplaySleepDisabled UserInitiated"; "Showing animation" )

See also

Release notes

Example Databases

Blog Entries

This function does not need a paid license.

Created 2nd June 2015, last changed 17th December 2022


ProcessActivity.Reason - ProcessActivity.endActivity

💬 Ask a question or report a problem


Start Chat