Overview

Packages

  • ActiveSync
  • None

Classes

  • Horde_ActiveSync_Message_Appointment
  • Horde_ActiveSync_Message_Attendee
  • Horde_ActiveSync_Message_Contact
  • Horde_ActiveSync_Message_Exception
  • Horde_ActiveSync_Message_Folder
  • Horde_ActiveSync_Message_Recurrence
  • Horde_ActiveSync_Message_Task
  • Horde_ActiveSync_State_Base
  • Horde_ActiveSync_State_History
  • Horde_ActiveSync_Timezone
  • Overview
  • Package
  • Class
  • Tree

Class Horde_ActiveSync_Message_Appointment

Horde_ActiveSync_Message_Appointment class represents a single ActiveSync Appointment object. Responsible for mapping all fields to and from wbxml.

Copyright 2010-2012 Horde LLC (http://www.horde.org/)

Horde_ActiveSync_Message_Base
Extended by Horde_ActiveSync_Message_Appointment

Direct known subclasses

Horde_ActiveSync_Message_Exception
Package: ActiveSync
Author: Michael J. Rubinsky mrubinsk@horde.org
Located at Horde/ActiveSync/Message/Appointment.php
Methods summary
public
# setTimezone( mixed $date )

Set the timezone

Set the timezone

Parameters

$date
<p>Either a Horde_Date or timezone descriptor such as America/New_York etc...</p>

Throws

InvalidArgumentException
public
# getTimezone( )

Get the event's timezone

Get the event's timezone
public
# setDTStamp( mixed $date )

Set the appointment's modify timestamp

Set the appointment's modify timestamp

Parameters

$date
$timestamp Horde_Date or a unix timestamp
public integer
# getDTStamp( )

Get the appointment's dtimestamp

Get the appointment's dtimestamp

Returns

integer
timestamp
public
# setDatetime( array $datetime = array() )

Set the appointment time/duration.

Set the appointment time/duration.

Parameters

$datetime
$timestamp 'start', 'end' or 'duration' (in seconds) or 'allday'

Throws

InvalidArgumentException
public array
# getDatetime( )

Get the appointment's time data

Get the appointment's time data

Returns

array
containing 'start', 'end', 'allday'
public
# setSubject( string $subject )

Set the appointment subject field.

Set the appointment subject field.

Parameters

$subject
UTF-8 string
public string
# getSubject( )

Get the subject

Get the subject

Returns

string
The UTF-8 subject string
public
# setUid( string $uid )

Set the appointment uid. Note that this is the PIM's UID value, and not the value that the server uses for the UID. ActiveSync messages do not include any server uid value as part of the message natively.

Set the appointment uid. Note that this is the PIM's UID value, and not the value that the server uses for the UID. ActiveSync messages do not include any server uid value as part of the message natively.

Parameters

$uid
The server's uid for this appointment
public string
# getUid( )

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

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

Returns

string
public
# setServerUID( string $uid )

Because the PIM 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.

Because the PIM 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.

Parameters

$uid
The server UID
public string
# getServerUID( )

Obtain the server UID. See note above.

Obtain the server UID. See note above.

Returns

string
public
# setOrganizer( array $organizer )

Set the organizer name and/or email

Set the organizer name and/or email

Parameters

$organizer
and 'email' for this appointment organizer.
public array
# getOrganizer( )

Get the details for the appointment organizer

Get the details for the appointment organizer

Returns

array
with 'name' and 'email' values
public
# setLocation( string $location )

Set appointment location field.

Set appointment location field.

Parameters

$location
public string
# getLocation( )

Get the location field

Get the location field

Returns

string
public
# setRecurrence( Horde_Date_Recurrence $recurrence )

Set recurrence information for this appointment

Set recurrence information for this appointment

Parameters

$recurrence
public Horde_Date_Recurrence
# getRecurrence( )

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

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

Returns

Horde_Date_Recurrence
public
# addException( Horde_ActiveSync_Message_Exception $exception )

Add a recurrence exception

Add a recurrence exception

Parameters

$exception
public array
# getExceptions( )

Returns

array
An array of Horde_ActiveSync_Message_Exception objects
public
# setSensitivity( integer $sensitivity )

Set the sensitivity level for this appointment.

Set the sensitivity level for this appointment.

Should be one of: normal, personal, private, confidential

Parameters

$sensitivity
The SENSITIVITY constant
public integer
# getSensitivity( )

Return the sensitivity setting for this appointment

Return the sensitivity setting for this appointment

Returns

integer
The SENSITIVITY constant
public
# setBusyStatus( integer $busy )

Sets the busy status for this appointment

Sets the busy status for this appointment

Parameters

$busy
The BUSYSTATUS constant
public integer
# getBusyStatus( )

Return the busy status for this appointment.

Return the busy status for this appointment.

Returns

integer
The BUSYSTATUS constant
public
# setResponseType( integer $response )

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

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

Parameters

$response
The response type constant
public integer
# getResponseType( )

Get response type

Get response type

Returns

integer
The responsetype constant
public
# setReminder( integer $minutes )

Set reminder for this appointment.

Set reminder for this appointment.

Parameters

$minutes
<p>The number of minutes before appintment to trigger a reminder.</p>
public integer
# getReminder( )

Returns

integer
Number of minutes before appointment for notifications.
public
# setMeetingStatus( integer $status )

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

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

Parameters

$status
A MEETING_* constant
public integer
# getMeetingStatus( )

Returns

integer
A MEETING_* constant
public
# addAttendee( array $attendee )

Add an attendee to this appointment

Add an attendee to this appointment

Parameters

$attendee
'name', 'email' for each attendee
public array
# getAttendees( )

Get a list of this event's attendees

Get a list of this event's attendees

Returns

array
An array of 'name' and 'email' hashes
public
# setBody( string $body )

Set the appointment's body

Set the appointment's body

Parameters

$body
UTF-8 encoded string
public string
# getBody( )

Get the appointment's body

Get the appointment's body

Returns

string
UTF-8 encoded string
public
# addCategory( string $category )

Add a category to the appointment

Add a category to the appointment

Parameters

$category
public
# getCategories( )
public string
# getClass( )

Return the collection class name the object is for.

Return the collection class name the object is for.

Returns

string
Methods inherited from Horde_ActiveSync_Message_Base
__call(), __construct(), __get(), __isset(), __set(), decodeStream(), encodeStream(), getSupported(), isGhosted(), setSupported()
Constants summary
string POOMCAL_TIMEZONE
# 'POOMCAL:Timezone'
string POOMCAL_ALLDAYEVENT
# 'POOMCAL:AllDayEvent'
string POOMCAL_ATTENDEES
# 'POOMCAL:Attendees'
string POOMCAL_ATTENDEE
# 'POOMCAL:Attendee'
string POOMCAL_ATTENDEESTATUS
# 'POOMCAL:AttendeeStatus'
string POOMCAL_ATTENDEETYPE
# 'POOMCAL:AttendeeType'
string POOMCAL_EMAIL
# 'POOMCAL:Email'
string POOMCAL_NAME
# 'POOMCAL:Name'
string POOMCAL_BODY
# 'POOMCAL:Body'
string POOMCAL_BODYTRUNCATED
# 'POOMCAL:BodyTruncated'
string POOMCAL_BUSYSTATUS
# 'POOMCAL:BusyStatus'
string POOMCAL_CATEGORIES
# 'POOMCAL:Categories'
string POOMCAL_CATEGORY
# 'POOMCAL:Category'
string POOMCAL_RTF
# 'POOMCAL:Rtf'
string POOMCAL_DTSTAMP
# 'POOMCAL:DtStamp'
string POOMCAL_ENDTIME
# 'POOMCAL:EndTime'
string POOMCAL_EXCEPTION
# 'POOMCAL:Exception'
string POOMCAL_EXCEPTIONS
# 'POOMCAL:Exceptions'
string POOMCAL_DELETED
# 'POOMCAL:Deleted'
string POOMCAL_EXCEPTIONSTARTTIME
# 'POOMCAL:ExceptionStartTime'
string POOMCAL_LOCATION
# 'POOMCAL:Location'
string POOMCAL_MEETINGSTATUS
# 'POOMCAL:MeetingStatus'
string POOMCAL_ORGANIZEREMAIL
# 'POOMCAL:OrganizerEmail'
string POOMCAL_ORGANIZERNAME
# 'POOMCAL:OrganizerName'
string POOMCAL_RECURRENCE
# 'POOMCAL:Recurrence'
string POOMCAL_TYPE
# 'POOMCAL:Type'
string POOMCAL_UNTIL
# 'POOMCAL:Until'
string POOMCAL_OCCURRENCES
# 'POOMCAL:Occurrences'
string POOMCAL_INTERVAL
# 'POOMCAL:Interval'
string POOMCAL_DAYOFWEEK
# 'POOMCAL:DayOfWeek'
string POOMCAL_DAYOFMONTH
# 'POOMCAL:DayOfMonth'
string POOMCAL_WEEKOFMONTH
# 'POOMCAL:WeekOfMonth'
string POOMCAL_MONTHOFYEAR
# 'POOMCAL:MonthOfYear'
string POOMCAL_REMINDER
# 'POOMCAL:Reminder'
string POOMCAL_SENSITIVITY
# 'POOMCAL:Sensitivity'
string POOMCAL_SUBJECT
# 'POOMCAL:Subject'
string POOMCAL_STARTTIME
# 'POOMCAL:StartTime'
string POOMCAL_UID
# 'POOMCAL:UID'
string POOMCAL_RESPONSETYPE
# 'POOMCAL:ResponseType'
integer SENSITIVITY_NORMAL
# 0
integer SENSITIVITY_PERSONAL
# 1
integer SENSITIVITY_PRIVATE
# 2
integer SENSITIVITY_CONFIDENTIAL
# 3
integer BUSYSTATUS_FREE
# 0
integer BUSYSTATUS_TENTATIVE
# 1
integer BUSYSTATUS_BUSY
# 2
integer BUSYSTATUS_OUT
# 3
integer IS_ALL_DAY
# 1
integer MEETING_NOT_MEETING
# 0
integer MEETING_IS_MEETING
# 1
integer MEETING_RECEIVED
# 3
integer MEETING_CANCELLED
# 5
integer MEETING_CANCELLED_RECEIVED
# 7
integer RESPONSE_NONE
# 0
integer RESPONSE_ORGANIZER
# 1
integer RESPONSE_TENTATIVE
# 2
integer RESPONSE_ACCEPTED
# 3
integer RESPONSE_DECLINED
# 4
integer RESPONSE_NORESPONSE
# 5
Constants inherited from Horde_ActiveSync_Message_Base
KEY_ATTRIBUTE, KEY_TYPE, KEY_VALUES, TYPE_DATE, TYPE_DATE_DASHES, TYPE_HEX, TYPE_MAPI_STREAM
Properties summary
public array $exceptions

Workarounds for PHP < 5.2.6 not being able to return an array by reference from a __get() property.

Workarounds for PHP < 5.2.6 not being able to return an array by reference from a __get() property.
# array()
public array $attendees
# array()
public array $categories
# array()
public integer $bodytruncated
# 0
Properties inherited from Horde_ActiveSync_Message_Base
$flags
API documentation generated by ApiGen