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
APIBB5.0BB6.0BB7.0PB1.0PB2.0BB10Ripple
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 IDBB5.0BB6.0BB7.0PB1.0PB2.0BB10Ripple
<feature id="blackberry.pim.Attendee" /> Y Y Y      Y

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

Constructors

blackberry.pim.Attendee

Properties

String address
Number type

Constants

Number ORGANIZER
Number INVITED
Number ACCEPTED
Number DECLINED
Number TENTATIVE

Constructors

blackberry.pim.Attendee ()

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


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator


Code Example: 
<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

String address


Contains the email address of a particular attendee.


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

Number type


Indicates the type of a particular attendee. Value can be one of the Attendee types.


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

Constants

static Number ORGANIZER


Event organizer


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number INVITED


Attendee as been invited.


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number ACCEPTED


Attendee has accepted the invitation.


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number DECLINED


Attendee has declined the invitation.


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number TENTATIVE


Attendee has tentatively accepted the invitation.


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

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