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_Task

Horde_ActiveSync_Message_Task class represents a single ActiveSync Task.

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

Horde_ActiveSync_Message_Base
Extended by Horde_ActiveSync_Message_Task
Package: ActiveSync
Author: Michael J. Rubinsky mrubinsk@horde.org
Located at Horde/ActiveSync/Message/Task.php
Methods summary
public
# setSubject( string $subject )

Sets the task subject

Sets the task subject

Parameters

$subject
public string
# getSubject( )

Get the task subject/title

Get the task subject/title

Returns

string
The task subject
public string
# getBody( )

Returns the body of the task.

Returns the body of the task.

Returns

string
The descriptive body.
public
# setBody( string $body )

Set the task body element.

Set the task body element.

Parameters

$body
The task body
public
# setComplete( integer $flag )

Set the task completion flag

Set the task completion flag

Parameters

$flag
TASK_COMPLETE constant
public integer
# getComplete( )

Get the completion flag

Get the completion flag

Returns

integer
A TASK_COMPLETE constant
public
# setDateCompleted( Horde_Date $date )

Set the date the task was completed.

Set the date the task was completed.

Parameters

$date
The date in local tz.
public Horde_Date
# getDateCompleted( )

Get the date completed.

Get the date completed.

Returns

Horde_Date
The date in the local tz.
public
# setDueDate( Horde_Date $date )

Set the due date. Note that even though the property is called UTCDueDate we still pass a Horde_Date in the user's timezone since the dates are transformed to UTC during encoding. Yay consistency...

Set the due date. Note that even though the property is called UTCDueDate we still pass a Horde_Date in the user's timezone since the dates are transformed to UTC during encoding. Yay consistency...

Parameters

$date
The date.
public Horde_Date
# getDueDate( )

Get the task due date.

Get the task due date.

Returns

Horde_Date
Date in local tz
public
# setImportance( integer $importance )

Set the importance

Set the importance

Parameters

$importance
A IMPORTANCE_* flag
public integer
# getImportance( )

Get the task importance level

Get the task importance level

Returns

integer
A IMPORTANCE_* constant
public
# setReminder( Horde_Date $datetime )

Set the reminder datetime

Set the reminder datetime

Parameters

$datetime
The time to trigger the alarm in local tz.
public Horde_Date
# getReminder( )

Get the reminder time.

Get the reminder time.

Returns

Horde_Date
in local tz
public
# setStartDate( Horde_Date $date )

Set the task start datetime

Set the task start datetime

Parameters

$date
Date in local tz
public Horde_Date
# getStartDate( )

Get the task start datetime

Get the task start datetime

Returns

Horde_Date
public string
# getClass( )

Return this object's folder class

Return this object's folder class

Returns

string
Methods inherited from Horde_ActiveSync_Message_Base
__call(), __construct(), __get(), __isset(), __set(), decodeStream(), encodeStream(), getSupported(), isGhosted(), setSupported()
Constants summary
string POOMTASKS_BODY
# 'POOMTASKS:Body'
string POOMTASKS_BODYSIZE
# 'POOMTASKS:BodySize'
string POOMTASKS_BODYTRUNCATED
# 'POOMTASKS:BodyTruncated'
string POOMTASKS_CATEGORIES
# 'POOMTASKS:Categories'
string POOMTASKS_CATEGORY
# 'POOMTASKS:Category'
string POOMTASKS_COMPLETE
# 'POOMTASKS:Complete'
string POOMTASKS_DATECOMPLETED
# 'POOMTASKS:DateCompleted'
string POOMTASKS_DUEDATE
# 'POOMTASKS:DueDate'
string POOMTASKS_UTCDUEDATE
# 'POOMTASKS:UtcDueDate'
string POOMTASKS_IMPORTANCE
# 'POOMTASKS:Importance'
string POOMTASKS_RECURRENCE
# 'POOMTASKS:Recurrence'
string POOMTASKS_TYPE
# 'POOMTASKS:Type'
string POOMTASKS_START
# 'POOMTASKS:Start'
string POOMTASKS_UNTIL
# 'POOMTASKS:Until'
string POOMTASKS_OCCURRENCES
# 'POOMTASKS:Occurrences'
string POOMTASKS_INTERVAL
# 'POOMTASKS:Interval'
string POOMTASKS_DAYOFWEEK
# 'POOMTASKS:DayOfWeek'
string POOMTASKS_DAYOFMONTH
# 'POOMTASKS:DayOfMonth'
string POOMTASKS_WEEKOFMONTH
# 'POOMTASKS:WeekOfMonth'
string POOMTASKS_MONTHOFYEAR
# 'POOMTASKS:MonthOfYear'
string POOMTASKS_REGENERATE
# 'POOMTASKS:Regenerate'
string POOMTASKS_DEADOCCUR
# 'POOMTASKS:DeadOccur'
string POOMTASKS_REMINDERSET
# 'POOMTASKS:ReminderSet'
string POOMTASKS_REMINDERTIME
# 'POOMTASKS:ReminderTime'
string POOMTASKS_SENSITIVITY
# 'POOMTASKS:Sensitivity'
string POOMTASKS_STARTDATE
# 'POOMTASKS:StartDate'
string POOMTASKS_UTCSTARTDATE
# 'POOMTASKS:UtcStartDate'
string POOMTASKS_SUBJECT
# 'POOMTASKS:Subject'
string POOMTASKS_RTF
# 'POOMTASKS:Rtf'
integer TASK_COMPLETE_TRUE
# 1
integer TASK_COMPLETE_FALSE
# 0
integer IMPORTANCE_LOW
# 0
integer IMPORTANCE_NORMAL
# 1
integer IMPORTANCE_HIGH
# 2
integer REMINDER_SET_FALSE
# 0
integer REMINDER_SET_TRUE
# 1
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 $categories
# array()
public integer $bodytruncated
# 0
Properties inherited from Horde_ActiveSync_Message_Base
$flags
API documentation generated by ApiGen