Attendee
The Attendee object represents an attendee of a calendar event item.
Installation:
To use this API in your project, add the calendar plugin:
webworks plugin add com.blackberry.pim.calendar
| Properties: | |
|---|---|
| String | contactId |
| String | |
| String | eventId |
| String | name |
| Boolean | owner |
| Number | role |
| Number | status |
| Number | type |
| 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 |
contactId
Identifier for the contact that the attendee object represents.
Synopsis:
String Attendee.contactID
The attendee's email address.
Synopsis:
String Attendee.email
eventId
Identifier for the event in which this attendee participates.
Synopsis:
String Attendee.eventId
name
The attendee's name.
Synopsis:
String Attendee.name
owner
Indicates whether the attendee is the owner or not
Synopsis:
Boolean Attendee.owner
role
The attendee's role: ROLE_CHAIR, ROLE_REQUIRED_PARTICIPANT, ROLE_OPTIONAL_PARTICIPANT or ROLE_NON_PARTICIPANT
Synopsis:
Number Attendee.role
status
Acceptance status of the attendee: STATUS_UNKNOWN, STATUS_TENTATIVE, STATUS_ACCEPTED, STATUS_DECLINED, or STATUS_NOT_RESPONDED
Synopsis:
Number Attendee.status
type
The attendee's type: Attendee.TYPE_HOST or Attendee.TYPE_PARTICIPANT .
Synopsis:
Number Attendee.type
TYPE_HOST
Indicates the attendee is hosting the meeting.
Synopsis:
constant
Number Attendee.TYPE_HOST
TYPE_PARTICIPANT
Indicates the attendee is a participant in the meeting.
Synopsis:
constant
Number Attendee.TYPE_PARTICIPANT
ROLE_CHAIR
Indicates that the attendee is the meeting's organizer.
Synopsis:
constant
Number Attendee.ROLE_CHAIR = 1
ROLE_REQUIRED_PARTICIPANT
Indicates that the attendee is a required participant.
Synopsis:
constant
Number Attendee.ROLE_REQUIRED_PARTICIPANT = 2
ROLE_OPTIONAL_PARTICIPANT
Used on attendees whose participation is optional.
Synopsis:
constant
Number Attendee.ROLE_OPTIONAL_PARTICIPANT = 3
ROLE_NON_PARTICIPANT
Indicates that an attendee is listed for information purposes only.
Synopsis:
constant
Number Attendee.ROLE_NON_PARTICIPANT = 4
STATUS_UNKNOWN
Unknown acceptance status.
Synopsis:
constant
Number Attendee.STATUS_UNKNOWN = 0
STATUS_TENTATIVE
Indicates the attendee will attempt to be in the meeting.
Synopsis:
constant
Number Attendee.STATUS_TENTATIVE = 2
STATUS_ACCEPTED
Indicates the attendee has agreed to participate in the meeting.
Synopsis:
constant
Number Attendee.STATUS_ACCEPTED = 3
STATUS_DECLINED
Used for an attendee that refused to participate in an event.
Synopsis:
constant
Number Attendee.STATUS_DECLINED = 4
STATUS_NOT_RESPONDED
Used when an attendee has not yet responded to the meeting request.
Synopsis:
constant
Number Attendee.STATUS_NOT_RESPONDED = 4
Last modified: 2014-10-09
Got questions about leaving a comment? Get answers from our Disqus FAQ.
comments powered by Disqus