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 Detail

email

String|undefined email

Email address. This attribute is optional.

rel

String|undefined rel

Relationship between the containing entity and the contained person. This attribute is optional.

valueString

String|undefined valueString

Simple string value that can be used as a representation of this person. This attribute is optional.

REL_EVENT_ATTENDEE

<static> <final> String REL_EVENT_ATTENDEE

A general meeting/event attendee.

REL_EVENT_ORGANIZER

<static> <final> String REL_EVENT_ORGANIZER

Event organizer (an organizer is not necessarily an attendee).

REL_EVENT_PERFORMER

<static> <final> String REL_EVENT_PERFORMER

Performer (similar to speaker, but with more emphasis on art than speech delivery).

REL_EVENT_SPEAKER

<static> <final> String REL_EVENT_SPEAKER

Speaker.

REL_MESSAGE_BCC

<static> <final> String REL_MESSAGE_BCC

Message BCC recipient.

REL_MESSAGE_CC

<static> <final> String REL_MESSAGE_CC

Message CC recipient.

REL_MESSAGE_FROM

<static> <final> String REL_MESSAGE_FROM

Message primary recipient.

REL_MESSAGE_REPLY_TO

<static> <final> String REL_MESSAGE_REPLY_TO

Intended recipient of a reply message.

REL_MESSAGE_TO

<static> <final> String REL_MESSAGE_TO

Message (email or IM) sender.

REL_TASK_ASSIGNED_TO

<static> <final> String REL_TASK_ASSIGNED_TO

Person to whom task is assigned.

google.gdata.Who

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.

Parameters:
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

getAttendeeStatus

google.gdata.AttendeeStatus|undefined getAttendeeStatus()

Returns the event attendee status. This element is optional.

Returns:
Event attendee status or undefined for none

getAttendeeType

google.gdata.AttendeeType|undefined getAttendeeType()

Returns the event attendee type. This element is optional.

Returns:
Event attendee type or undefined for none

getEmail

String|undefined getEmail()

Returns the email address. This attribute is optional.

Returns:
Email address or undefined for none

getEntryLink

google.gdata.EntryLink|undefined getEntryLink()

Returns the nested person entry. This element is optional.

Returns:
Nested person entry or undefined for none

getEntryLinkClass

Function getEntryLinkClass()

Returns the class to use for representing gd:entryLink. Override to use an extension of google.gdata.EntryLink.

Returns:
Class to use for representing gd:entryLink

getRel

String|undefined getRel()

Returns the relationship between the containing entity and the contained person. This attribute is optional.

Returns:
Relationship between the containing entity and the contained person or undefined for none

getValueString

String|undefined getValueString()

Returns the simple string value that can be used as a representation of this person. This attribute is optional.

Returns:
Simple string value that can be used as a representation of this person or undefined for none

setAttendeeStatus

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

Sets the event attendee status. This element is optional.

Parameters:
attendeeStatus - Event attendee status, or object to use as a parameter to the google.gdata.AttendeeStatus constructor, or undefined for none

setAttendeeType

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

Sets the event attendee type. This element is optional.

Parameters:
attendeeType - Event attendee type, or object to use as a parameter to the google.gdata.AttendeeType constructor, or undefined for none

setEmail

void setEmail(<String|undefined> email)

Sets the email address. This attribute is optional.

Parameters:
email - Email address or undefined for none

setEntryLink

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

Sets the nested person entry. This element is optional.

Parameters:
entryLink - Nested person entry, or object to use as a parameter to the google.gdata.EntryLink constructor, or undefined for none

setRel

void setRel(<String|undefined> rel)

Sets the relationship between the containing entity and the contained person. This attribute is optional.

Parameters:
rel - Relationship between the containing entity and the contained person or undefined for none

setValueString

void setValueString(<String|undefined> valueString)

Sets the simple string value that can be used as a representation of this person. This attribute is optional.

Parameters:
valueString - Simple string value that can be used as a representation of this person or undefined for none