You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@shindig.apache.org by li...@apache.org on 2010/09/15 03:40:15 UTC
svn commit: r997163 [33/37] - in
/shindig/trunk/features/src/main/javascript/features: caja/
com.google.gadgets.analytics/ container/ core.config/ core.io/ core.json/
core.legacy/ core.log/ core.prefs/ core.util/ dynamic-height.util/
dynamic-height/ fl...
Modified: shindig/trunk/features/src/main/javascript/features/opensocial-reference/activity.js
URL: http://svn.apache.org/viewvc/shindig/trunk/features/src/main/javascript/features/opensocial-reference/activity.js?rev=997163&r1=997162&r2=997163&view=diff
==============================================================================
--- shindig/trunk/features/src/main/javascript/features/opensocial-reference/activity.js (original)
+++ shindig/trunk/features/src/main/javascript/features/opensocial-reference/activity.js Wed Sep 15 01:39:49 2010
@@ -193,7 +193,7 @@ opensocial.Activity.Field = {
*
* @member opensocial.Activity.Field
*/
- TITLE_ID : 'titleId',
+ TITLE_ID: 'titleId',
/**
* <p>A string specifying the primary text of an activity.</p>
@@ -204,7 +204,7 @@ opensocial.Activity.Field = {
*
* @member opensocial.Activity.Field
*/
- TITLE : 'title',
+ TITLE: 'title',
/**
* <p>A map of custom keys to values associated with this activity.
@@ -225,14 +225,14 @@ opensocial.Activity.Field = {
*
* @member opensocial.Activity.Field
*/
- TEMPLATE_PARAMS : 'templateParams',
+ TEMPLATE_PARAMS: 'templateParams',
/**
* A string specifying the
* URL that represents this activity.
* @member opensocial.Activity.Field
*/
- URL : 'url',
+ URL: 'url',
/**
* Any photos, videos, or images that should be associated
@@ -241,7 +241,7 @@ opensocial.Activity.Field = {
* <a href="opensocial.MediaItem.html">MediaItem</a>></code>.
* @member opensocial.Activity.Field
*/
- MEDIA_ITEMS : 'mediaItems',
+ MEDIA_ITEMS: 'mediaItems',
/**
* <p>A string specifying the body template message ID in the gadget spec.</p>
@@ -254,7 +254,7 @@ opensocial.Activity.Field = {
*
* @member opensocial.Activity.Field
*/
- BODY_ID : 'bodyId',
+ BODY_ID: 'bodyId',
/**
* <p>A string specifying an optional expanded version of an activity.</p>
@@ -265,65 +265,65 @@ opensocial.Activity.Field = {
*
* @member opensocial.Activity.Field
*/
- BODY : 'body',
+ BODY: 'body',
/**
* An optional string ID generated by the posting application.
* @member opensocial.Activity.Field
*/
- EXTERNAL_ID : 'externalId',
+ EXTERNAL_ID: 'externalId',
/**
* A string specifing the title of the stream.
* @member opensocial.Activity.Field
*/
- STREAM_TITLE : 'streamTitle',
+ STREAM_TITLE: 'streamTitle',
/**
* A string specifying the stream's URL.
* @member opensocial.Activity.Field
*/
- STREAM_URL : 'streamUrl',
+ STREAM_URL: 'streamUrl',
/**
* A string specifying the stream's source URL.
* @member opensocial.Activity.Field
*/
- STREAM_SOURCE_URL : 'streamSourceUrl',
+ STREAM_SOURCE_URL: 'streamSourceUrl',
/**
* A string specifying the URL for the stream's favicon.
* @member opensocial.Activity.Field
*/
- STREAM_FAVICON_URL : 'streamFaviconUrl',
+ STREAM_FAVICON_URL: 'streamFaviconUrl',
/**
* A number between 0 and 1 representing the relative priority of
* this activity in relation to other activities from the same source
* @member opensocial.Activity.Field
*/
- PRIORITY : 'priority',
+ PRIORITY: 'priority',
/**
* A string ID that is permanently associated with this activity.
* This value can not be set.
* @member opensocial.Activity.Field
*/
- ID : 'id',
+ ID: 'id',
/**
* The string ID of the user who this activity is for.
* This value can not be set.
* @member opensocial.Activity.Field
*/
- USER_ID : 'userId',
+ USER_ID: 'userId',
/**
* A string specifying the application that this activity is associated with.
* This value can not be set.
* @member opensocial.Activity.Field
*/
- APP_ID : 'appId',
+ APP_ID: 'appId',
/**
* A string specifying the time at which this activity took place
@@ -331,14 +331,14 @@ opensocial.Activity.Field = {
* This value can not be set.
* @member opensocial.Activity.Field
*/
- POSTED_TIME : 'postedTime'
+ POSTED_TIME: 'postedTime'
};
/**
* Gets an ID that can be permanently associated with this activity.
*
- * @return {string} The ID
+ * @return {string} The ID.
* @member opensocial.Activity
*/
opensocial.Activity.prototype.getId = function() {
@@ -351,12 +351,12 @@ opensocial.Activity.prototype.getId = fu
*
* @param {string} key The key to get data for;
* see the <a href="opensocial.Activity.Field.html">Field</a> class
- * for possible values
+ * for possible values.
* @param {Object.<opensocial.DataRequest.DataRequestFields, Object>=}
* opt_params Additional
* <a href="opensocial.DataRequest.DataRequestFields.html">params</a>
* to pass to the request.
- * @return {string} The data
+ * @return {string} The data.
* @member opensocial.Activity
*/
opensocial.Activity.prototype.getField = function(key, opt_params) {
@@ -367,9 +367,9 @@ opensocial.Activity.prototype.getField =
/**
* Sets data for this activity associated with the given key.
*
- * @param {string} key The key to set data for
- * @param {string} data The data to set
+ * @param {string} key The key to set data for.
+ * @param {string} data The data to set.
*/
opensocial.Activity.prototype.setField = function(key, data) {
return (this.fields_[key] = data);
-};
\ No newline at end of file
+};
Modified: shindig/trunk/features/src/main/javascript/features/opensocial-reference/address.js
URL: http://svn.apache.org/viewvc/shindig/trunk/features/src/main/javascript/features/opensocial-reference/address.js?rev=997163&r1=997162&r2=997163&view=diff
==============================================================================
--- shindig/trunk/features/src/main/javascript/features/opensocial-reference/address.js (original)
+++ shindig/trunk/features/src/main/javascript/features/opensocial-reference/address.js Wed Sep 15 01:39:49 2010
@@ -58,7 +58,7 @@ opensocial.Address.Field = {
*
* @member opensocial.Address.Field
*/
- TYPE : 'type',
+ TYPE: 'type',
/**
* If the container does not have structured addresses in its data store,
@@ -68,70 +68,70 @@ opensocial.Address.Field = {
*
* @member opensocial.Address.Field
*/
- UNSTRUCTURED_ADDRESS : 'unstructuredAddress',
+ UNSTRUCTURED_ADDRESS: 'unstructuredAddress',
/**
* The po box of the address if there is one. Specified as a String.
*
* @member opensocial.Address.Field
*/
- PO_BOX : 'poBox',
+ PO_BOX: 'poBox',
/**
* The street address. Specified as a String.
*
* @member opensocial.Address.Field
*/
- STREET_ADDRESS : 'streetAddress',
+ STREET_ADDRESS: 'streetAddress',
/**
* The extended street address. Specified as a String.
*
* @member opensocial.Address.Field
*/
- EXTENDED_ADDRESS : 'extendedAddress',
+ EXTENDED_ADDRESS: 'extendedAddress',
/**
* The region. Specified as a String.
*
* @member opensocial.Address.Field
*/
- REGION : 'region',
+ REGION: 'region',
/**
* The locality. Specified as a String.
*
* @member opensocial.Address.Field
*/
- LOCALITY : 'locality',
+ LOCALITY: 'locality',
/**
* The postal code. Specified as a String.
*
* @member opensocial.Address.Field
*/
- POSTAL_CODE : 'postalCode',
+ POSTAL_CODE: 'postalCode',
/**
* The country. Specified as a String.
*
* @member opensocial.Address.Field
*/
- COUNTRY : 'country',
+ COUNTRY: 'country',
/**
* The latitude. Specified as a Number.
*
* @member opensocial.Address.Field
*/
- LATITUDE : 'latitude',
+ LATITUDE: 'latitude',
/**
* The longitude. Specified as a Number.
*
* @member opensocial.Address.Field
*/
- LONGITUDE : 'longitude'
+ LONGITUDE: 'longitude'
};
@@ -144,8 +144,8 @@ opensocial.Address.Field = {
* @param {Object.<opensocial.DataRequest.DataRequestFields, Object>}
* opt_params Additional
* <a href="opensocial.DataRequest.DataRequestFields.html">params</a>
- * to pass to the request
- * @return {string} The data
+ * to pass to the request.
+ * @return {string} The data.
*/
opensocial.Address.prototype.getField = function(key, opt_params) {
return opensocial.Container.getField(this.fields_, key, opt_params);
Modified: shindig/trunk/features/src/main/javascript/features/opensocial-reference/album.js
URL: http://svn.apache.org/viewvc/shindig/trunk/features/src/main/javascript/features/opensocial-reference/album.js?rev=997163&r1=997162&r2=997163&view=diff
==============================================================================
--- shindig/trunk/features/src/main/javascript/features/opensocial-reference/album.js (original)
+++ shindig/trunk/features/src/main/javascript/features/opensocial-reference/album.js Wed Sep 15 01:39:49 2010
@@ -32,7 +32,7 @@
* @name opensocial.Album
*/
- /**
+/**
* Base interface for collection of media items.
*
* @param {Object.<opensocial.Album.Field, Object>=} opt_params
@@ -58,63 +58,63 @@ opensocial.Album.Field = {
*
* @member opensocial.Album.Field
*/
- DESCRIPTION : 'description',
-
+ DESCRIPTION: 'description',
+
/**
* A unique identifier for the album.
*
* @member opensocial.Album.Field
*/
- ID : 'id',
+ ID: 'id',
/**
* A location corresponding to the album as opensocial.Address.
*
* @member opensocial.Album.Field
*/
- LOCATION : 'location',
+ LOCATION: 'location',
/*
* The number of items in the album.
*
* @member opensocial.Album.Field
*/
- MEDIA_ITEM_COUNT : 'mediaITemCount',
+ MEDIA_ITEM_COUNT: 'mediaITemCount',
/*
* The types of MediaItems in the Album.
*
* @member opensocial.Album.Field
*/
- MEDIA_MIME_TYPE : 'MEDIA_MIME_TYPE',
+ MEDIA_MIME_TYPE: 'MEDIA_MIME_TYPE',
/*
* The types of MediaItems in the album.
*
* @member opensocial.Album.Field
*/
- MEDIA_TYPE : 'MEDIA_TYPE',
+ MEDIA_TYPE: 'MEDIA_TYPE',
/*
* The string ID of the owner of the album.
*
* @member opensocial.Album.Field
*/
- OWNER_ID : 'ownerId',
+ OWNER_ID: 'ownerId',
/**
* URL to a thumbnail cover of the album as string.
*
* @member opensocial.Album.Field
*/
- THUMBNAIL_URL : 'thumbnailUrl',
+ THUMBNAIL_URL: 'thumbnailUrl',
/**
* The title of the album.
*
* @member opensocial.Album.Field
*/
- TITLE : 'title'
+ TITLE: 'title'
};
/**
@@ -122,12 +122,12 @@ opensocial.Album.Field = {
*
* @param {string} key The key to get data for;
* see the <a href="opensocial.Album.Field.html">Field</a> class
- * for possible values
+ * for possible values.
* @param {Object.<opensocial.DataRequest.DataRequestFields, Object>}
* opt_params Additional
* <a href="opensocial.DataRequest.DataRequestFields.html">params</a>
* to pass to the request.
- * @return {string} The data
+ * @return {string} The data.
* @member opensocial.Album
*/
opensocial.Album.prototype.getField = function(key, opt_params) {
@@ -138,8 +138,8 @@ opensocial.Album.prototype.getField = fu
/**
* Sets data for this album associated with the given key.
*
- * @param {string} key The key to set data for
- * @param {string} data The data to set
+ * @param {string} key The key to set data for.
+ * @param {string} data The data to set.
*/
opensocial.Album.prototype.setField = function(key, data) {
return this.fields_[key] = data;
Modified: shindig/trunk/features/src/main/javascript/features/opensocial-reference/bodytype.js
URL: http://svn.apache.org/viewvc/shindig/trunk/features/src/main/javascript/features/opensocial-reference/bodytype.js?rev=997163&r1=997162&r2=997163&view=diff
==============================================================================
--- shindig/trunk/features/src/main/javascript/features/opensocial-reference/bodytype.js (original)
+++ shindig/trunk/features/src/main/javascript/features/opensocial-reference/bodytype.js Wed Sep 15 01:39:49 2010
@@ -58,35 +58,35 @@ opensocial.BodyType.Field = {
* Not supported by all containers.
* @member opensocial.BodyType.Field
*/
- BUILD : 'build',
+ BUILD: 'build',
/**
* The height of the person in meters, specified as a number.
* Not supported by all containers.
* @member opensocial.BodyType.Field
*/
- HEIGHT : 'height',
+ HEIGHT: 'height',
/**
* The weight of the person in kilograms, specified as a number.
* Not supported by all containers.
* @member opensocial.BodyType.Field
*/
- WEIGHT : 'weight',
+ WEIGHT: 'weight',
/**
* The eye color of the person, specified as a string.
* Not supported by all containers.
* @member opensocial.BodyType.Field
*/
- EYE_COLOR : 'eyeColor',
+ EYE_COLOR: 'eyeColor',
/**
* The hair color of the person, specified as a string.
* Not supported by all containers.
* @member opensocial.BodyType.Field
*/
- HAIR_COLOR : 'hairColor'
+ HAIR_COLOR: 'hairColor'
};
@@ -100,7 +100,7 @@ opensocial.BodyType.Field = {
* opt_params Additional
* <a href="opensocial.DataRequest.DataRequestFields.html">params</a>
* to pass to the request.
- * @return {string} The data
+ * @return {string} The data.
*/
opensocial.BodyType.prototype.getField = function(key, opt_params) {
return opensocial.Container.getField(this.fields_, key, opt_params);
Modified: shindig/trunk/features/src/main/javascript/features/opensocial-reference/collection.js
URL: http://svn.apache.org/viewvc/shindig/trunk/features/src/main/javascript/features/opensocial-reference/collection.js?rev=997163&r1=997162&r2=997163&view=diff
==============================================================================
--- shindig/trunk/features/src/main/javascript/features/opensocial-reference/collection.js (original)
+++ shindig/trunk/features/src/main/javascript/features/opensocial-reference/collection.js Wed Sep 15 01:39:49 2010
@@ -56,11 +56,11 @@ opensocial.Collection = function(array,
/**
* Finds the entry with the given ID value, or returns null if none is found.
- * @param {string} id The ID to look for
- * @return {?Object} The data
+ * @param {string} id The ID to look for.
+ * @return {?Object} The data.
*/
opensocial.Collection.prototype.getById = function(id) {
- // TODO(doll): A non-linear search would be better
+ // TODO(doll): A non-linear search would be better
for (var i = 0; i < this.size(); i++) {
var item = this.array_[i];
if (item.getId() === id) {
@@ -77,7 +77,7 @@ opensocial.Collection.prototype.getById
* which is equal to or less than the
* total size of the result.
*
- * @return {number} The size of this collection
+ * @return {number} The size of this collection.
*/
opensocial.Collection.prototype.size = function() {
return this.array_.length;
@@ -89,7 +89,7 @@ opensocial.Collection.prototype.size = f
* with each member in turn as the
* parameter to the function.
*
- * @param {function(Object)} fn The function to call with each collection entry
+ * @param {function(Object)} fn The function to call with each collection entry.
*/
opensocial.Collection.prototype.each = function(fn) {
for (var i = 0; i < this.size(); i++) {
@@ -100,7 +100,7 @@ opensocial.Collection.prototype.each = f
/**
* Returns an array of all the objects in this collection.
- * @return {Array.<Object>} The values in this collection
+ * @return {Array.<Object>} The values in this collection.
*/
opensocial.Collection.prototype.asArray = function() {
return this.array_;
@@ -110,7 +110,7 @@ opensocial.Collection.prototype.asArray
/**
* Gets the total size of the larger result set
* that this collection belongs to.
- * @return {number} The total size of the result
+ * @return {number} The total size of the result.
*/
opensocial.Collection.prototype.getTotalSize = function() {
return this.totalSize_;
@@ -119,7 +119,7 @@ opensocial.Collection.prototype.getTotal
/**
* Gets the offset of this collection within a larger result set.
- * @return {number} The offset into the total collection
+ * @return {number} The offset into the total collection.
*/
opensocial.Collection.prototype.getOffset = function() {
return this.offset_;
Modified: shindig/trunk/features/src/main/javascript/features/opensocial-reference/container.js
URL: http://svn.apache.org/viewvc/shindig/trunk/features/src/main/javascript/features/opensocial-reference/container.js?rev=997163&r1=997162&r2=997163&view=diff
==============================================================================
--- shindig/trunk/features/src/main/javascript/features/opensocial-reference/container.js (original)
+++ shindig/trunk/features/src/main/javascript/features/opensocial-reference/container.js Wed Sep 15 01:39:49 2010
@@ -34,7 +34,7 @@ opensocial.Container = function() {};
/**
* The container instance.
*
- * @type Container
+ * @type {Container}
* @private
*/
opensocial.Container.container_ = null;
@@ -43,7 +43,7 @@ opensocial.Container.container_ = null;
/**
* Set the current container object.
*
- * @param {opensocial.Container} container The container
+ * @param {opensocial.Container} container The container.
* @private
*/
opensocial.Container.setContainer = function(container) {
@@ -54,7 +54,7 @@ opensocial.Container.setContainer = func
/**
* Get the current container object.
*
- * @return {opensocial.Container} container The current container
+ * @return {opensocial.Container} container The current container.
* @private
*/
opensocial.Container.get = function() {
@@ -67,7 +67,7 @@ opensocial.Container.get = function() {
* query things like what profile fields and surfaces are supported by this
* container, what parameters were passed to the current gadget and so forth.
*
- * @return {opensocial.Environment} The current environment
+ * @return {opensocial.Environment} The current environment.
*
* @private
*/
@@ -81,7 +81,7 @@ opensocial.Container.prototype.getEnviro
*
* @param {Array.<string> | string} recipients An ID, array of IDs, or a
* group reference; the supported keys are VIEWER, OWNER, VIEWER_FRIENDS,
- * OWNER_FRIENDS, or a single ID within one of those groups
+ * OWNER_FRIENDS, or a single ID within one of those groups.
* @param {opensocial.Message} message The message to send to the specified
* users.
* @param {function(opensocial.ResponseItem)=} opt_callback The function to call once the request has been
@@ -92,15 +92,15 @@ opensocial.Container.prototype.getEnviro
* message was sent. If there was an error, you can use the response item's
* getErrorCode method to determine how to proceed. The data on the response
* item will not be set.
- * @param {Object=} opt_params TODO
+ * @param {Object=} opt_params TODO.
*
* @member opensocial
* @private
*/
opensocial.Container.prototype.requestSendMessage = function(recipients,
message, opt_callback, opt_params) {
- gadgets.rpc.call(null, "requestSendMessage", opt_callback, recipients,
- message, opt_callback, opt_params);
+ gadgets.rpc.call(null, 'requestSendMessage', opt_callback, recipients,
+ message, opt_callback, opt_params);
};
@@ -112,7 +112,7 @@ opensocial.Container.prototype.requestSe
*
* @param {Array.<string> | string} recipients An ID, array of IDs, or a
* group reference; the supported keys are VIEWER, OWNER, VIEWER_FRIENDS,
- * OWNER_FRIENDS, or a single ID within one of those groups
+ * OWNER_FRIENDS, or a single ID within one of those groups.
* @param {opensocial.Message} reason The reason the user wants the gadget to
* share itself. This reason can be used by the container when prompting the
* user for permission to share the app. It may also be ignored.
@@ -124,7 +124,7 @@ opensocial.Container.prototype.requestSe
* sharing request was sent. If there was an error, you can use the response
* item's getErrorCode method to determine how to proceed. The data on the
* response item will not be set.
- * @param {Object=} opt_params TODO
+ * @param {Object=} opt_params TODO.
*
* @member opensocial
* @private
@@ -169,7 +169,7 @@ opensocial.Container.prototype.requestCr
* Returns whether the current gadget has access to the specified
* permission.
*
- * @param {opensocial.Permission | string} permission The permission
+ * @param {opensocial.Permission | string} permission The permission.
* @return {boolean} Whether the gadget has access for the permission.
*
* @private
@@ -183,19 +183,19 @@ opensocial.Container.prototype.hasPermis
* Requests the user grants access to the specified permissions.
*
* @param {Array.<opensocial.Permission>} permissions The permissions to request
- * access to from the viewer
+ * access to from the viewer.
* @param {string} reason Will be displayed to the user as the reason why these
* permissions are needed.
* @param {function(opensocial.ResponseItem)=} opt_callback The function to call once the request has been
* processed. This callback will either be called or the gadget will be
- * reloaded from scratch
+ * reloaded from scratch.
*
* @private
*/
opensocial.Container.prototype.requestPermission = function(permissions, reason,
opt_callback) {
if (opt_callback) {
- window.setTimeout(function () {
+ window.setTimeout(function() {
opt_callback(new opensocial.ResponseItem(
null, null, opensocial.ResponseItem.Error.NOT_IMPLEMENTED, null));
}, 0);
@@ -208,8 +208,8 @@ opensocial.Container.prototype.requestPe
* asked for in the dataRequest object.
*
* @param {opensocial.DataRequest} dataRequest Specifies which data to get from
- * the server
- * @param {function(opensocial.ResponseItem)} callback Function to call after the data is fetched
+ * the server.
+ * @param {function(opensocial.ResponseItem)} callback Function to call after the data is fetched.
* @private
*/
opensocial.Container.prototype.requestData = function(dataRequest, callback) {};
@@ -221,7 +221,7 @@ opensocial.Container.prototype.requestDa
* @param {opensocial.IdSpec} idSpec The ID of the used to specify which people/groups
* to create an album for.
* @param {opensocial.Album} album The album to create.
- * @return {Object} A request object
+ * @return {Object} A request object.
* @private
*/
opensocial.Container.prototype.newCreateAlbumRequest = function(idSpec, album) {};
@@ -233,7 +233,7 @@ opensocial.Container.prototype.newCreate
* to create an album for.
* @param {string} albumId The ID of album to add the media item to.
* @param {openSocial.MediaItem} mediaItem The media item instance to add to the album.
- * @return {Object} A request object
+ * @return {Object} A request object.
* @private
*/
opensocial.Container.prototype.newCreateMediaItemRequest = function(idSpec, albumId,
@@ -245,7 +245,7 @@ opensocial.Container.prototype.newCreate
* @param {opensocial.IdSpec} idSpec The ID of the used to specify which people/groups
* to create an album for.
* @param {string} albumId The ID of the album to create.
- * @return {Object} A request object
+ * @return {Object} A request object.
* @private
*/
opensocial.Container.prototype.newDeleteAlbumRequest = function(idSpec, albumId) {};
@@ -259,7 +259,7 @@ opensocial.Container.prototype.newDelete
* @param {Object.<opensocial.DataRequest.PeopleRequestFields, Object>=} opt_params
* Additional params to pass to the request. This request supports
* PROFILE_DETAILS.
- * @return {Object} a request object
+ * @return {Object} a request object.
* @private
*/
opensocial.Container.prototype.newFetchPersonRequest = function(id,
@@ -275,7 +275,7 @@ opensocial.Container.prototype.newFetchP
* @param {Object.<opensocial.DataRequest.PeopleRequestFields, Object>=} opt_params
* Additional params to pass to the request. This request supports
* PROFILE_DETAILS, SORT_ORDER, FILTER, FILTER_OPTIONS, FIRST, and MAX.
- * @return {Object} a request object
+ * @return {Object} a request object.
* @private
*/
opensocial.Container.prototype.newFetchPeopleRequest = function(idSpec,
@@ -295,8 +295,8 @@ opensocial.Container.prototype.newFetchP
* @param {Object.<opensocial.DataRequest.DataRequestFields, Object>}
* opt_params Additional
* <a href="opensocial.DataRequest.DataRequestFields.html">params</a>
- * to pass to the request
- * @return {Object} a request object
+ * to pass to the request.
+ * @return {Object} a request object.
* @private
*/
opensocial.Container.prototype.newFetchPersonAppDataRequest = function(idSpec,
@@ -310,9 +310,9 @@ opensocial.Container.prototype.newFetchP
* person, per application. Containers supporting this request SHOULD provide
* at least 10KB of space per user per application for this data.
*
- * @param {string} key The name of the key
- * @param {string} value The value
- * @return {Object} a request object
+ * @param {string} key The name of the key.
+ * @param {string} value The value.
+ * @return {Object} a request object.
* @private
*/
opensocial.Container.prototype.newUpdatePersonAppDataRequest = function(
@@ -325,8 +325,8 @@ opensocial.Container.prototype.newUpdate
*
* @param {Array.<string> | string} keys The keys you want to delete from
* the datastore; this can be an array of key names, a single key name,
- * or "*" to mean "all keys"
- * @return {Object} A request object
+ * or "*" to mean "all keys".
+ * @return {Object} A request object.
* @private
*/
opensocial.Container.prototype.newRemovePersonAppDataRequest = function(
@@ -340,7 +340,7 @@ opensocial.Container.prototype.newRemove
* to own the album.
* @param {string} albumId The ID of album to update.
* @param {Object.<opensocial.Album.Field, Object>=} opt_params The album fields to update.
- * @return {Object} A request object
+ * @return {Object} A request object.
*/
opensocial.Container.prototype.newUpdateAlbumRequest = function(idSpec, albumId, opt_params) {};
@@ -353,7 +353,7 @@ opensocial.Container.prototype.newUpdate
* @param {string} albumId The ID of the album containing the media item to update.
* @param {string} mediaItemId ID of media item to update.
* @param {Object.<opensocial.MediaItem.Field, Object>=} opt_params The media item fields to update.
- * @return {Object} A request object
+ * @return {Object} A request object.
*/
opensocial.Container.prototype.newUpdateMediaItemRequest = function(idSpec, albumId,
mediaItemId, opt_params) {};
@@ -367,7 +367,7 @@ opensocial.Container.prototype.newUpdate
* fetch. See also <a href="opensocial.IdSpec.html">IdSpec</a>.
* @param {Object.<opensocial.DataRequest.ActivityRequestFields, Object>=} opt_params
* Additional params to pass to the request.
- * @return {Object} a request object
+ * @return {Object} a request object.
* @private
*/
opensocial.Container.prototype.newFetchActivitiesRequest = function(idSpec,
@@ -380,7 +380,7 @@ opensocial.Container.prototype.newFetchM
/**
* Creates a new collection with caja support if enabled.
- * @return {opensocial.Collection} the collection object
+ * @return {opensocial.Collection} the collection object.
* @private
*/
opensocial.Container.prototype.newCollection = function(array, opt_offset,
@@ -391,7 +391,7 @@ opensocial.Container.prototype.newCollec
/**
* Creates a new person with caja support if enabled.
- * @return {opensocial.Person} the person object
+ * @return {opensocial.Person} the person object.
* @private
*/
opensocial.Container.prototype.newPerson = function(opt_params, opt_isOwner,
@@ -406,7 +406,7 @@ opensocial.Container.prototype.newPerson
* @param {Object.<opensocial.Activity.Field, Object>=} opt_params Any other
* fields that should be set on the activity object. All of the defined
* Fields are supported.
- * @return {opensocial.Activity} the activity object
+ * @return {opensocial.Activity} the activity object.
* @private
*/
opensocial.Container.prototype.newActivity = function(opt_params) {
@@ -421,9 +421,9 @@ opensocial.Container.prototype.newActivi
* Any other fields that should be set on the album object;
* all of the defined
* <a href="opensocial.Album.Field.html">Field</a>s
- * are supported
+ * are supported.
*
- * @return {opensocial.Album} the album object
+ * @return {opensocial.Album} the album object.
* @private
*/
opensocial.Container.prototype.newAlbum = function(opt_params) {
@@ -435,13 +435,13 @@ opensocial.Container.prototype.newAlbum
* Creates a media item. Represents images, movies, and audio.
* Used when creating activities on the server.
*
- * @param {string} mimeType of the media
- * @param {string} url where the media can be found
+ * @param {string} mimeType of the media.
+ * @param {string} url where the media can be found.
* @param {Object.<opensocial.MediaItem.Field, Object>=} opt_params
* Any other fields that should be set on the media item object.
* All of the defined Fields are supported.
*
- * @return {opensocial.MediaItem} the media item object
+ * @return {opensocial.MediaItem} the media item object.
* @private
*/
opensocial.Container.prototype.newMediaItem = function(mimeType, url,
@@ -460,10 +460,10 @@ opensocial.Container.prototype.newMediaI
* Any other fields that should be set on the message object;
* all of the defined
* <a href="opensocial.Message.Field.html">Field</a>s
- * are supported
+ * are supported.
*
* @return {opensocial.Message} The new
- * <a href="opensocial.Message.html">message</a> object
+ * <a href="opensocial.Message.html">message</a> object.
* @private
*/
opensocial.Container.prototype.newMessage = function(body, opt_params) {
@@ -477,7 +477,7 @@ opensocial.Container.prototype.newMessag
* @param {Object.<opensocial.IdSpec.Field, Object>} params
* Parameters defining the id spec.
* @return {opensocial.IdSpec} The new
- * <a href="opensocial.IdSpec.html">IdSpec</a> object
+ * <a href="opensocial.IdSpec.html">IdSpec</a> object.
* @private
*/
opensocial.Container.prototype.newIdSpec = function(params) {
@@ -489,10 +489,10 @@ opensocial.Container.prototype.newIdSpec
* Creates a NavigationParameters object.
*
* @param {Object.<opensocial.NavigationParameters.Field, Object>} params
- * Parameters defining the navigation
+ * Parameters defining the navigation.
* @return {opensocial.NavigationParameters} The new
* <a href="opensocial.NavigationParameters.html">NavigationParameters</a>
- * object
+ * object.
* @private
*/
opensocial.Container.prototype.newNavigationParameters = function(params) {
@@ -502,7 +502,7 @@ opensocial.Container.prototype.newNaviga
/**
* Creates a new response item with caja support if enabled.
- * @return {opensocial.ResponseItem} the response item object
+ * @return {opensocial.ResponseItem} the response item object.
* @private
*/
opensocial.Container.prototype.newResponseItem = function(originalDataRequest,
@@ -514,7 +514,7 @@ opensocial.Container.prototype.newRespon
/**
* Creates a new data response with caja support if enabled.
- * @return {opensocial.DataResponse} the data response object
+ * @return {opensocial.DataResponse} the data response object.
* @private
*/
opensocial.Container.prototype.newDataResponse = function(responseItems,
@@ -527,7 +527,7 @@ opensocial.Container.prototype.newDataRe
* Get a data request object to use for sending and fetching data from the
* server.
*
- * @return {opensocial.DataRequest} the request object
+ * @return {opensocial.DataRequest} the request object.
* @private
*/
opensocial.Container.prototype.newDataRequest = function() {
@@ -538,7 +538,7 @@ opensocial.Container.prototype.newDataRe
/**
* Get a new environment object.
*
- * @return {opensocial.Environment} the environment object
+ * @return {opensocial.Environment} the environment object.
* @private
*/
opensocial.Container.prototype.newEnvironment = function(domain,
@@ -554,8 +554,8 @@ opensocial.Container.prototype.invalidat
/**
* Returns true if the specified value is an array
- * @param {Object} val Variable to test
- * @return {boolean} Whether variable is an array
+ * @param {Object} val Variable to test.
+ * @return {boolean} Whether variable is an array.
* @private
*/
opensocial.Container.isArray = function(val) {
@@ -572,7 +572,7 @@ opensocial.Container.isArray = function(
* opt_params Additional
* <a href="opensocial.DataRequest.DataRequestFields.html">params</a>
* to pass to the request.
- * @return {string} The data
+ * @return {string} The data.
* @private
*/
opensocial.Container.getField = function(fields, key, opt_params) {
Modified: shindig/trunk/features/src/main/javascript/features/opensocial-reference/datarequest.js
URL: http://svn.apache.org/viewvc/shindig/trunk/features/src/main/javascript/features/opensocial-reference/datarequest.js?rev=997163&r1=997162&r2=997163&view=diff
==============================================================================
--- shindig/trunk/features/src/main/javascript/features/opensocial-reference/datarequest.js (original)
+++ shindig/trunk/features/src/main/javascript/features/opensocial-reference/datarequest.js Wed Sep 15 01:39:49 2010
@@ -110,8 +110,8 @@ opensocial.DataRequest.prototype.getRequ
* starting with the item that was added first.
* However, items that can't collide might be executed in parallel.
*
- * @param {Object} request Specifies which data to fetch or update
- * @param {string} opt_key A key to map the generated response data to
+ * @param {Object} request Specifies which data to fetch or update.
+ * @param {string} opt_key A key to map the generated response data to.
*/
opensocial.DataRequest.prototype.add = function(request, opt_key) {
return this.requestObjects_.push({'key': opt_key, 'request': request});
@@ -126,10 +126,10 @@ opensocial.DataRequest.prototype.add = f
*
* @param {function(opensocial.ResponseItem)=} opt_callback The function to call with the
* <a href="opensocial.DataResponse.html">data response</a>
- * generated by the server
+ * generated by the server.
*/
opensocial.DataRequest.prototype.send = function(opt_callback) {
- var callback = opt_callback || function(){};
+ var callback = opt_callback || function() {};
opensocial.Container.get().requestData(this, callback);
};
@@ -146,13 +146,13 @@ opensocial.DataRequest.SortOrder = {
* When used will sort people by the container's definition of top friends.
* @member opensocial.DataRequest.SortOrder
*/
- TOP_FRIENDS : 'topFriends',
+ TOP_FRIENDS: 'topFriends',
/**
* When used will sort people alphabetically by the name field.
*
* @member opensocial.DataRequest.SortOrder
*/
- NAME : 'name'
+ NAME: 'name'
};
@@ -169,19 +169,19 @@ opensocial.DataRequest.FilterType = {
*
* @member opensocial.DataRequest.FilterType
*/
- ALL : 'all',
+ ALL: 'all',
/**
* Retrieves all friends with any data for this application.
*
* @member opensocial.DataRequest.FilterType
*/
- HAS_APP : 'hasApp',
+ HAS_APP: 'hasApp',
/**
* Retrieves only the user's top friends.
*
* @member opensocial.DataRequest.FilterType
*/
- TOP_FRIENDS : 'topFriends',
+ TOP_FRIENDS: 'topFriends',
/**
* Will filter the people requested by checking if they are friends with
* the given <a href="opensocial.IdSpec.html">idSpec</a>. Expects a
@@ -210,7 +210,7 @@ opensocial.DataRequest.PeopleRequestFiel
*
* @member opensocial.DataRequest.PeopleRequestFields
*/
- PROFILE_DETAILS : 'profileDetail',
+ PROFILE_DETAILS: 'profileDetail',
/**
* A sort order for the people objects; defaults to TOP_FRIENDS.
@@ -219,7 +219,7 @@ opensocial.DataRequest.PeopleRequestFiel
*
* @member opensocial.DataRequest.PeopleRequestFields
*/
- SORT_ORDER : 'sortOrder',
+ SORT_ORDER: 'sortOrder',
/**
* How to filter the people objects; defaults to ALL.
@@ -228,7 +228,7 @@ opensocial.DataRequest.PeopleRequestFiel
*
* @member opensocial.DataRequest.PeopleRequestFields
*/
- FILTER : 'filter',
+ FILTER: 'filter',
/**
* Additional options to be passed into the filter,
@@ -244,7 +244,7 @@ opensocial.DataRequest.PeopleRequestFiel
*
* @member opensocial.DataRequest.PeopleRequestFields
*/
- FIRST : 'first',
+ FIRST: 'first',
/**
* The maximum number of items to fetch; defaults to 20. If set to a larger
@@ -254,7 +254,7 @@ opensocial.DataRequest.PeopleRequestFiel
*
* @member opensocial.DataRequest.PeopleRequestFields
*/
- MAX : 'max',
+ MAX: 'max',
/**
* A string or array of strings, specifying the app data keys to fetch for
@@ -262,7 +262,7 @@ opensocial.DataRequest.PeopleRequestFiel
* the string 'appData'. Pass the string '*' to fetch all app data keys.
* @member opensocial.DataRequest.PeopleRequestFields
*/
- APP_DATA : 'appData',
+ APP_DATA: 'appData',
/**
* How to escape app data returned from the server;
@@ -271,7 +271,7 @@ opensocial.DataRequest.PeopleRequestFiel
* This field may be used interchangeably with the string 'escapeType'.
* @member opensocial.DataRequest.PeopleRequestFields
*/
- ESCAPE_TYPE : 'escapeType'
+ ESCAPE_TYPE: 'escapeType'
};
@@ -279,7 +279,7 @@ opensocial.DataRequest.PeopleRequestFiel
* If the named param does not exist sets it to the default value.
*
* @param {Object.<string,Object>} params Parameter map.
- * @param {string} name of the param to check
+ * @param {string} name of the param to check.
* @param {*} defaultValue The value to set if the param does not exist.
* @private
*/
@@ -325,7 +325,7 @@ opensocial.DataRequest.prototype.asArray
* @param {opensocial.IdSpec} idSpec The ID of the used to specify which people/groups
* to create an album for.
* @param {opensocial.Album} album The album to create.
- * @return {Object} A request object
+ * @return {Object} A request object.
*/
opensocial.DataRequest.prototype.newCreateAlbumRequest = function(idSpec, album) {
return opensocial.Container.get().newCreateAlbumRequest(idSpec, album);
@@ -338,11 +338,11 @@ opensocial.DataRequest.prototype.newCrea
* to create an album for.
* @param {string} albumId The ID of album to add the media item to.
* @param {openSocial.MediaItem} mediaItem The MediaItem to add to the album.
- * @return {Object} A request object
+ * @return {Object} A request object.
*/
opensocial.DataRequest.prototype.newCreateMediaItemRequest = function(idSpec, albumId,
mediaItem) {
- return opensocial.Container.get().newCreateMediaItemRequest(idSpec, albumId, mediaItem)
+ return opensocial.Container.get().newCreateMediaItemRequest(idSpec, albumId, mediaItem);
};
/**
@@ -351,7 +351,7 @@ opensocial.DataRequest.prototype.newCrea
* @param {opensocial.IdSpec} idSpec The ID of the used to specify which people/groups
* to create an album for.
* @param {string} albumId The ID of the album to create.
- * @return {Object} A request object
+ * @return {Object} A request object.
*/
opensocial.DataRequest.prototype.newDeleteAlbumRequest = function(idSpec, albumId) {
return opensocial.Container.get().newDeleteAlbumRequest(idSpec, albumId);
@@ -364,12 +364,12 @@ opensocial.DataRequest.prototype.newDele
*
* @param {string} id The ID of the person to fetch; can be the standard
* <a href="opensocial.IdSpec.PersonId.html">person ID</a>
- * of VIEWER or OWNER
+ * of VIEWER or OWNER.
* @param {Object.<opensocial.DataRequest.PeopleRequestFields, Object>=} opt_params
* Additional
* <a href="opensocial.DataRequest.PeopleRequestFields.html">parameters</a>
- * to pass to the request; this request supports PROFILE_DETAILS
- * @return {Object} A request object
+ * to pass to the request; this request supports PROFILE_DETAILS.
+ * @return {Object} A request object.
*/
opensocial.DataRequest.prototype.newFetchPersonRequest = function(id,
opt_params) {
@@ -390,8 +390,8 @@ opensocial.DataRequest.prototype.newFetc
* @param {Object.<opensocial.DataRequest.PeopleRequestFields, Object>=} opt_params
* Additional
* <a href="opensocial.DataRequest.PeopleRequestFields.html">params</a>
- * to pass to the request
- * @return {Object} A request object
+ * to pass to the request.
+ * @return {Object} A request object.
*/
opensocial.DataRequest.prototype.newFetchPeopleRequest = function(idSpec,
opt_params) {
@@ -427,7 +427,7 @@ opensocial.DataRequest.AlbumRequestField
*
* @member opensocial.DataRequest.AlbumRequestFields
*/
- FIRST : 'first',
+ FIRST: 'first',
/**
* The maximum number of items to fetch; defaults to 20.
@@ -435,7 +435,7 @@ opensocial.DataRequest.AlbumRequestField
*
* @member opensocial.DataRequest.AlbumRequestFields
*/
- MAX : 'max'
+ MAX: 'max'
};
/**
@@ -456,7 +456,7 @@ opensocial.DataRequest.DataRequestFields
* @deprecated
* @member opensocial.DataRequest.DataRequestFields
*/
- ESCAPE_TYPE : 'escapeType'
+ ESCAPE_TYPE: 'escapeType'
};
@@ -475,12 +475,12 @@ opensocial.DataRequest.DataRequestFields
* fetch. See also <a href="opensocial.IdSpec.html">IdSpec</a>.
* @param {Array.<string> | string} keys The keys you want data for; this
* can be an array of key names, a single key name, or "*" to mean
- * "all keys"
- * @param {Object.<opensocial.DataRequest.DataRequestFields, Object>=} opt_params
+ * "all keys".
+ * @param {Object.<opensocial.DataRequest.DataRequestFields, Object>=} opt_params
* Additional
* <a href="opensocial.DataRequest.DataRequestFields.html">params</a>
- * to pass to the request
- * @return {Object} A request object
+ * to pass to the request.
+ * @return {Object} A request object.
*/
opensocial.DataRequest.prototype.newFetchPersonAppDataRequest = function(idSpec,
keys, opt_params) {
@@ -496,7 +496,7 @@ opensocial.DataRequest.prototype.newFetc
* to own the album.
* @param {string} albumId The ID of album to update.
* @param {Object.<opensocial.Album.Field, Object>=} opt_params The Album Fields to update.
- * @return {Object} A request object
+ * @return {Object} A request object.
*/
opensocial.DataRequest.prototype.newUpdateAlbumRequest = function(idSpec, albumId,
opt_params) {
@@ -512,7 +512,7 @@ opensocial.DataRequest.prototype.newUpda
* @param {string} albumId The ID of the album containing the media item to update.
* @param {string} mediaItemId ID of media item to update.
* @param {Object.<opensocial.MediaItem.Field, Object>=} opt_params The Album Fields to update.
- * @return {Object} A request object
+ * @return {Object} A request object.
*/
opensocial.DataRequest.prototype.newUpdateMediaItemRequest = function(idSpec, albumId,
mediaItemId, opt_params) {
@@ -528,8 +528,8 @@ opensocial.DataRequest.prototype.newUpda
* at least 10KB of space per user per application for this data.
* @param {string} key The name of the key. This may only contain alphanumeric
* (A-Za-z0-9) characters, underscore(_), dot(.) or dash(-).
- * @param {string} value The value, must be valid json
- * @return {Object} A request object
+ * @param {string} value The value, must be valid json.
+ * @return {Object} A request object.
*/
opensocial.DataRequest.prototype.newUpdatePersonAppDataRequest = function(
key, value) {
@@ -544,8 +544,8 @@ opensocial.DataRequest.prototype.newUpda
*
* @param {Array.<string> | string} keys The keys you want to delete from
* the datastore; this can be an array of key names, a single key name,
- * or "*" to mean "all keys"
- * @return {Object} A request object
+ * or "*" to mean "all keys".
+ * @return {Object} A request object.
*/
opensocial.DataRequest.prototype.newRemovePersonAppDataRequest = function(keys) {
return opensocial.Container.get().newRemovePersonAppDataRequest(keys);
@@ -567,14 +567,14 @@ opensocial.DataRequest.ActivityRequestFi
* If provided will filter all activities by this app Id.
* @private - at the moment you can only request activities for your own app
*/
- APP_ID : 'appId',
+ APP_ID: 'appId',
/**
* When paginating, the index of the first item to fetch.
* Specified as a <code>Number</code>.
*
* @member opensocial.DataRequest.ActivityRequestFields
*/
- FIRST : 'first',
+ FIRST: 'first',
/**
* The maximum number of items to fetch; defaults to 20. If set to a larger
@@ -584,7 +584,7 @@ opensocial.DataRequest.ActivityRequestFi
*
* @member opensocial.DataRequest.ActivityRequestFields
*/
- MAX : 'max'
+ MAX: 'max'
};
@@ -599,8 +599,8 @@ opensocial.DataRequest.ActivityRequestFi
* fetch. See also <a href="opensocial.IdSpec.html">IdSpec</a>.
* @param {Object.<opensocial.DataRequest.ActivityRequestFields, Object>=} opt_params
* Additional parameters
- * to pass to the request; not currently used
- * @return {Object} A request object
+ * to pass to the request; not currently used.
+ * @return {Object} A request object.
*/
opensocial.DataRequest.prototype.newFetchActivitiesRequest = function(idSpec,
opt_params) {
@@ -620,7 +620,7 @@ opensocial.DataRequest.prototype.newFetc
*
* @param {opensocial.IdSpec} idSpec An IdSpec used to specify which albms to fetch.
* @param {Object.<Object, Object>=} opt_params Additional parameters to pass to the request.
- * @return {Object} A request object
+ * @return {Object} A request object.
*/
opensocial.DataRequest.prototype.newFetchAlbumsRequest = function(idSpec, opt_params) {
opt_params = opt_params || {};
Modified: shindig/trunk/features/src/main/javascript/features/opensocial-reference/dataresponse.js
URL: http://svn.apache.org/viewvc/shindig/trunk/features/src/main/javascript/features/opensocial-reference/dataresponse.js?rev=997163&r1=997162&r2=997163&view=diff
==============================================================================
--- shindig/trunk/features/src/main/javascript/features/opensocial-reference/dataresponse.js (original)
+++ shindig/trunk/features/src/main/javascript/features/opensocial-reference/dataresponse.js Wed Sep 15 01:39:49 2010
@@ -46,9 +46,9 @@
* This object contains the requested server data mapped to the requested keys.
*
* @param {Object.<string, ResponseItem>} responseItems Key/value map of data
- * response information
+ * response information.
* @param {boolean=} opt_globalError Optional field indicating whether there were
- * any errors generating this data response
+ * any errors generating this data response.
* @param {string=} opt_errorMessage
*
* @private
@@ -65,7 +65,7 @@ opensocial.DataResponse = function(respo
/**
* Returns true if there was an error in fetching this data from the server.
*
- * @return {boolean} True if there was an error; otherwise, false
+ * @return {boolean} True if there was an error; otherwise, false.
* @member opensocial.DataResponse
*/
opensocial.DataResponse.prototype.hadError = function() {
@@ -88,7 +88,7 @@ opensocial.DataResponse.prototype.getErr
*
* @return {opensocial.ResponseItem} The requested
* <a href="opensocial.ResponseItem.html">response</a> calculated by the
- * server
+ * server.
* @member opensocial.DataResponse
*/
opensocial.DataResponse.prototype.get = function(key) {
Modified: shindig/trunk/features/src/main/javascript/features/opensocial-reference/email.js
URL: http://svn.apache.org/viewvc/shindig/trunk/features/src/main/javascript/features/opensocial-reference/email.js?rev=997163&r1=997162&r2=997163&view=diff
==============================================================================
--- shindig/trunk/features/src/main/javascript/features/opensocial-reference/email.js (original)
+++ shindig/trunk/features/src/main/javascript/features/opensocial-reference/email.js Wed Sep 15 01:39:49 2010
@@ -58,14 +58,14 @@ opensocial.Email.Field = {
*
* @member opensocial.Email.Field
*/
- TYPE : 'type',
+ TYPE: 'type',
/**
* The email address, specified as a String.
*
* @member opensocial.Email.Field
*/
- ADDRESS : 'address'
+ ADDRESS: 'address'
};
@@ -79,7 +79,7 @@ opensocial.Email.Field = {
* opt_params Additional
* <a href="opensocial.DataRequest.DataRequestFields.html">params</a>
* to pass to the request.
- * @return {string} The data
+ * @return {string} The data.
*/
opensocial.Email.prototype.getField = function(key, opt_params) {
return opensocial.Container.getField(this.fields_, key, opt_params);
Modified: shindig/trunk/features/src/main/javascript/features/opensocial-reference/enum.js
URL: http://svn.apache.org/viewvc/shindig/trunk/features/src/main/javascript/features/opensocial-reference/enum.js?rev=997163&r1=997162&r2=997163&view=diff
==============================================================================
--- shindig/trunk/features/src/main/javascript/features/opensocial-reference/enum.js (original)
+++ shindig/trunk/features/src/main/javascript/features/opensocial-reference/enum.js Wed Sep 15 01:39:49 2010
@@ -110,21 +110,21 @@ opensocial.Enum.prototype.getDisplayValu
*/
opensocial.Enum.Smoker = {
/** @member opensocial.Enum.Smoker */
- NO : 'NO',
+ NO: 'NO',
/** @member opensocial.Enum.Smoker */
- YES : 'YES',
+ YES: 'YES',
/** @member opensocial.Enum.Smoker */
- SOCIALLY : 'SOCIALLY',
+ SOCIALLY: 'SOCIALLY',
/** @member opensocial.Enum.Smoker */
- OCCASIONALLY : 'OCCASIONALLY',
+ OCCASIONALLY: 'OCCASIONALLY',
/** @member opensocial.Enum.Smoker */
- REGULARLY : 'REGULARLY',
+ REGULARLY: 'REGULARLY',
/** @member opensocial.Enum.Smoker */
- HEAVILY : 'HEAVILY',
+ HEAVILY: 'HEAVILY',
/** @member opensocial.Enum.Smoker */
- QUITTING : 'QUITTING',
+ QUITTING: 'QUITTING',
/** @member opensocial.Enum.Smoker */
- QUIT : 'QUIT'
+ QUIT: 'QUIT'
};
@@ -141,21 +141,21 @@ opensocial.Enum.Smoker = {
*/
opensocial.Enum.Drinker = {
/** @member opensocial.Enum.Drinker */
- NO : 'NO',
+ NO: 'NO',
/** @member opensocial.Enum.Drinker */
- YES : 'YES',
+ YES: 'YES',
/** @member opensocial.Enum.Drinker */
- SOCIALLY : 'SOCIALLY',
+ SOCIALLY: 'SOCIALLY',
/** @member opensocial.Enum.Drinker */
- OCCASIONALLY : 'OCCASIONALLY',
+ OCCASIONALLY: 'OCCASIONALLY',
/** @member opensocial.Enum.Drinker */
- REGULARLY : 'REGULARLY',
+ REGULARLY: 'REGULARLY',
/** @member opensocial.Enum.Drinker */
- HEAVILY : 'HEAVILY',
+ HEAVILY: 'HEAVILY',
/** @member opensocial.Enum.Drinker */
- QUITTING : 'QUITTING',
+ QUITTING: 'QUITTING',
/** @member opensocial.Enum.Drinker */
- QUIT : 'QUIT'
+ QUIT: 'QUIT'
};
@@ -172,9 +172,9 @@ opensocial.Enum.Drinker = {
*/
opensocial.Enum.Gender = {
/** @member opensocial.Enum.Gender */
- MALE : 'MALE',
+ MALE: 'MALE',
/** @member opensocial.Enum.Gender */
- FEMALE : 'FEMALE'
+ FEMALE: 'FEMALE'
};
@@ -191,17 +191,17 @@ opensocial.Enum.Gender = {
*/
opensocial.Enum.LookingFor = {
/** @member opensocial.Enum.LookingFor */
- DATING : 'DATING',
+ DATING: 'DATING',
/** @member opensocial.Enum.LookingFor */
- FRIENDS : 'FRIENDS',
+ FRIENDS: 'FRIENDS',
/** @member opensocial.Enum.LookingFor */
- RELATIONSHIP : 'RELATIONSHIP',
+ RELATIONSHIP: 'RELATIONSHIP',
/** @member opensocial.Enum.LookingFor */
- NETWORKING : 'NETWORKING',
+ NETWORKING: 'NETWORKING',
/** @member opensocial.Enum.LookingFor */
- ACTIVITY_PARTNERS : 'ACTIVITY_PARTNERS',
+ ACTIVITY_PARTNERS: 'ACTIVITY_PARTNERS',
/** @member opensocial.Enum.LookingFor */
- RANDOM : 'RANDOM'
+ RANDOM: 'RANDOM'
};
@@ -218,15 +218,15 @@ opensocial.Enum.LookingFor = {
*/
opensocial.Enum.Presence = {
/** @member opensocial.Enum.Presence */
- AWAY : 'AWAY',
+ AWAY: 'AWAY',
/** @member opensocial.Enum.Presence */
- CHAT : 'CHAT',
+ CHAT: 'CHAT',
/** @member opensocial.Enum.Presence */
- DND : 'DND',
+ DND: 'DND',
/** @member opensocial.Enum.Presence */
- OFFLINE : 'OFFLINE',
+ OFFLINE: 'OFFLINE',
/** @member opensocial.Enum.Presence */
- ONLINE : 'ONLINE',
+ ONLINE: 'ONLINE',
/** @member opensocial.Enum.Presence */
- XA : 'XA'
+ XA: 'XA'
};
Modified: shindig/trunk/features/src/main/javascript/features/opensocial-reference/environment.js
URL: http://svn.apache.org/viewvc/shindig/trunk/features/src/main/javascript/features/opensocial-reference/environment.js?rev=997163&r1=997162&r2=997163&view=diff
==============================================================================
--- shindig/trunk/features/src/main/javascript/features/opensocial-reference/environment.js (original)
+++ shindig/trunk/features/src/main/javascript/features/opensocial-reference/environment.js Wed Sep 15 01:39:49 2010
@@ -39,9 +39,9 @@
/**
* Base interface for all environment objects.
*
- * @param {string} domain The current domain
+ * @param {string} domain The current domain.
* @param {Object.<string, Object.<string, boolean>>} supportedFields
- * The fields supported by this container
+ * The fields supported by this container.
*
* @private
* @constructor
@@ -56,7 +56,7 @@ opensocial.Environment = function(domain
* Returns the current domain —
* for example, "orkut.com" or "myspace.com".
*
- * @return {string} The domain
+ * @return {string} The domain.
*/
opensocial.Environment.prototype.getDomain = function() {
return this.domain;
@@ -80,59 +80,59 @@ opensocial.Environment.ObjectType = {
/**
* @member opensocial.Environment.ObjectType
*/
- PERSON : 'person',
+ PERSON: 'person',
/**
* @member opensocial.Environment.ObjectType
*/
- ADDRESS : 'address',
+ ADDRESS: 'address',
/**
* @member opensocial.Environment.ObjectType
*/
- BODY_TYPE : 'bodyType',
+ BODY_TYPE: 'bodyType',
/**
* @member opensocial.Environment.ObjectType
*/
- EMAIL : 'email',
+ EMAIL: 'email',
/**
* @member opensocial.Environment.ObjectType
*/
- NAME : 'name',
+ NAME: 'name',
/**
* @member opensocial.Environment.ObjectType
*/
- ORGANIZATION : 'organization',
+ ORGANIZATION: 'organization',
/**
* @member opensocial.Environment.ObjectType
*/
- PHONE : 'phone',
+ PHONE: 'phone',
/**
* @member opensocial.Environment.ObjectType
*/
- URL : 'url',
+ URL: 'url',
/**
* @member opensocial.Environment.ObjectType
*/
- ACTIVITY : 'activity',
+ ACTIVITY: 'activity',
/**
* @member opensocial.Environment.ObjectType
*/
- MEDIA_ITEM : 'mediaItem',
+ MEDIA_ITEM: 'mediaItem',
/**
* @member opensocial.Environment.ObjectType
*/
- MESSAGE : 'message',
+ MESSAGE: 'message',
/**
* @member opensocial.Environment.ObjectType
*/
- MESSAGE_TYPE : 'messageType',
+ MESSAGE_TYPE: 'messageType',
/**
* @member opensocial.Environment.ObjectType
*/
- SORT_ORDER : 'sortOrder',
+ SORT_ORDER: 'sortOrder',
/**
* @member opensocial.Environment.ObjectType
*/
- FILTER_TYPE : 'filterType'
+ FILTER_TYPE: 'filterType'
};
@@ -142,12 +142,12 @@ opensocial.Environment.ObjectType = {
*
* @param {opensocial.Environment.ObjectType} objectType
* The <a href="opensocial.Environment.ObjectType.html">object type</a>
- * to check for the field
- * @param {string} fieldName The name of the field to check for
- * @return {boolean} True if the field is supported on the specified object type
+ * to check for the field.
+ * @param {string} fieldName The name of the field to check for.
+ * @return {boolean} True if the field is supported on the specified object type.
*/
opensocial.Environment.prototype.supportsField = function(objectType,
fieldName) {
var supportedObjectFields = this.supportedFields[objectType] || [];
return !!supportedObjectFields[fieldName];
-};
\ No newline at end of file
+};
Modified: shindig/trunk/features/src/main/javascript/features/opensocial-reference/idspec.js
URL: http://svn.apache.org/viewvc/shindig/trunk/features/src/main/javascript/features/opensocial-reference/idspec.js?rev=997163&r1=997162&r2=997163&view=diff
==============================================================================
--- shindig/trunk/features/src/main/javascript/features/opensocial-reference/idspec.js (original)
+++ shindig/trunk/features/src/main/javascript/features/opensocial-reference/idspec.js Wed Sep 15 01:39:49 2010
@@ -73,14 +73,14 @@ opensocial.IdSpec.Field = {
* one of the opensocial.IdSpec.PersonId values.
* @member opensocial.IdSpec.Field
*/
- USER_ID : 'userId',
+ USER_ID: 'userId',
/**
* A string representing the group id or one of the
* opensocial.IdSpec.GroupId values. Defaults to SELF.
* @member opensocial.IdSpec.Field
*/
- GROUP_ID : 'groupId',
+ GROUP_ID: 'groupId',
/**
* An optional numeric parameter, used to specify how many "hops"
@@ -93,7 +93,7 @@ opensocial.IdSpec.Field = {
*
* @member opensocial.IdSpec.Field
*/
- NETWORK_DISTANCE : 'networkDistance'
+ NETWORK_DISTANCE: 'networkDistance'
};
@@ -105,18 +105,18 @@ opensocial.IdSpec.Field = {
* @name opensocial.IdSpec.PersonId
*/
opensocial.IdSpec.PersonId = {
- /**
+ /**
* @member opensocial.IdSpec.PersonId
*/
- OWNER : 'OWNER',
- /**
+ OWNER: 'OWNER',
+ /**
* @member opensocial.IdSpec.PersonId
*/
- VIEWER : 'VIEWER'
+ VIEWER: 'VIEWER'
};
- /**
+/**
* @static
* @class
* Constant group IDs available when fetching collections of people.
@@ -124,18 +124,18 @@ opensocial.IdSpec.PersonId = {
* @name opensocial.IdSpec.GroupId
*/
opensocial.IdSpec.GroupId = {
- /**
+ /**
* @member opensocial.IdSpec.GroupId
*/
- SELF : 'SELF',
- /**
+ SELF: 'SELF',
+ /**
* @member opensocial.IdSpec.GroupId
*/
- FRIENDS : 'FRIENDS',
- /**
+ FRIENDS: 'FRIENDS',
+ /**
* @member opensocial.IdSpec.GroupId
*/
- ALL : 'ALL'
+ ALL: 'ALL'
};
@@ -144,12 +144,12 @@ opensocial.IdSpec.GroupId = {
*
* @param {string} key The key to get data for;
* see the <a href="opensocial.IdSpec.Field.html">Field</a> class
- * for possible values
+ * for possible values.
* @param {Object.<opensocial.DataRequest.DataRequestFields, Object>}
* opt_params Additional
* <a href="opensocial.DataRequest.DataRequestFields.html">params</a>
* to pass to the request.
- * @return {string} The data
+ * @return {string} The data.
* @member opensocial.IdSpec
*/
opensocial.IdSpec.prototype.getField = function(key, opt_params) {
@@ -160,8 +160,8 @@ opensocial.IdSpec.prototype.getField = f
/**
* Sets data for this id spec associated with the given key.
*
- * @param {string} key The key to set data for
- * @param {string} data The data to set
+ * @param {string} key The key to set data for.
+ * @param {string} data The data to set.
*/
opensocial.IdSpec.prototype.setField = function(key, data) {
return (this.fields_[key] = data);
Modified: shindig/trunk/features/src/main/javascript/features/opensocial-reference/mediaitem.js
URL: http://svn.apache.org/viewvc/shindig/trunk/features/src/main/javascript/features/opensocial-reference/mediaitem.js?rev=997163&r1=997162&r2=997163&view=diff
==============================================================================
--- shindig/trunk/features/src/main/javascript/features/opensocial-reference/mediaitem.js (original)
+++ shindig/trunk/features/src/main/javascript/features/opensocial-reference/mediaitem.js Wed Sep 15 01:39:49 2010
@@ -32,8 +32,8 @@
/**
* Represents images, movies, and audio.
*
- * @param {string} mimeType The media's type
- * @param {string} url The media's location
+ * @param {string} mimeType The media's type.
+ * @param {string} url The media's location.
* @param {Object.<opensocial.MediaItem.Field, Object>=} opt_params
* Any other fields that should be set on the media item object.
* All of the defined Fields are supported.
@@ -71,11 +71,11 @@ opensocial.MediaItem = function(mimeType
*/
opensocial.MediaItem.Type = {
/** @member opensocial.MediaItem.Type */
- IMAGE : 'image',
+ IMAGE: 'image',
/** @member opensocial.MediaItem.Type */
- VIDEO : 'video',
+ VIDEO: 'video',
/** @member opensocial.MediaItem.Type */
- AUDIO : 'audio'
+ AUDIO: 'audio'
};
@@ -99,19 +99,19 @@ opensocial.MediaItem.Field = {
* <code>MediaItem.Type</code></a> object.
* @member opensocial.MediaItem.Field
*/
- TYPE : 'type',
+ TYPE: 'type',
/**
* The MIME type of media, specified as a String.
* @member opensocial.MediaItem.Field
*/
- MIME_TYPE : 'mimeType',
+ MIME_TYPE: 'mimeType',
/**
* A string specifying the URL where the media can be found.
* @member opensocial.MediaItem.Field
*/
- URL : 'url'
+ URL: 'url'
};
@@ -120,8 +120,8 @@ opensocial.MediaItem.Field = {
*
* @param {string} key The key to get data for; see the
* <a href="opensocial.MediaItem.Field.html">Field</a> class
- * for possible values
- * @return {string} The data
+ * for possible values.
+ * @return {string} The data.
*/
opensocial.MediaItem.prototype.getField = function(key, opt_params) {
return opensocial.Container.getField(this.fields_, key, opt_params);
@@ -131,8 +131,8 @@ opensocial.MediaItem.prototype.getField
/**
* Sets data for this media item associated with the given key.
*
- * @param {string} key The key to set data for
- * @param {string} data The data to set
+ * @param {string} key The key to set data for.
+ * @param {string} data The data to set.
*/
opensocial.MediaItem.prototype.setField = function(key, data) {
return (this.fields_[key] = data);
Modified: shindig/trunk/features/src/main/javascript/features/opensocial-reference/message.js
URL: http://svn.apache.org/viewvc/shindig/trunk/features/src/main/javascript/features/opensocial-reference/message.js?rev=997163&r1=997162&r2=997163&view=diff
==============================================================================
--- shindig/trunk/features/src/main/javascript/features/opensocial-reference/message.js (original)
+++ shindig/trunk/features/src/main/javascript/features/opensocial-reference/message.js Wed Sep 15 01:39:49 2010
@@ -49,7 +49,7 @@
* @constructor
*/
opensocial.Message = function(body_or_params, opt_params) {
- if (typeof body_or_params == 'string') {
+ if (typeof body_or_params == 'string') {
// We have a string
this.fields_ = opt_params || {};
this.fields_[opensocial.Message.Field.BODY] = body_or_params;
@@ -87,21 +87,21 @@ opensocial.Message.Field = {
* @member opensocial.Message.Field
* @const
*/
- BODY : 'body',
+ BODY: 'body',
/**
* The main text of the message as a message template. Specifies the
* message ID to use in the gadget xml.
* @member opensocial.Message.Field
*/
- BODY_ID : 'bodyId',
+ BODY_ID: 'bodyId',
/**
* Collection IDs this Message belongs to
* @member opensocial.Message.Field
*/
- COLLECTION_IDS : 'collectionIds',
+ COLLECTION_IDS: 'collectionIds',
/**
* The Unique ID of this message.
@@ -142,20 +142,20 @@ opensocial.Message.Field = {
* sanitized by the container.
* @member opensocial.Message.Field
*/
- TITLE : 'title',
+ TITLE: 'title',
/**
* The title of the message as a message template. Specifies the
* message ID to use in the gadget xml.
* @member opensocial.Message.Field
*/
- TITLE_ID : 'titleId',
+ TITLE_ID: 'titleId',
/**
* The title of the message, specified as an opensocial.Message.Type.
* @member opensocial.Message.Field
*/
- TYPE : 'type',
+ TYPE: 'type',
/**
* The last updated time of this message.
@@ -184,27 +184,27 @@ opensocial.Message.Type = {
*
* @member opensocial.Message.Type
*/
- EMAIL : 'email',
+ EMAIL: 'email',
/**
* A short private message.
*
* @member opensocial.Message.Type
*/
- NOTIFICATION : 'notification',
+ NOTIFICATION: 'notification',
/**
* A message to a specific user that can be seen only by that user.
*
* @member opensocial.Message.Type
*/
- PRIVATE_MESSAGE : 'privateMessage',
+ PRIVATE_MESSAGE: 'privateMessage',
/**
* A message to a specific user that can be seen by more than that user.
* @member opensocial.Message.Type
*/
- PUBLIC_MESSAGE : 'publicMessage'
+ PUBLIC_MESSAGE: 'publicMessage'
};
/**
@@ -239,12 +239,12 @@ opensocial.Message.Status = {
*
* @param {string} key The key to get data for;
* see the <a href="opensocial.Message.Field.html">Field</a> class
- * for possible values
+ * for possible values.
* @param {Object.<opensocial.DataRequest.DataRequestFields, Object>}
* opt_params Additional
* <a href="opensocial.DataRequest.DataRequestFields.html">params</a>
* to pass to the request.
- * @return {string} The data
+ * @return {string} The data.
* @member opensocial.Message
*/
opensocial.Message.prototype.getField = function(key, opt_params) {
@@ -255,8 +255,8 @@ opensocial.Message.prototype.getField =
/**
* Sets data for this message associated with the given key.
*
- * @param {string} key The key to set data for
- * @param {string} data The data to set
+ * @param {string} key The key to set data for.
+ * @param {string} data The data to set.
*/
opensocial.Message.prototype.setField = function(key, data) {
return (this.fields_[key] = data);
Modified: shindig/trunk/features/src/main/javascript/features/opensocial-reference/messagecollection.js
URL: http://svn.apache.org/viewvc/shindig/trunk/features/src/main/javascript/features/opensocial-reference/messagecollection.js?rev=997163&r1=997162&r2=997163&view=diff
==============================================================================
--- shindig/trunk/features/src/main/javascript/features/opensocial-reference/messagecollection.js (original)
+++ shindig/trunk/features/src/main/javascript/features/opensocial-reference/messagecollection.js Wed Sep 15 01:39:49 2010
@@ -67,34 +67,34 @@ opensocial.MessageCollection.Field = {
ID: 'id',
/**
- * The title of the message collection.
+ * The title of the message collection.
* @member opensocial.MessageCollection.Field
*/
- TITLE : 'title',
+ TITLE: 'title',
/**
* The total number of messages in this collection.
* @member opensocial.MessageCollection.Field
*/
- TOTAL : 'total',
+ TOTAL: 'total',
/**
* The total number of unread messages in this collection
* @member opensocial.MessageCollection.Field
*/
- UNREAD : 'unread',
+ UNREAD: 'unread',
/**
* The updated timestamp for this collection
* @member opensocial.MessageCollection.Field
*/
- UPDATED : 'updated',
+ UPDATED: 'updated',
/**
* Urls associated with this collection
* @member opensocial.MessageCollection.Field
*/
- URLS : 'urls'
+ URLS: 'urls'
};
@@ -103,12 +103,12 @@ opensocial.MessageCollection.Field = {
*
* @param {string} key The key to get data for;
* see the <a href="opensocial.MessageCollection.Field.html">Field</a> class
- * for possible values
+ * for possible values.
* @param {Object.<opensocial.DataRequest.DataRequestFields, Object>}
* opt_params Additional
* <a href="opensocial.DataRequest.DataRequestFields.html">params</a>
* to pass to the request.
- * @return {string} The data
+ * @return {string} The data.
* @member opensocial.MessageCollection
*/
opensocial.MessageCollection.prototype.getField = function(key, opt_params) {
@@ -119,8 +119,8 @@ opensocial.MessageCollection.prototype.g
/**
* Sets data for this message associated with the given key.
*
- * @param {string} key The key to set data for
- * @param {string} data The data to set
+ * @param {string} key The key to set data for.
+ * @param {string} data The data to set.
*/
opensocial.MessageCollection.prototype.setField = function(key, data) {
return this.fields_[key] = data;
Modified: shindig/trunk/features/src/main/javascript/features/opensocial-reference/name.js
URL: http://svn.apache.org/viewvc/shindig/trunk/features/src/main/javascript/features/opensocial-reference/name.js?rev=997163&r1=997162&r2=997163&view=diff
==============================================================================
--- shindig/trunk/features/src/main/javascript/features/opensocial-reference/name.js (original)
+++ shindig/trunk/features/src/main/javascript/features/opensocial-reference/name.js Wed Sep 15 01:39:49 2010
@@ -57,42 +57,42 @@ opensocial.Name.Field = {
*
* @member opensocial.Name.Field
*/
- FAMILY_NAME : 'familyName',
+ FAMILY_NAME: 'familyName',
/**
* The given name. Specified as a String.
*
* @member opensocial.Name.Field
*/
- GIVEN_NAME : 'givenName',
+ GIVEN_NAME: 'givenName',
/**
* The additional name. Specified as a String.
*
* @member opensocial.Name.Field
*/
- ADDITIONAL_NAME : 'additionalName',
+ ADDITIONAL_NAME: 'additionalName',
/**
* The honorific prefix. Specified as a String.
*
* @member opensocial.Name.Field
*/
- HONORIFIC_PREFIX : 'honorificPrefix',
+ HONORIFIC_PREFIX: 'honorificPrefix',
/**
* The honorific suffix. Specified as a String.
*
* @member opensocial.Name.Field
*/
- HONORIFIC_SUFFIX : 'honorificSuffix',
+ HONORIFIC_SUFFIX: 'honorificSuffix',
/**
* The unstructured name. Specified as a String.
*
* @member opensocial.Name.Field
*/
- UNSTRUCTURED : 'unstructured'
+ UNSTRUCTURED: 'unstructured'
};
@@ -106,7 +106,7 @@ opensocial.Name.Field = {
* opt_params Additional
* <a href="opensocial.DataRequest.DataRequestFields.html">params</a>
* to pass to the request.
- * @return {string} The data
+ * @return {string} The data.
*/
opensocial.Name.prototype.getField = function(key, opt_params) {
return opensocial.Container.getField(this.fields_, key, opt_params);
Modified: shindig/trunk/features/src/main/javascript/features/opensocial-reference/navigationparameters.js
URL: http://svn.apache.org/viewvc/shindig/trunk/features/src/main/javascript/features/opensocial-reference/navigationparameters.js?rev=997163&r1=997162&r2=997163&view=diff
==============================================================================
--- shindig/trunk/features/src/main/javascript/features/opensocial-reference/navigationparameters.js (original)
+++ shindig/trunk/features/src/main/javascript/features/opensocial-reference/navigationparameters.js Wed Sep 15 01:39:49 2010
@@ -80,14 +80,14 @@ opensocial.NavigationParameters.Field =
*
* @member opensocial.NavigationParameters.Field
*/
- VIEW : 'view',
+ VIEW: 'view',
/**
* A string representing the owner id.
*
* @member opensocial.NavigationParameters.Field
*/
- OWNER : 'owner',
+ OWNER: 'owner',
/**
* An optional list of parameters passed to the gadget once the new view,
@@ -96,7 +96,7 @@ opensocial.NavigationParameters.Field =
*
* @member opensocial.NavigationParameters.Field
*/
- PARAMETERS : 'parameters'
+ PARAMETERS: 'parameters'
};
@@ -105,12 +105,12 @@ opensocial.NavigationParameters.Field =
*
* @param {string} key The key to get data for;
* see the <a href="opensocial.NavigationParameters.Field.html">Field</a>
- * class for possible values
+ * class for possible values.
* @param {Object.<opensocial.DataRequest.DataRequestFields, Object>}
* opt_params Additional
* <a href="opensocial.DataRequest.DataRequestFields.html">params</a>
* to pass to the request.
- * @return {string} The data
+ * @return {string} The data.
* @member opensocial.NavigationParameters
*/
opensocial.NavigationParameters.prototype.getField = function(key, opt_params) {
@@ -121,8 +121,8 @@ opensocial.NavigationParameters.prototyp
/**
* Sets data for this NavigationParameters associated with the given key.
*
- * @param {string} key The key to set data for
- * @param {Object} data The data to set
+ * @param {string} key The key to set data for.
+ * @param {Object} data The data to set.
*/
opensocial.NavigationParameters.prototype.setField = function(key, data) {
return (this.fields_[key] = data);
@@ -141,8 +141,8 @@ opensocial.NavigationParameters.prototyp
*/
opensocial.NavigationParameters.DestinationType = {
/** @member opensocial.NavigationParameters.DestinationType */
- VIEWER_DESTINATION : "viewerDestination",
+ VIEWER_DESTINATION: 'viewerDestination',
/** @member opensocial.NavigationParameters.DestinationType */
- RECIPIENT_DESTINATION : "recipientDestination"
+ RECIPIENT_DESTINATION: 'recipientDestination'
};
Modified: shindig/trunk/features/src/main/javascript/features/opensocial-reference/opensocial.js
URL: http://svn.apache.org/viewvc/shindig/trunk/features/src/main/javascript/features/opensocial-reference/opensocial.js?rev=997163&r1=997162&r2=997163&view=diff
==============================================================================
--- shindig/trunk/features/src/main/javascript/features/opensocial-reference/opensocial.js (original)
+++ shindig/trunk/features/src/main/javascript/features/opensocial-reference/opensocial.js Wed Sep 15 01:39:49 2010
@@ -60,17 +60,17 @@ var opensocial = opensocial || {};
*
* @param {Array.<string> | string} recipients An ID, array of IDs, or a
* group reference; the supported keys are VIEWER, OWNER, VIEWER_FRIENDS,
- * OWNER_FRIENDS, or a single ID within one of those groups
+ * OWNER_FRIENDS, or a single ID within one of those groups.
* @param {opensocial.Message} message The message to send to the specified
- * users
+ * users.
* @param {function(opensocial.ResponseItem)=} opt_callback The function to call once the request has been
* processed; either this callback will be called or the gadget will be
- * reloaded from scratch
+ * reloaded from scratch.
* @param {opensocial.NavigationParameters=} opt_params The optional parameters
* indicating where to send a user when a request is made, or when a request is
* accepted; options are of type
* <a href="opensocial.NavigationParameters.DestinationType.html">
- * NavigationParameters.DestinationType</a>
+ * NavigationParameters.DestinationType.</a>
*
* @member opensocial
*/
@@ -102,18 +102,18 @@ opensocial.requestSendMessage = function
*
* @param {Array.<string> | string} recipients An ID, array of IDs, or a
* group reference; the supported keys are VIEWER, OWNER, VIEWER_FRIENDS,
- * OWNER_FRIENDS, or a single ID within one of those groups
+ * OWNER_FRIENDS, or a single ID within one of those groups.
* @param {opensocial.Message} reason The reason the user wants the gadget to
* share itself. This reason can be used by the container when prompting the
* user for permission to share the app. It may also be ignored.
* @param {function(opensocial.ResponseItem)=} opt_callback The function to call once the request has been
* processed; either this callback will be called or the gadget will be
- * reloaded from scratch
+ * reloaded from scratch.
* @param {opensocial.NavigationParameters=} opt_params The optional parameters
* indicating where to send a user when a request is made, or when a request is
* accepted; options are of type
* <a href="opensocial.NavigationParameters.DestinationType.html">
- * NavigationParameters.DestinationType</a>
+ * NavigationParameters.DestinationType.</a>
*
* @member opensocial
*/
@@ -156,10 +156,10 @@ opensocial.requestShareApp = function(re
* </p>
*
* @param {opensocial.Activity} activity The <a href="opensocial.Activity.html">
- * activity</a> to create
+ * activity</a> to create.
* @param {opensocial.CreateActivityPriority} priority The
* <a href="opensocial.CreateActivityPriority.html">priority</a> for this
- * request
+ * request.
* @param {function(opensocial.ResponseItem)=} opt_callback The function to call once the request has been
* processed.
*
@@ -171,14 +171,14 @@ opensocial.requestCreateActivity = funct
window.setTimeout(function() {
opt_callback(new opensocial.ResponseItem(null, null,
opensocial.ResponseItem.Error.BAD_REQUEST,
- "You must pass in an activity with a title or title id."));
+ 'You must pass in an activity with a title or title id.'));
}, 0);
}
return;
}
- opensocial.Container.get().requestCreateActivity(activity, priority,
- opt_callback);
+ opensocial.Container.get().requestCreateActivity(activity, priority,
+ opt_callback);
};
@@ -202,7 +202,7 @@ opensocial.CreateActivityPriority = {
*
* @member opensocial.CreateActivityPriority
*/
- HIGH : 'HIGH',
+ HIGH: 'HIGH',
/**
* If the activity is of low importance, it will not be created if the
@@ -212,7 +212,7 @@ opensocial.CreateActivityPriority = {
*
* @member opensocial.CreateActivityPriority
*/
- LOW : 'LOW'
+ LOW: 'LOW'
};
@@ -222,9 +222,9 @@ opensocial.CreateActivityPriority = {
* are granted then this function must return true on all subsequent calls.
*
* @param {opensocial.Permission} permission
- * The <a href="opensocial.Permission.html">permission</a>
+ * The <a href="opensocial.Permission.html">permission.</a>
* @return {boolean}
- * True if the gadget has access for the permission; false if it doesn't
+ * True if the gadget has access for the permission; false if it doesn't.
*
* @member opensocial
*/
@@ -241,9 +241,9 @@ opensocial.hasPermission = function(perm
*
* @param {Array.<opensocial.Permission>} permissions
* The <a href="opensocial.Permission.html">permissions</a> to request
- * from the viewer
+ * from the viewer.
* @param {string} reason Displayed to the user as the reason why these
- * permissions are needed
+ * permissions are needed.
* @param {function(opensocial.ResponseItem)=} opt_callback The function to call once the request has been
* processed; either this callback will be called or the gadget will be
* reloaded from scratch. This function will be passed one parameter, an
@@ -283,7 +283,7 @@ opensocial.Permission = {
*
* @member opensocial.Permission
*/
- VIEWER : 'viewer'
+ VIEWER: 'viewer'
};
@@ -293,7 +293,7 @@ opensocial.Permission = {
* container, what parameters were passed to the current gadget, and so on.
*
* @return {opensocial.Environment}
- * The current <a href="opensocial.Environment.html">environment</a>
+ * The current <a href="opensocial.Environment.html">environment.</a>
*
* @member opensocial
*/
@@ -307,7 +307,7 @@ opensocial.getEnvironment = function() {
* server.
*
* @return {opensocial.DataRequest} The
- * <a href="opensocial.DataRequest.html">request</a> object
+ * <a href="opensocial.DataRequest.html">request</a> object.
* @member opensocial
*/
opensocial.newDataRequest = function() {
@@ -340,7 +340,7 @@ opensocial.newDataRequest = function() {
* @param {Object.<opensocial.Activity.Field, Object>} params
* Parameters defining the activity.
* @return {opensocial.Activity} The new
- * <a href="opensocial.Activity.html">activity</a> object
+ * <a href="opensocial.Activity.html">activity</a> object.
* @member opensocial
*/
opensocial.newActivity = function(params) {
@@ -356,10 +356,10 @@ opensocial.newActivity = function(params
* Any other fields that should be set on the album object;
* all of the defined
* <a href="opensocial.Album.Field.html">Field</a>s
- * are supported
+ * are supported.
*
* @return {opensocial.Album} The new
- * <a href="opensocial.Album.html">album</a> object
+ * <a href="opensocial.Album.html">album</a> object.
* @member opensocial
*/
opensocial.newAlbum = function(opt_params) {
@@ -374,16 +374,16 @@ opensocial.newAlbum = function(opt_param
*
* @param {string} mimeType
* <a href="opensocial.MediaItem.Type.html">MIME type</a> of the
- * media
- * @param {string} url Where the media can be found
+ * media.
+ * @param {string} url Where the media can be found.
* @param {Object.<opensocial.MediaItem.Field, Object>=} opt_params
* Any other fields that should be set on the media item object;
* all of the defined
* <a href="opensocial.MediaItem.Field.html">Field</a>s
- * are supported
+ * are supported.
*
* @return {opensocial.MediaItem} The new
- * <a href="opensocial.MediaItem.html">media item</a> object
+ * <a href="opensocial.MediaItem.html">media item</a> object.
* @member opensocial
*/
opensocial.newMediaItem = function(mimeType, url, opt_params) {
@@ -401,10 +401,10 @@ opensocial.newMediaItem = function(mimeT
* Any other fields that should be set on the message object;
* all of the defined
* <a href="opensocial.Message.Field.html">Field</a>s
- * are supported
+ * are supported.
*
* @return {opensocial.Message} The new
- * <a href="opensocial.Message.html">message</a> object
+ * <a href="opensocial.Message.html">message</a> object.
* @member opensocial
*/
opensocial.newMessage = function(body, opt_params) {
@@ -424,13 +424,13 @@ opensocial.EscapeType = {
* When used will HTML-escape the data.
* @member opensocial.EscapeType
*/
- HTML_ESCAPE : 'htmlEscape',
+ HTML_ESCAPE: 'htmlEscape',
/**
* When used will not escape the data.
*
* @member opensocial.EscapeType
*/
- NONE : 'none'
+ NONE: 'none'
};
@@ -440,7 +440,7 @@ opensocial.EscapeType = {
* @param {Object.<opensocial.IdSpec.Field, Object>} params
* Parameters defining the id spec.
* @return {opensocial.IdSpec} The new
- * <a href="opensocial.IdSpec.html">IdSpec</a> object
+ * <a href="opensocial.IdSpec.html">IdSpec</a> object.
* @member opensocial
*/
opensocial.newIdSpec = function(params) {
@@ -457,10 +457,10 @@ opensocial.newIdSpec = function(params)
*
*
* @param {Object.<opensocial.NavigationParameters.Field, Object>} params
- * Parameters defining the navigation
+ * Parameters defining the navigation.
* @return {opensocial.NavigationParameters} The new
* <a href="opensocial.NavigationParameters.html">NavigationParameters</a>
- * object
+ * object.
* @member opensocial
*/
opensocial.newNavigationParameters = function(params) {
Modified: shindig/trunk/features/src/main/javascript/features/opensocial-reference/organization.js
URL: http://svn.apache.org/viewvc/shindig/trunk/features/src/main/javascript/features/opensocial-reference/organization.js?rev=997163&r1=997162&r2=997163&view=diff
==============================================================================
--- shindig/trunk/features/src/main/javascript/features/opensocial-reference/organization.js (original)
+++ shindig/trunk/features/src/main/javascript/features/opensocial-reference/organization.js Wed Sep 15 01:39:49 2010
@@ -59,7 +59,7 @@ opensocial.Organization.Field = {
* Not supported by all containers.
* @member opensocial.Organization.Field
*/
- NAME : 'name',
+ NAME: 'name',
/**
* The title or role the person has in the organization, specified as a
@@ -67,7 +67,7 @@ opensocial.Organization.Field = {
* Not supported by all containers.
* @member opensocial.Organization.Field
*/
- TITLE : 'title',
+ TITLE: 'title',
/**
* A description or notes about the person's work in the organization,
@@ -76,7 +76,7 @@ opensocial.Organization.Field = {
* Not supported by all containers.
* @member opensocial.Organization.Field
*/
- DESCRIPTION : 'description',
+ DESCRIPTION: 'description',
/**
* The field the organization is in, specified as a string. This could be the
@@ -84,21 +84,21 @@ opensocial.Organization.Field = {
* Not supported by all containers.
* @member opensocial.Organization.Field
*/
- FIELD : 'field',
+ FIELD: 'field',
/**
* The subfield the Organization is in, specified as a string.
* Not supported by all containers.
* @member opensocial.Organization.Field
*/
- SUB_FIELD : 'subField',
+ SUB_FIELD: 'subField',
/**
* The date the person started at the organization, specified as a Date.
* Not supported by all containers.
* @member opensocial.Organization.Field
*/
- START_DATE : 'startDate',
+ START_DATE: 'startDate',
/**
* The date the person stopped at the organization, specified as a Date.
@@ -107,29 +107,29 @@ opensocial.Organization.Field = {
* Not supported by all containers.
* @member opensocial.Organization.Field
*/
- END_DATE : 'endDate',
+ END_DATE: 'endDate',
- /**
+ /**
* The salary the person receieves from the organization, specified as a
* string.
* Not supported by all containers.
* @member opensocial.Organization.Field
*/
- SALARY : 'salary',
+ SALARY: 'salary',
- /**
+ /**
* The address of the organization, specified as an opensocial.Address.
* Not supported by all containers.
* @member opensocial.Organization.Field
*/
- ADDRESS : 'address',
+ ADDRESS: 'address',
- /**
+ /**
* A webpage related to the organization, specified as a string.
* Not supported by all containers.
* @member opensocial.Organization.Field
*/
- WEBPAGE : 'webpage'
+ WEBPAGE: 'webpage'
};
@@ -142,8 +142,8 @@ opensocial.Organization.Field = {
* @param {Object.<opensocial.DataRequest.DataRequestFields, Object>}
* opt_params Additional
* <a href="opensocial.DataRequest.DataRequestFields.html">params</a>
- * to pass to the request
- * @return {string} The data
+ * to pass to the request.
+ * @return {string} The data.
*/
opensocial.Organization.prototype.getField = function(key, opt_params) {
return opensocial.Container.getField(this.fields_, key, opt_params);