| Property | Type | Description | |
|---|---|---|---|
| $_dayOfWeekMap | array | DOW mapping for DATE to MASK | |
| $_mapping | array | Property mapping. | |
| $_properties | array | Property values. |
| Method | Description | |
|---|---|---|
| __construct ( array $options = [] ) | Const'r | |
| addAttachment ( Horde_ActiveSync_Message_AirSyncBaseAttachment $atc ) | ||
| addAttendee ( array $attendee ) | Add an attendee to this appointment | |
| addCategory ( string $category ) | Add a category to the appointment | |
| addException ( Horde_ActiveSync_Message_Exception $exception ) | Add a recurrence exception | |
| getAttendees ( ) : array | Get a list of this event's attendees | |
| getBody ( ) : string | Get the appointment's body | |
| getBusyStatus ( ) : integer | Return the busy status for this appointment. | |
| getCategories ( ) : array | Return this appointments tags/categories. | |
| getClass ( ) : string | Return the collection class name the object is for. | |
| getDTStamp ( ) : Horde_Date | Get the appointment's dtimestamp | |
| getDatetime ( ) : array | Get the appointment's time data | |
| getExceptions ( ) : array | Return the exceptions for this appointment. | |
| getLocation ( ) : string | Get the location field | |
| getMeetingStatus ( ) : integer | Return the meeting status for this meeting. | |
| getOrganizer ( ) : array | Get the details for the appointment organizer | |
| getRecurrence ( ) : Horde_Date_Recurrence | Obtain a recurrence object. Note this returns a Horde_Date_Recurrence object, not Horde_ActiveSync_Message_Recurrence. | |
| getReminder ( ) : integer | boolean | Get the reminder time. | |
| getResponseType ( ) : integer | Get response type | |
| getSensitivity ( ) : integer | Return the sensitivity setting for this appointment | |
| getServerUID ( ) : string | Obtain the server UID. See note above. | |
| getSubject ( ) : string | Get the subject | |
| getTimezone ( ) : string | Get the event's timezone | |
| getUid ( ) : string | Get the client's UID. See not above regarding server UIDs. | |
| 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. | |
| setBody ( string $body ) | Set the appointment's body | |
| setBusyStatus ( integer $busy ) | Sets the busy status for this appointment | |
| setDTStamp ( $date ) | Set the appointment's modify timestamp | |
| setDatetime ( array $datetime = [] ) | Set the appointment time/duration. | |
| setLocation ( string $location ) | Set appointment location field. | |
| setMeetingStatus ( integer $status ) | Set the status for this appointment. Should be one of: none, meeting, received, canceled, canceledreceived. | |
| setOrganizer ( array $organizer ) | Set the organizer name and/or email | |
| setRecurrence ( Horde_Date_Recurrence $recurrence, integer $fdow = null ) | Set recurrence information for this appointment | |
| setReminder ( integer $minutes ) | Set reminder for this appointment. | |
| setResponseType ( integer $response ) | Set user response type. Should be one of: none, organizer, tentative, accepted, declined | |
| setSensitivity ( integer $sensitivity ) | Set the sensitivity level for this appointment. | |
| 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. | |
| setSubject ( string $subject ) | Set the appointment subject field. | |
| setTimezone ( mixed $date ) | Set the timezone | |
| 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. |
| Method | Description | |
|---|---|---|
| _preEncodeValidation ( ) : boolean | Give concrete classes the chance to enforce rules before encoding messages to send to the client. | |
| _validateDecodedValues ( ) : boolean | Give concrete classes the chance to enforce rules on property values. |
| protected _preEncodeValidation ( ) : boolean | ||
| return | boolean | True if values were valid (or could be made valid). False if values are unable to be validated. |
| protected _validateDecodedValues ( ) : boolean | ||
| return | boolean | True on success, otherwise false. |
| public addAttachment ( Horde_ActiveSync_Message_AirSyncBaseAttachment $atc ) | ||
| $atc | Horde_ActiveSync_Message_AirSyncBaseAttachment | |
| public addAttendee ( array $attendee ) | ||
| $attendee | array | 'name', 'email' for each attendee |
| public addCategory ( string $category ) | ||
| $category | string | |
| public addException ( Horde_ActiveSync_Message_Exception $exception ) | ||
| $exception | Horde_ActiveSync_Message_Exception | |
| public getAttendees ( ) : array | ||
| return | array | An array of 'name' and 'email' hashes |
| public getBusyStatus ( ) : integer | ||
| return | integer | The BUSYSTATUS constant |
| public getCategories ( ) : array | ||
| return | array | |
| public getDTStamp ( ) : Horde_Date | ||
| return | Horde_Date | The timestamp. |
| public getDatetime ( ) : array | ||
| return | array | An array containing: - start: (Horde_Date) The start time. - end: (Horde_Date) The end time. - allday: (boolean) If true, this is an allday event. @deprecated |
| public getExceptions ( ) : array | ||
| return | array | An array of Horde_ActiveSync_Message_Exception objects |
| public getMeetingStatus ( ) : integer | ||
| return | integer | A MEETING_* constant |
| public getOrganizer ( ) : array | ||
| return | array | with 'name' and 'email' values |
| public getRecurrence ( ) : Horde_Date_Recurrence | ||
| return | Horde_Date_Recurrence | |
| public getReminder ( ) : integer | boolean | ||
| return | integer | boolean | Number of minutes before appointment for notifications or false if not set. |
| public getResponseType ( ) : integer | ||
| return | integer | The responsetype constant |
| public getSensitivity ( ) : integer | ||
| return | integer | The SENSITIVITY constant |
| public getServerUID ( ) : string | ||
| return | string | |
| public getSubject ( ) : string | ||
| return | string | The UTF-8 subject string |
| public getTimezone ( ) : string | ||
| return | string | The timezone identifier |
| public setBusyStatus ( integer $busy ) | ||
| $busy | integer | The BUSYSTATUS constant |
| public setDatetime ( array $datetime = [] ) | ||
| $datetime | array | An array containing: - start: (Horde_Date) The start time. - end: (Horde_Date) The end time. If omitted, must include duration or allday. - duration: (integer) The event duration in seconds. - allday: (boolean) If true, this is an allday event. |
| public setLocation ( string $location ) | ||
| $location | string | |
| public setMeetingStatus ( integer $status ) | ||
| $status | integer | A MEETING_* constant |
| public setOrganizer ( array $organizer ) | ||
| $organizer | array | |
| public setRecurrence ( Horde_Date_Recurrence $recurrence, integer $fdow = null ) | ||
| $recurrence | Horde_Date_Recurrence | The recurrence data. |
| $fdow | integer | The first day of the week. (A Horde_ActiveSync_Message_Recurrence:: constant). @since 2.4.0 |
| public setReminder ( integer $minutes ) | ||
| $minutes | integer | The number of minutes before appintment to trigger a reminder. |
| public setResponseType ( integer $response ) | ||
| $response | integer | The response type constant |
| public setSensitivity ( integer $sensitivity ) | ||
| $sensitivity | integer | The SENSITIVITY constant |
| public setServerUID ( string $uid ) | ||
| $uid | string | The server UID |
| public setSubject ( string $subject ) | ||
| $subject | string | A UTF-8 string |
| public setTimezone ( mixed $date ) | ||
| $date | mixed | Either a Horde_Date or timezone descriptor such as America/New_York etc... |
| protected array $_dayOfWeekMap | ||
| return | array | |