| Components | All | New | MacOS | Windows | Linux | iOS | ||||
| Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old | |
Events.Alarm.SetSound
Sets the sound to play.
| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
| Events | 6.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | ✅ Yes |
MBS( "Events.Alarm.SetSound"; EKAlarm; Sound ) More
Parameters
| Parameter | Description | Example |
|---|---|---|
| EKAlarm | The reference to the alarm. | $Alarm |
| Sound | The name of the sound file. See /LIbrary/Sounds and /System/LIbrary/Sounds folders. |
"Submarine" |
Result
Returns OK or error.
Description
Sets the sound to play.The value of this property is the name of a system sound. When you set the soundName property, the action property is set to Audio, and the emailAddress and url properties are cleared.
Examples
Add alarm with sound 15 minutes before event:
Set Variable [$alarm2; Value:MBS( "Events.NewAlarmWithRelativeOffset"; -15*60 )]
Set Variable [$r; Value:MBS( "Events.Alarm.SetSound"; $alarm2; "Submarine" )]
Set Variable [$r; Value:MBS("Events.Item.AddAlarm"; $c; $alarm2)]
See also
- Calendar.Alarm.SetSound
- Events.Alarm.GetSound
- Events.Alarm.SetRelativeOffset
- Events.Alarm.SetURL
- Events.Item.AddAlarm
- Events.NewAlarm
- Events.NewAlarmWithRelativeOffset
- Events.NewReminder
- Events.SaveReminder
Example Databases
This function checks for a license.
Created 10th March 2016, last changed 13th August 2016
Events.Alarm.SetRelativeOffset - Events.Alarm.SetStructuredLocation
