Attendee

The Attendee object represents an attendee of a calendar event item.


Supported Platform(s)

- BlackBerry 10
View Supported Platform Table
APIBB5.0BB6.0BB7.0PB1.0PB2.0BB10Ripple
contactId           Y 
email           Y 
eventId           Y 
name           Y 
owner           Y 
role           Y 
status           Y 
type           Y 
TYPE_HOST           Y 
TYPE_PARTICIPANT           Y 
ROLE_CHAIR           Y 
ROLE_REQUIRED_PARTICIPANT           Y 
ROLE_OPTIONAL_PARTICIPANT           Y 
ROLE_NON_PARTICIPANT           Y 
STATUS_UNKNOWN           Y 
STATUS_TENTATIVE           Y 
STATUS_ACCEPTED           Y 
STATUS_DECLINED           Y 
STATUS_NOT_RESPONDED           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.calendar" />           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.

Properties

String contactId
String email
String eventId
String name
Boolean owner
Number role
Number status
Number type

Properties

String contactId


Identifier for the contact that the attendee object represents.


Supported Platforms
 - BlackBerry 10

String email


The attendee's email address.


Supported Platforms
 - BlackBerry 10

String eventId


Identifier for the event in which this attendee participates.


Supported Platforms
 - BlackBerry 10

String name


The attendee's name.


Supported Platforms
 - BlackBerry 10

Boolean owner


True when the attendee represents the user.


Supported Platforms
 - BlackBerry 10

Number role


The attendee's role: ROLE_CHAIR, ROLE_REQUIRED_PARTICIPANT, ROLE_OPTIONAL_PARTICIPANT or ROLE_NON_PARTICIPANT


Supported Platforms
 - BlackBerry 10

Number status


Acceptance status of the attendee: STATUS_UNKNOWN, STATUS_TENTATIVE, STATUS_ACCEPTED, STATUS_DECLINED, or STATUS_NOT_RESPONDED


Supported Platforms
 - BlackBerry 10

Number type


The attendee's type: TYPE_HOST or TYPE_PARTICIPANT


Supported Platforms
 - BlackBerry 10

Constants

static Number TYPE_HOST


Indicates the attendee is hosting the meeting.


Supported Platforms
 - BlackBerry 10

static Number TYPE_PARTICIPANT


Indicates the attendee is a participant in the meeting.


Supported Platforms
 - BlackBerry 10

static Number ROLE_CHAIR


Indicates that the attendee is the meeting's organizer.


Supported Platforms
 - BlackBerry 10

static Number ROLE_REQUIRED_PARTICIPANT


Indicates that the attendee is a required participant.


Supported Platforms
 - BlackBerry 10

static Number ROLE_OPTIONAL_PARTICIPANT


Used on attendees whose participation is optional.


Supported Platforms
 - BlackBerry 10

static Number ROLE_NON_PARTICIPANT


Indicates that an attendee is listed for information purposes only.


Supported Platforms
 - BlackBerry 10

static Number STATUS_UNKNOWN


Unknown acceptance status.


Supported Platforms
 - BlackBerry 10

static Number STATUS_TENTATIVE


Indicates the attendee will attempt to be in the meeting.


Supported Platforms
 - BlackBerry 10

static Number STATUS_ACCEPTED


Indicates the attendee has agreed to participate in the meeting.


Supported Platforms
 - BlackBerry 10

static Number STATUS_DECLINED


Used for an attendee that refused to participate in an event.


Supported Platforms
 - BlackBerry 10

static Number STATUS_NOT_RESPONDED


Used when an attendee has not yet responded to the meeting request.


Supported Platforms
 - BlackBerry 10

Documentation generated by JsDoc Toolkit 2.4.0 on Mon Feb 11 2013 14:51:02 GMT-0500 (EST)