Attendee
The Attendee object represents an attendee of a calendar event item.
Supported Platform(s)
| - BlackBerry 10 |
| API | BB5.0 | BB6.0 | BB7.0 | PB1.0 | PB2.0 | BB10 | Ripple |
|---|---|---|---|---|---|---|---|
| contactId | Y | ||||||
| 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 ID | BB5.0 | BB6.0 | BB7.0 | PB1.0 | PB2.0 | BB10 | Ripple |
|---|---|---|---|---|---|---|---|
| <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
Constants
| Number | TYPE_HOST |
| Number | TYPE_PARTICIPANT |
| Number | ROLE_CHAIR |
| Number | ROLE_REQUIRED_PARTICIPANT |
| Number | ROLE_OPTIONAL_PARTICIPANT |
| Number | ROLE_NON_PARTICIPANT |
| Number | STATUS_UNKNOWN |
| Number | STATUS_TENTATIVE |
| Number | STATUS_ACCEPTED |
| Number | STATUS_DECLINED |
| Number | STATUS_NOT_RESPONDED |
Properties
String
contactId
Identifier for the contact that the attendee object represents.
| Supported Platforms | |
|---|---|
| - BlackBerry 10 | |
String
eventId
Identifier for the event in which this attendee participates.
| 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 | |
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_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 | |