AlarmAttachmentType Property

This property contains the MIME-Type of the attachment.

Object Oriented Interface

public function getAlarmAttachmentType($alarmindex);
public function setAlarmAttachmentType($alarmindex, $value);

Procedural Interface

ipworks_caldav_get($res, 4 , $alarmindex);
ipworks_caldav_set($res, 4, $value , $alarmindex);

Default Value

''

Remarks

This property contains the MIME-Type of the attachment. If the AlarmAction is set to aAudio or aEmail the AlarmAttachment property may optionally contain a base-64 binary encoded attachment. The AlarmAttachmentType property is used to tell the CalDAV server what type of binary file it is receiving. This property is a standard MIME content type, in the format "type/sub-type". The most common audio types are shown in the table below:

AttachmentType File Extension Description
audio/basic au, snd basic audio, 8-bit u-law PCM.
audio/mid mid, rmi MIDI music data
audio/mpeg mp2, mp3 MPEG-1 Audio Layer II and III.
audio/x-aiff aiff, aif, aifcMacintosh audio format
audio/x-mp4a-latm m4a MPEG-4 Audio
audio/x-pn-realaudio ra, ram Realaudio
audio/x-wav wav Microsoft waveform audio
audio/x-ms-wma wma Windows Media Audio (Microsoft)

You may use standard MIME content-types for any other file type you wish to submit in the AlarmAttachment property. If AlarmAttachment is specified but AlarmAttachmentType is left blank, no format type will be submitted with the AlarmAttachment and the CalDAV server may (or may not) attempt to determine the data type itself.

The $alarmindex parameter specifies the index of the item in the array. The size of the array is controlled by the AlarmCount property.

This property is not available at design time.

Data Type

String

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2020 PHP Edition - Version 20.0 [Build 8307]