Documentation

Horde_ActiveSync_Message_Appointment extends Horde_ActiveSync_Message_Base

in package

• ActiveSync

Horde_ActiveSync_Message_Appointment

Tags

license

http://www.horde.org/licenses/gpl GPLv2

copyright

2009-2020 Horde LLC (http://www.horde.org)

author

Michael J Rubinsky mrubinsk@horde.org

Table of Contents

BUSYSTATUS_BUSY  = 2

BUSYSTATUS_ELSEWHERE  = 4

BUSYSTATUS_FREE  = 0

BUSYSTATUS_OUT  = 3

BUSYSTATUS_TENTATIVE  = 1

IS_ALL_DAY  = 1

KEY_ATTRIBUTE  = 1

KEY_PROPERTY  = 4

KEY_TYPE  = 3

KEY_VALUES  = 2

MEETING_CANCELLED  = 5

MEETING_CANCELLED_RECEIVED  = 7

MEETING_IS_MEETING  = 1

MEETING_NOT_MEETING  = 0

MEETING_RECEIVED  = 3

POOMCAL_ALLDAYEVENT  = 'POOMCAL:AllDayEvent'

POOMCAL_APPOINTMENTREPLYTIME  = 'POOMCAL:AppointmentReplyTime'

POOMCAL_ATTENDEE  = 'POOMCAL:Attendee'

POOMCAL_ATTENDEES  = 'POOMCAL:Attendees'

POOMCAL_ATTENDEESTATUS  = 'POOMCAL:AttendeeStatus'

POOMCAL_ATTENDEETYPE  = 'POOMCAL:AttendeeType'

POOMCAL_BODY  = 'POOMCAL:Body'

POOMCAL_BODYTRUNCATED  = 'POOMCAL:BodyTruncated'

POOMCAL_BUSYSTATUS  = 'POOMCAL:BusyStatus'

POOMCAL_CALENDARTYPE  = 'POOMCAL:CalendarType'

POOMCAL_CATEGORIES  = 'POOMCAL:Categories'

POOMCAL_CATEGORY  = 'POOMCAL:Category'

POOMCAL_CLIENTUID  = 'POOMCAL:ClientUid'

POOMCAL_DAYOFMONTH  = 'POOMCAL:DayOfMonth'

POOMCAL_DAYOFWEEK  = 'POOMCAL:DayOfWeek'

POOMCAL_DELETED  = 'POOMCAL:Deleted'

POOMCAL_DISALLOWNEWTIMEPROPOSAL  = 'POOMCAL:DisallowNewTimeProposal'

POOMCAL_DTSTAMP  = 'POOMCAL:DtStamp'

POOMCAL_EMAIL  = 'POOMCAL:Email'

POOMCAL_ENDTIME  = 'POOMCAL:EndTime'

POOMCAL_EXCEPTION  = 'POOMCAL:Exception'

POOMCAL_EXCEPTIONS  = 'POOMCAL:Exceptions'

POOMCAL_EXCEPTIONSTARTTIME  = 'POOMCAL:ExceptionStartTime'

POOMCAL_FIRSTDAYOFWEEK  = 'POOMCAL:FirstDayOfWeek'

POOMCAL_INTERVAL  = 'POOMCAL:Interval'

POOMCAL_ISLEAPMONTH  = 'POOMCAL:IsLeapMonth'

POOMCAL_LOCATION  = 'POOMCAL:Location'

POOMCAL_MEETINGSTATUS  = 'POOMCAL:MeetingStatus'

POOMCAL_MONTHOFYEAR  = 'POOMCAL:MonthOfYear'

POOMCAL_NAME  = 'POOMCAL:Name'

POOMCAL_OCCURRENCES  = 'POOMCAL:Occurrences'

POOMCAL_ONLINECONFLINK  = 'POOMCAL:OnlineMeetingConfLink'

POOMCAL_ONLINEEXTLINK  = 'POOMCAL:OnlineMeetingExternalLink'

POOMCAL_ORGANIZEREMAIL  = 'POOMCAL:OrganizerEmail'

POOMCAL_ORGANIZERNAME  = 'POOMCAL:OrganizerName'

POOMCAL_RECURRENCE  = 'POOMCAL:Recurrence'

POOMCAL_REMINDER  = 'POOMCAL:Reminder'

POOMCAL_RESPONSEREQUESTED  = 'POOMCAL:ResponseRequested'

POOMCAL_RESPONSETYPE  = 'POOMCAL:ResponseType'

POOMCAL_RTF  = 'POOMCAL:Rtf'

POOMCAL_SENSITIVITY  = 'POOMCAL:Sensitivity'

POOMCAL_STARTTIME  = 'POOMCAL:StartTime'

POOMCAL_SUBJECT  = 'POOMCAL:Subject'

POOMCAL_TIMEZONE  = 'POOMCAL:Timezone'

POOMCAL_TYPE  = 'POOMCAL:Type'

POOMCAL_UID  = 'POOMCAL:UID'

POOMCAL_UNTIL  = 'POOMCAL:Until'

POOMCAL_WEEKOFMONTH  = 'POOMCAL:WeekOfMonth'

PROPERTY_NO_CONTAINER  = 7

RESPONSE_ACCEPTED  = 3

RESPONSE_DECLINED  = 4

RESPONSE_NONE  = 0

RESPONSE_NORESPONSE  = 5

RESPONSE_ORGANIZER  = 1

RESPONSE_TENTATIVE  = 2

SENSITIVITY_CONFIDENTIAL  = 3

SENSITIVITY_NORMAL  = 0

SENSITIVITY_PERSONAL  = 1

SENSITIVITY_PRIVATE  = 2

TYPE_DATE  = 1

TYPE_DATE_DASHES  = 3

TYPE_DATE_LOCAL  = 6

TYPE_HEX  = 2

TYPE_MAPI_GOID  = 5

TYPE_MAPI_STREAM  = 4

$commandType  : string

Request type. One of: Horde_ActiveSync::SYNC_ADD, SYNC_MODIFY, SYNC_REMOVE, or SYNC_FETCH. Used internally for enforcing various protocol rules depending on request.

$flags  : mixed

Message flags

$_dayOfWeekMap  : array<string|int, mixed>

DOW mapping for DATE to MASK

$_device  : Horde_ActiveSync_Device

The device object

$_exists  : array<string|int, mixed>

Existence cache, used for working with ghosted properties.

$_logger  : Horde_Log_Logger

Logger

$_mapping  : array<string|int, mixed>

Property mapping.

$_properties  : array<string|int, mixed>

Property values.

$_streamFilters  : array<string|int, mixed>

Cache of current stream filters.

$_supported  : array<string|int, mixed>

An array describing the non-ghosted elements this message supports.

$_version  : float

The version of EAS we are to support.

__call()  : mixed

Magic caller method.

__construct()  : Horde_ActiveSync_Message_Base

Const'r

__destruct()  : mixed

__get()  : mixed

Accessor

__isset()  : mixed

Magic method.

__set()  : mixed

Setter

addAttachment()  : mixed

addAttendee()  : mixed

Add an attendee to this appointment

addCategory()  : mixed

Add a category to the appointment

addException()  : mixed

Add a recurrence exception

decodeStream()  : mixed

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.

encodeStream()  : mixed

Encodes this object (and any sub-objects) as wbxml to the output stream.

getAttendees()  : array<string|int, mixed>

Get a list of this event's attendees

getBody()  : string

Get the appointment's body

getBusyStatus()  : int

Return the busy status for this appointment.

getCategories()  : array<string|int, mixed>

Return this appointments tags/categories.

getClass()  : string

Return the collection class name the object is for.

getDatetime()  : array<string|int, mixed>

Get the appointment's time data

getDTStamp()  : Horde_Date

Get the appointment's dtimestamp

getEndtime()  : mixed

getExceptions()  : array<string|int, mixed>

Return the exceptions for this appointment.

getLocation()  : string

Get the location field

getMeetingStatus()  : int

Return the meeting status for this meeting.

getOrganizer()  : array<string|int, mixed>

Get the details for the appointment organizer

getProtocolVersion()  : float

Return the EAS version this object supports.

getRecurrence()  : Horde_Date_Recurrence

Obtain a recurrence object. Note this returns a Horde_Date_Recurrence object, not Horde_ActiveSync_Message_Recurrence.

getReminder()  : int|bool

Get the reminder time.

getResponseType()  : int

Get response type

getSensitivity()  : int

Return the sensitivity setting for this appointment

getServerUID()  : string

Obtain the server UID. See note above.

getStarttime()  : mixed

getSubject()  : string

Get the subject

getSupported()  : array<string|int, mixed>

Get the list of non-ghosted properties for this message.

getTimezone()  : string

Get the event's timezone

getUid()  : string

Get the client's UID. See not above regarding server UIDs.

isEmpty()  : bool

Returns whether or not this message actually contains any data to send.

isGhosted()  : bool

Override parent class' method. In EAS 16.0, top level appointment properties are ALWAYS ghosted if they are not explicitly sent.

propertyExists()  : bool

Check the existence of a property in this message.

setBody()  : mixed

Set the appointment's body

setBusyStatus()  : mixed

Sets the busy status for this appointment

setDatetime()  : mixed

Set the appointment time/duration.

setDTStamp()  : mixed

Set the appointment's modify timestamp

setLocation()  : mixed

Set appointment location field.

setMeetingStatus()  : mixed

Set the status for this appointment. Should be one of: none, meeting, received, canceled, canceledreceived.

setOrganizer()  : mixed

Set the organizer name and/or email

setRecurrence()  : mixed

Set recurrence information for this appointment

setReminder()  : mixed

Set reminder for this appointment.

setResponseType()  : mixed

Set user response type. Should be one of: none, organizer, tentative, accepted, declined

setSensitivity()  : mixed

Set the sensitivity level for this appointment.

setServerUID()  : mixed

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()  : mixed

Set the appointment subject field.

setSupported()  : mixed

Set the list of non-ghosted fields for this message.

setTimezone()  : mixed

Set the timezone

setUid()  : mixed

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.

_checkDatetime()  : mixed

Checks that the start and end times are populated correctly.

_checkEncoding()  : 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.

_checkSendEmpty()  : bool

Checks to see if we should send an empty value.

_formatDate()  : 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.

_getAttribute()  : mixed

Helper method to allow default values for unset properties.

_parseDate()  : Horde_Date|bool

Get a Horde_Date from a timestamp, ensuring it's in the correct format.

_preEncodeValidation()  : bool

Give concrete classes the chance to enforce rules before encoding messages to send to the client.

_validateDecodedValues()  : bool

Give concrete classes the chance to enforce rules on property values.

_hex2bin()  : string

Function which converts a hex entryid to a binary entryid.