GData JavaScript Client 1.2

Class google.gdata.Who

Object
   |
   +--google.gdata.Who
Direct Known Subclasses:
google.gdata.calendar.CalendarWho

class 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

email

String|undefined email

rel

String|undefined rel

valueString

String|undefined valueString

REL_EVENT_ATTENDEE

<static> <final> String REL_EVENT_ATTENDEE

REL_EVENT_ORGANIZER

<static> <final> String REL_EVENT_ORGANIZER

REL_EVENT_PERFORMER

<static> <final> String REL_EVENT_PERFORMER

REL_EVENT_SPEAKER

<static> <final> String REL_EVENT_SPEAKER

REL_MESSAGE_BCC

<static> <final> String REL_MESSAGE_BCC

REL_MESSAGE_CC

<static> <final> String REL_MESSAGE_CC

REL_MESSAGE_FROM

<static> <final> String REL_MESSAGE_FROM

REL_MESSAGE_REPLY_TO

<static> <final> String REL_MESSAGE_REPLY_TO

REL_MESSAGE_TO

<static> <final> String REL_MESSAGE_TO

REL_TASK_ASSIGNED_TO

<static> <final> String REL_TASK_ASSIGNED_TO

Constructor Detail

google.gdata.Who

google.gdata.Who(<Object> opt_params)

Method Detail

getAttendeeStatus

google.gdata.AttendeeStatus|undefined getAttendeeStatus()

getAttendeeType

google.gdata.AttendeeType|undefined getAttendeeType()

getEmail

String|undefined getEmail()

getEntryLink

google.gdata.EntryLink|undefined getEntryLink()

getEntryLinkClass

Function getEntryLinkClass()

getRel

String|undefined getRel()

getValueString

String|undefined getValueString()

setAttendeeStatus

void setAttendeeStatus(<google.gdata.AttendeeStatus|Object|undefined> attendeeStatus)

setAttendeeType

void setAttendeeType(<google.gdata.AttendeeType|Object|undefined> attendeeType)

setEmail

void setEmail(<String|undefined> email)

setEntryLink

void setEntryLink(<google.gdata.EntryLink|Object|undefined> entryLink)

setRel

void setRel(<String|undefined> rel)

setValueString

void setValueString(<String|undefined> valueString)

GData JavaScript Client 1.2

Documentation generated by JSDoc on Wed May 14 17:39:24 2008