Attendee

The Attendee object is used to represent a person who is invited to a calendar appointment.

Supported Platform(s)

- BlackBerry OS 5.0+
- Ripple Emulator

View Supported Platform Table

API	OS 5.0	OS 6.0	OS 7.0	Ripple
blackberry.pim.Attendee	Y	Y	Y	Y
address	Y	Y	Y	Y
type	Y	Y	Y	Y
ORGANIZER	Y	Y	Y	Y
INVITED	Y	Y	Y	Y
ACCEPTED	Y	Y	Y	Y
DECLINED	Y	Y	Y	Y
TENTATIVE	Y	Y	Y	Y

Configuration Document Settings

To use all of the API described for this object, you must ensure the following settings are in your configuration document:

You must declare the feature element(s) below in your configuration document:

Feature ID	OS 5.0	OS 6.0	OS 7.0	PlayBook	Ripple
<feature id="blackberry.pim.Attendee" />	Y	Y	Y		Y

Permission Elements (PlayBook Only)
This API does not require a <permission> element to be declared in the configuration document of your BlackBerry WebWorks Application.

API Summary

Constructors

blackberry.pim.Attendee

Properties

address
type

Constants

blackberry.pim.Attendee

blackberry.pim.Attendee ()

Supported Platform(s)

- BlackBerry OS 5.0+
- Ripple Emulator

Description

The Attendee object is an instance object, where if a new instance is desired, it must be created using the new keyword.

Code Example(s)

<script type="text/javascript">
  // Create our Event
    var newAppt = new blackberry.pim.Appointment();
    newAppt.location = "Your office";
    newAppt.summary = "Talk about new project";
    newAppt.freeBusy = 0; // Free

  // Create our hour time slot
    var start = new Date();
    newAppt.start = start;
    var end = start.setHours(start.getHours() + 1);
    newAppt.end = end;

  // Create Attendee
    var attendees = [];
    var onlyAttendee = new blackberry.pim.Attendee();
    onlyAttendee.address = "john@foo.com";
    onlyAttendee.type = blackberry.pim.Attendee.INVITED;
    attendees.push(onlyAttendee);

    newAppt.attendees = attendees;
    newAppt.save();
</script>

Properties:

Property	Type	Description	Supported Platform(s)
address	String	Contains the email address of a particular attendee.	- BlackBerry OS 5.0+ - Ripple Emulator
type	Number	Indicates the type of a particular attendee. Value can be one of the Attendee types.	- BlackBerry OS 5.0+ - Ripple Emulator

Constants:

Property	Type	Description	Supported Platform(s)
ORGANIZER	Number	Event organizer	- BlackBerry OS 5.0+ - Ripple Emulator
INVITED	Number	Attendee as been invited.	- BlackBerry OS 5.0+ - Ripple Emulator
ACCEPTED	Number	Attendee has accepted the invitation.	- BlackBerry OS 5.0+ - Ripple Emulator
DECLINED	Number	Attendee has declined the invitation.	- BlackBerry OS 5.0+ - Ripple Emulator
TENTATIVE	Number	Attendee has tentatively accepted the invitation.	- BlackBerry OS 5.0+ - Ripple Emulator

Documentation generated by JsDoc Toolkit 2.4.0 on Sun Dec 30 2012 13:31:15 GMT-0500 (EST)