KEY_ATTRIBUTE
KEY_ATTRIBUTE
Horde_ActiveSync_Message_Appointment
$_device : \Horde_ActiveSync_Device
The device object
__construct(array $options = array()) : \Horde_ActiveSync_Message_Base
Const'r
array | $options | Configuration options for the message:
|
setSupported(array $fields)
Set the list of non-ghosted fields for this message.
array | $fields | The array of fields, keyed by the fully qualified property name i.e., POOMCONTACTS:Anniversary. To signify an empty SUPPORTED container $fields should contain a single element equal to Horde_ActiveSync::ALL_GHOSTED. |
isGhosted(string $property) : boolean
Override parent class' method. In EAS 16.0, top level appointment properties are ALWAYS ghosted if they are not explicitly sent.
A property is ghosted if it is NOT listed in the SUPPORTED list sent by the client AND is NOT present in the request data.
string | $property | The property to check |
decodeStream(\Horde_ActiveSync_Wbxml_Decoder $decoder)
Recursively decodes the WBXML from input stream. This means that if this message contains complex types (like Appointment.Recuurence for example) the sub-objects are auto-instantiated and decoded as well. Places the decoded objects in the local properties array.
\Horde_ActiveSync_Wbxml_Decoder | $decoder |
encodeStream(\Horde_ActiveSync_Wbxml_Encoder $encoder)
Encodes this object (and any sub-objects) as wbxml to the output stream.
Output is ordered according to $_mapping
\Horde_ActiveSync_Wbxml_Encoder | $encoder | The wbxml stream encoder |
getDTStamp() : \Horde_Date
Get the appointment's dtimestamp
The timestamp.
None found |
setDatetime(array $datetime = array())
Set the appointment time/duration.
array | $datetime | An array containing:
|
None found |
getDatetime() : array
Get the appointment's time data
An array containing:
None found |
setSubject(string $subject)
Set the appointment subject field.
string | $subject | A UTF-8 string |
None found |
None found |
setUid(string $uid)
Set the appointment uid. Note that this is the client's UID value, and not the value that the server normally uses for the UID. ActiveSync messages do not normally include any server uid value as part of the message directly. This causes issues with meeting requests since most clients will use the CLIENT_ENTRY_ID for this value, and will send the invitation email out using this value as the UID so we sort-of HAVE to use this value as the server's UID.
string | $uid | The server's uid for this appointment |
None found |
getUid() : string
Get the client's UID. See not above regarding server UIDs.
None found |
setServerUID(string $uid)
Because the client doesn't pass the server uid as part of the message, we need to add it manually so the backend can have access to it when changing this object.
string | $uid | The server UID |
None found |
None found |
setOrganizer(array $organizer)
Set the organizer name and/or email
array | $organizer |
None found |
getOrganizer() : array
Get the details for the appointment organizer
with 'name' and 'email' values
None found |
setLocation(string $location)
Set appointment location field.
string | $location |
None found |
None found |
setRecurrence(\Horde_Date_Recurrence $recurrence, integer $fdow = null)
Set recurrence information for this appointment
\Horde_Date_Recurrence | $recurrence | The recurrence data. |
integer | $fdow | The first day of the week. (A Horde_ActiveSync_Message_Recurrence:: constant). @since 2.4.0 |
None found |
getRecurrence() : \Horde_Date_Recurrence
Obtain a recurrence object. Note this returns a Horde_Date_Recurrence object, not Horde_ActiveSync_Message_Recurrence.
None found |
addException(\Horde_ActiveSync_Message_Exception $exception)
Add a recurrence exception
\Horde_ActiveSync_Message_Exception | $exception |
None found |
getExceptions() : array
Return the exceptions for this appointment.
An array of Horde_ActiveSync_Message_Exception objects
None found |
setSensitivity(integer $sensitivity)
Set the sensitivity level for this appointment.
Should be one of: normal, personal, private, confidential
integer | $sensitivity | The SENSITIVITY constant |
None found |
getSensitivity() : integer
Return the sensitivity setting for this appointment
The SENSITIVITY constant
None found |
setBusyStatus(integer $busy)
Sets the busy status for this appointment
integer | $busy | The BUSYSTATUS constant |
None found |
getBusyStatus() : integer
Return the busy status for this appointment.
The BUSYSTATUS constant
None found |
setResponseType(integer $response)
Set user response type. Should be one of: none, organizer, tentative, accepted, declined
integer | $response | The response type constant |
None found |
getResponseType() : integer
Get response type
The responsetype constant
None found |
setReminder(integer $minutes)
Set reminder for this appointment.
integer | $minutes | The number of minutes before appintment to trigger a reminder. |
None found |
getReminder() : integer|boolean
Get the reminder time.
Number of minutes before appointment for notifications or false if not set.
None found |
setMeetingStatus(integer $status)
Set the status for this appointment. Should be one of: none, meeting, received, canceled, canceledreceived.
integer | $status | A MEETING_* constant |
None found |
getMeetingStatus() : integer
Return the meeting status for this meeting.
A MEETING_* constant
None found |
addAttendee(array $attendee)
Add an attendee to this appointment
array | $attendee | 'name', 'email' for each attendee |
None found |
getAttendees() : array
Get a list of this event's attendees
An array of 'name' and 'email' hashes
None found |
setBody(string $body)
Set the appointment's body
string | $body | UTF-8 encoded string |
None found |
None found |
addCategory(string $category)
Add a category to the appointment
string | $category |
None found |
None found |
addAttachment(\Horde_ActiveSync_Message_AirSyncBaseAttachment $atc)
\Horde_ActiveSync_Message_AirSyncBaseAttachment | $atc |
None found |
None found |
_validateDecodedValues() : boolean
Give concrete classes the chance to enforce rules on property values.
True on success, otherwise false.
None found |
_preEncodeValidation() : boolean
Give concrete classes the chance to enforce rules before encoding messages to send to the client.
True if values were valid (or could be made valid). False if values are unable to be validated.
since | 2.31.0 |
---|
_checkEncoding(mixed $data, string $tag) : mixed
Checks if the data needs to be encoded like e.g., when outputing binary data in-line during ITEMOPERATIONS requests. Concrete classes should override this if needed.
mixed | $data | The data to check. A string or stream resource. |
string | $tag | The tag we are outputing. |
The encoded data. A string or stream resource with a filter attached.
None found |
_checkSendEmpty(string $tag) : boolean
Checks to see if we should send an empty value.
string | $tag | The tag name |
None found |
_getAttribute(string $name, \stting $default = null) : mixed
Helper method to allow default values for unset properties.
string | $name | The property name |
\stting | $default | The default value to return if $property is empty |
None found |
_formatDate(\Horde_Date $dt, integer $type) : string
Oh yeah. This is beautiful. Exchange outputs date fields differently in calendar items and emails. We could just always send one or the other, but unfortunately nokia's 'Mail for exchange' depends on this quirk.
So we have to send a different date type depending on where it's used. Used when encoding a date value to send to the client.
\Horde_Date | $dt | The Horde_Date object to format (should normally be in local tz). |
integer | $type | The type to format as: One of TYPE_DATE or TYPE_DATE_DASHES, TYPE_DATE_LOCAL |
The formatted date
None found |
_parseDate(string $ts) : \Horde_Date|boolean
Get a Horde_Date from a timestamp, ensuring it's in the correct format.
Used when decoding an incoming date value from the client.
string | $ts | The timestamp |
The Horde_Date or false if unable to decode.
None found |
_hex2bin(string $data) : string
Function which converts a hex entryid to a binary entryid.
string | $data | The hexadecimal string |
The binary data
None found |