Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

Calendar.Alarm.GetRelativeTrigger

Queries the relative trigger value.

Component Version macOS Windows Linux Server iOS SDK
Calendar 3.5 ✅ Yes ❌ No ❌ No ❌ No ❌ No
MBS( "Calendar.Alarm.GetRelativeTrigger"; alarmRef )   More

Parameters

Parameter Description Example
alarmRef The reference to the calendar alarm. $alarmRef

Result

Returns value or error.

Description

Queries the relative trigger value.
Value is in seconds relative to parent calendar item.

The time that an alarm goes off is referred to as the trigger. Alarms have either a relative trigger, which means the alarm fires a certain number of seconds before an alarm occurs, or an absolute trigger, which specifies the exact time the alarm will trigger off.

See also

Example Databases

This function checks for a license.

Created 18th August 2014, last changed 18th August 2014


Calendar.Alarm.GetRelatedTo - Calendar.Alarm.GetSound