Skip to content

Commit

Permalink
Minor changes to the autodoc remarks and addition of the FluidDBExplorer
Browse files Browse the repository at this point in the history
demo program (available as a separate download).
  • Loading branch information
maxapps committed Jun 23, 2010
1 parent 7d98d73 commit 2cfe53d
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 15 deletions.
Binary file modified FluidDBServer.swc
Binary file not shown.
22 changes: 16 additions & 6 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,20 @@ doing this from vanilla flash. The JS libraries manage it by utilizing jQuery.
An inspection of which would probably lead to a valid method.


Changes
=======
June 22, 2010 - Minor changes to autodoc remarks.
- Added FluidDBExplorer for experimentation and demos.


FluidDBExplorer
===============
An AIR application for demonstrating the use of this library or for just
exploring use of the FluidDB API is now available from the Downloads page.
Installation is the same as for any AIR application. After installation,
run the app then view information available on the "Getting Started" tab.


Dependencies
============
Requires the as3corelib library for easily encoding/decoding JSON
Expand All @@ -29,9 +43,5 @@ try to keep it updated as the FluidDB API matures but there are no guarantees.

ToDo
====
I plan to add some additional helper methods for things like automatically
creating tags if they don't already exist when tagging an object, etc.

A complete working example of using the library is coming soon. The one I used
for testing is far too ugly to release.

I still plan to add some additional helper methods for things like
automatically creating tags if they don't already exist when tagging an object.
2 changes: 1 addition & 1 deletion src/com/maxapps/fluiddb/FluidDBAction.as
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ package com.maxapps.fluiddb {

/**
* Raw response data returned by the API call. Not all API calls return any data.
* In this version of the API, most calls do which return data do so as a JSON formatted string.
* In this version of the API, most calls which return data do so as a JSON formatted string.
*
* The FluidDBService's decodeResponse() method can be used to convert the data to an object.
*
Expand Down
1 change: 1 addition & 0 deletions src/com/maxapps/fluiddb/FluidDBPermits.as
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ package com.maxapps.fluiddb {


// Action lists for Policies
public static const POLICY_ACTIONS_ALL:Array = ACTIONS_ALL.slice(1);
public static const POLICY_ACTIONS_NS:Array = ACTIONS_NS.slice(1);
public static const POLICY_ACTIONS_TAG:Array = ACTIONS_TAG.slice(1);
public static const POLICY_ACTIONS_VALUE:Array = ACTIONS_VALUE.slice(1);
Expand Down
18 changes: 10 additions & 8 deletions src/com/maxapps/fluiddb/FluidDBService.as
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ package com.maxapps.fluiddb {
* asynchronous and the appropriate event is fired as needed.
*
* @example
* private svcDB:FluidDBService;
* private var svcDB:FluidDBService;
*
* // The creationComplete event handler for the application.
* private function creationComplete():void {
Expand Down Expand Up @@ -373,7 +373,7 @@ package com.maxapps.fluiddb {
* Note that this method creates a tag itself, NOT the value of a tag on a particular object
* (for that, use createObjectTag() or tagObject().
*
* @param sPath Path to create tag on..
* @param sPath Path to create tag on.
* @param sName Name of tag to create.
* @param sDesc Description of the new tag.
* @param fIndex [false] Optional parameter indicating whether the tag should be indexed.
Expand Down Expand Up @@ -407,6 +407,8 @@ package com.maxapps.fluiddb {
* Currently, the FluidDB API only returns responses as JSON formatted strings. This function
* provides for future expansion to additional formats.
*
* @param vResponse Response from call to FluidDB API.
*
* @return Returns the response converted to the type of data specfied by the
* contentType property (at the moment, only JSON is supported by the API).
*
Expand Down Expand Up @@ -518,7 +520,7 @@ package com.maxapps.fluiddb {
*
* @return API returns:
* exceptions The names of users who are exceptions to the policy.
* policy The policy (either 'open' or 'closed').
* policy The policy (either 'open' or 'closed').
*
* @see setNamespacePermits()
* @see http://doc.fluidinfo.com/fluidDB/permissions.html
Expand Down Expand Up @@ -657,7 +659,7 @@ package com.maxapps.fluiddb {
* getTagValuePolicy() which eliminate the need to specify the category.
*
* @param sUser User to get policy for.
* @param sCategory Category to set policy for (namespaces|tags|tag-values).
* @param sCategory Category to get policy for (namespaces|tags|tag-values).
* @param sAction Action to get policy for. Actions vary by category as follows:
* For namespaces: create|update|delete|list
* For tags: update|delete
Expand Down Expand Up @@ -863,8 +865,6 @@ package com.maxapps.fluiddb {

mdlAct = new FluidDBAction("queryForObject", DB_OBJECTS, METHOD_GET, fncCB);
callAPI(mdlAct, {query:sQry});
// http://sandbox.fluidinfo.com/objects/?{"query":"has test/jcarversandbox/Test01/Started"}

}


Expand All @@ -873,8 +873,8 @@ package com.maxapps.fluiddb {
* the API attempts the request as the anonymous user. This method needs to be called BEFORE
* any methods which access the API.
*
* @param sUser The username selected when FluidDB account was created.
* @param sPW The password for the account indicated by the username.
* @param sUser [''] The username selected when FluidDB account was created.
* @param sPW [''] The password for the account indicated by the username.
*
* <b>Note: </b> Setting either the username or password to an empty string results in
* credentials for an anonynous user.
Expand Down Expand Up @@ -1184,6 +1184,8 @@ package com.maxapps.fluiddb {
* @param fncCB [null] Optional callback function. If provided, the function must accept
* an instance of FluidDBAction.
*
* @return API returns no data.
*
* @see createObjectTag()
* @see createOpaqueObjectTag()
* @see tagObject()
Expand Down

0 comments on commit 2cfe53d

Please sign in to comment.