Class Index | File Index

Classes


Class AC.data.Contribution

Represents a contribution.
Defined in: Utility.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Creates a new contribution from the specified message.
Method Summary
Method Attributes Method Name and Description
 
Gets the contribution's add-properties.
 
Gets an attribute's value from the message based on the specified attribute key.
 
Gets the contribution's time stamp.
 
Gets the contribution id.
 
Gets a property object, where a property's value is indexed by the property's key.
 
Gets the contribution's properties.
 
Gets an String with properties in format "{propertyKey:value, propertyKey:value}"
 
getProperty(propertyName)
Gets the contribution's property object based on the specified property key.
 
getPropertyValue(propertyName)
Gets the contribution's property value based on the specified property key.
 
Gets the contribution's relationships.
 
Gets the contribution's remove-properties.
 
Gets the contribution type.
 
Gets the contribution's update-properties.
 
Gets the contribution's user contents from the message and instantiates the user.
 
Gets the contribution's workspace contents from the message and instantiates the workspace.
Class Detail
AC.data.Contribution(msg)
Creates a new contribution from the specified message.
Parameters:
msg
a JSON message
Method Detail
getAddedProperties()
Gets the contribution's add-properties.
Returns:
the contribution's add-properties

getAttribute(key)
Gets an attribute's value from the message based on the specified attribute key.
Parameters:
{String} key
the key of the message attribute.
Returns:
the value of the message attribute

getFromDate()
Gets the contribution's time stamp.
Returns:
the contribution's time stamp

getId()
Gets the contribution id.
Returns:
the contribution id

getParsedProperties()
Gets a property object, where a property's value is indexed by the property's key.
Returns:
this contribution's properties wrapped as an object

getProperties()
Gets the contribution's properties.
Returns:
the contribution's properties

getPropertiesObject()
Gets an String with properties in format "{propertyKey:value, propertyKey:value}"
Returns:
a string that represents an object with all of the properties as elements

getProperty(propertyName)
Gets the contribution's property object based on the specified property key.
Parameters:
{String} propertyName
the name of the property
Returns:
the property object of the specified property

getPropertyValue(propertyName)
Gets the contribution's property value based on the specified property key.
Parameters:
{String} propertyName
the name of the property
Returns:
the value of the specified property

getRelationships()
Gets the contribution's relationships.
Returns:
the contribution's relationships

getRemovedProperties()
Gets the contribution's remove-properties.
Returns:
the contribution's remove-properties

getType()
Gets the contribution type.
Returns:
the contribution type

getUpdatedProperties()
Gets the contribution's update-properties.
Returns:
the contribution's update-properties

getUser()
Gets the contribution's user contents from the message and instantiates the user.
Returns:
the contribution's user

getWorkspace()
Gets the contribution's workspace contents from the message and instantiates the workspace.
Returns:
the contribution's workspace

Documentation generated by JsDoc Toolkit 2.0.0 on Sun Sep 23 2012 02:46:06 GMT-0500 (CDT)