|
GData JavaScript Client 1.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Object | +--google.gdata.Who
Describes a person associated with the containing entity.
Defined in gdata.js
Field Summary | |
String|undefined |
email
Email address. |
String|undefined |
rel
Relationship between the containing entity and the contained person. |
String|undefined |
valueString
Simple string value that can be used as a representation of this person. |
<static> <final> String |
REL_EVENT_ATTENDEE
A general meeting/event attendee. |
<static> <final> String |
REL_EVENT_ORGANIZER
Event organizer (an organizer is not necessarily an attendee). |
<static> <final> String |
REL_EVENT_PERFORMER
Performer (similar to speaker, but with more emphasis on art than speech delivery). |
<static> <final> String |
REL_EVENT_SPEAKER
Speaker. |
<static> <final> String |
REL_MESSAGE_BCC
Message BCC recipient. |
<static> <final> String |
REL_MESSAGE_CC
Message CC recipient. |
<static> <final> String |
REL_MESSAGE_FROM
Message primary recipient. |
<static> <final> String |
REL_MESSAGE_REPLY_TO
Intended recipient of a reply message. |
<static> <final> String |
REL_MESSAGE_TO
Message (email or IM) sender. |
<static> <final> String |
REL_TASK_ASSIGNED_TO
Person to whom task is assigned. |
Constructor Summary | |
google.gdata.Who(<Object> opt_params)
Constructs a person description using an object parameter whose property names match the setter method to use for each property. |
Method Summary | |
google.gdata.AttendeeStatus|undefined
|
getAttendeeStatus()
Returns the event attendee status. |
google.gdata.AttendeeType|undefined
|
getAttendeeType()
Returns the event attendee type. |
String|undefined
|
getEmail()
Returns the email address. |
google.gdata.EntryLink|undefined
|
getEntryLink()
Returns the nested person entry. |
Function
|
getEntryLinkClass()
Returns the class to use for representing gd:entryLink. |
String|undefined
|
getRel()
Returns the relationship between the containing entity and the contained person. |
String|undefined
|
getValueString()
Returns the simple string value that can be used as a representation of this person. |
void
|
setAttendeeStatus(<google.gdata.AttendeeStatus|Object|undefined> attendeeStatus)
Sets the event attendee status. |
void
|
setAttendeeType(<google.gdata.AttendeeType|Object|undefined> attendeeType)
Sets the event attendee type. |
void
|
setEmail(<String|undefined> email)
Sets the email address. |
void
|
setEntryLink(<google.gdata.EntryLink|Object|undefined> entryLink)
Sets the nested person entry. |
void
|
setRel(<String|undefined> rel)
Sets the relationship between the containing entity and the contained person. |
void
|
setValueString(<String|undefined> valueString)
Sets the simple string value that can be used as a representation of this person. |
Field Detail |
String|undefined email
String|undefined rel
String|undefined valueString
<static> <final> String REL_EVENT_ATTENDEE
<static> <final> String REL_EVENT_ORGANIZER
<static> <final> String REL_EVENT_PERFORMER
<static> <final> String REL_EVENT_SPEAKER
<static> <final> String REL_MESSAGE_BCC
<static> <final> String REL_MESSAGE_CC
<static> <final> String REL_MESSAGE_FROM
<static> <final> String REL_MESSAGE_REPLY_TO
<static> <final> String REL_MESSAGE_TO
<static> <final> String REL_TASK_ASSIGNED_TO
Constructor Detail |
google.gdata.Who(<Object> opt_params)
opt_params
- Optional parameters, each of which is used as the sole parameter to the associated setter method: attendeeStatus, attendeeType, email, entryLink, rel, and valueString
Method Detail |
google.gdata.AttendeeStatus|undefined getAttendeeStatus()
google.gdata.AttendeeType|undefined getAttendeeType()
String|undefined getEmail()
google.gdata.EntryLink|undefined getEntryLink()
Function getEntryLinkClass()
String|undefined getRel()
String|undefined getValueString()
void setAttendeeStatus(<google.gdata.AttendeeStatus|Object|undefined> attendeeStatus)
attendeeStatus
- Event attendee status, or object to use as a parameter to the google.gdata.AttendeeStatus constructor, or undefined for none
void setAttendeeType(<google.gdata.AttendeeType|Object|undefined> attendeeType)
attendeeType
- Event attendee type, or object to use as a parameter to the google.gdata.AttendeeType constructor, or undefined for none
void setEmail(<String|undefined> email)
email
- Email address or undefined for none
void setEntryLink(<google.gdata.EntryLink|Object|undefined> entryLink)
entryLink
- Nested person entry, or object to use as a parameter to the google.gdata.EntryLink constructor, or undefined for none
void setRel(<String|undefined> rel)
rel
- Relationship between the containing entity and the contained person or undefined for none
void setValueString(<String|undefined> valueString)
valueString
- Simple string value that can be used as a representation of this person or undefined for none
|
GData JavaScript Client 1.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |