Class com.gContactSync.Group

Defined in: Group.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	com.gContactSync.Group(aXml, aTitle) A class for storing and editing the XML feed for a Group in Google Contacts.

Method Summary
Method Attributes	Method Name and Description
	getEditURL() Returns the URL used to edit this Group.
	getExtendedProperty(aName) Returns the extended property of this group's XML whose value for the name attribute matches aName, if any.
	getID() Retrieves and returns the ID of this Group.
	getLastModifiedDate() Gets the last modified date from the group's XML feed in milliseconds since 1970
	getSystemId() Returns the ID of the gContact:systemGroup tag, if any.
	getTitle() Returns the title of this Group.
	isSystemGroup() Returns true if this group is one of Google's system groups.
	removeExtendedProperties() Removes all of the extended properties from this Group.
	setExtendedProperty(aName, aValue) Sets an extended property with the given name and value if there are less than 10 existing.
	setTitle(aTitle) Sets the title of this Group.

Class Detail

com.gContactSync.Group(aXml, aTitle)

A class for storing and editing the XML feed for a Group in Google Contacts.

Parameters:
aXml: {XML Element} The XML representation of the group. If not supplied then a new group is created.
aTitle: {string} The title for the group, if new.

Method Detail

{string} getEditURL()

Returns the URL used to edit this Group.

Returns:: {string} the URL used to edit this Group.

{string} getExtendedProperty(aName)

Returns the extended property of this group's XML whose value for the name attribute matches aName, if any.

Parameters:
aName: {string} The value of the name attribute to find.

Returns:: {string} The value of an extended property whose name is the value of aName.

{string} getID()

Retrieves and returns the ID of this Group.

Returns:: {string} The ID of this Group.

{int} getLastModifiedDate()

Gets the last modified date from the group's XML feed in milliseconds since 1970

Returns:: {int} The last modified date of the group in milliseconds since 1970.

{string} getSystemId()

Returns the ID of the gContact:systemGroup tag, if any.

Returns:: {string} The ID of the system group, if any.

{string} getTitle()

Returns the title of this Group. If this is a system group, which is NOT translated through the API, then this method will return a localized name for this group.

Returns:: {string} The title of this Group.

{boolean} isSystemGroup()

Returns true if this group is one of Google's system groups. These currently are: - My Contacts - Coworkers - Family - Friends

Returns:: {boolean} True if this group is a system group.

removeExtendedProperties()

Removes all of the extended properties from this Group.

setExtendedProperty(aName, aValue)

Sets an extended property with the given name and value if there are less than 10 existing. Logs a warning if there are already 10 or more and does not add the property.

Parameters:
aName: {string} The name of the property.
aValue: {string} The value of the property.

setTitle(aTitle)

Sets the title of this Group.

Parameters:
aTitle: The new title for this Group.

Classes

Class com.gContactSync.Group