Page Comparison

Note - the "widget uploader" (widgetUploader.jsp) should be used in most cases, rather than this lower level call.

Used to POST a JSON object (specified below) to upload widget metadata (not the widget itself, which is stored separately either on a filesystem or via the sharing API.

Once the metadata has been successfully uploaded, the widget can be accessed from the GUI's module browser.

A simple web-based utility is available for installing widgets in one step.

{
    "

_id": 

string, // Optional - auto-generated if not specified. 

If the "_id" is specified then updates the module as described below.
    "

url": 

string, // Will normally either be a public URL or the location of 

a shared object in Infinit.e.
    

"title": 

string, // The widget title displayed in the widget 

browser and on the widget window title bar
    

"

description": 

string, // A description of 

the widget, displayed in the widget browser
    

"version": 

string, // An arbitrary string used for external versioning
    "

imageurl": 

string, // The URL of an image used to represent the widget in the GUI framework (again normally either a public URL or share)
    "

communityIds": [ 

string ], // The communities with which to share the module (must be owner/moderator/admin to share a module)
    "searchterms": [
        string // A 

list of strings that are used in the "modules/search" API call
    

]

}

{
    //...
    "url": "$infinite/share/get/4d88d0f1f9a624a4b0c8bd71"
    //...
}

{
    //...
    "_id": string, // If not specified
    "created": string, // First time inserted, the Unix time in ms
    "modified": string, // Each time created or modified, the Unix time in ms
    "author": string, // The (unique) email address of the uploader
    "approved": boolean, // Currently hardwired to true
    //...
}

#bash> curl -XPOST 'http://infinite.ikanow.com/social/gui/modules/install' -d '{
    "url": "$infinite/share/get/4d88d0f1f9a624a4b0c8bd71",
    "title": "Test widget",
    "description: "A widget designed to test some new visualization",
    "version": "0.9",
    "imageurl": "$infinite/share/get/4d88d0f1f9a624a4b0c8bd72",
    "searchterms": [ "test", "visualization" ]
}'

The response format is straightforward, and most easily shown with this example:

{
    response:
    {
        action: "Install Module",
            "title"success: "Timeline"true,
            "description"message: "Showsmodule documents on a timeline",
            "created": "1286897473889",
            "modified": "1286897473889",
            "version": "1.0",
            "author": "ikanow",
            "imageurl": "http://clinicaltrials.ifpma.org/clinicaltrials/uploads/RTEmagicC_save-time_01.png.png",
            "approved": trueinstalled/updated successfully" // (or the error message if success:false)
    },
            "searchterms": [
                "Timeline",
                "Shows",
                "documents",
                "on",
                "a",
                "timeline",
                "ikanow"
            ]
   data:
    },
        {
            "_id": "4cbde99af5398e7ba63af4b9",
            "swf": "DetailsView.swf",
            "url": "com/ikanow/infinit/e/modules/",
            "title": "Details",
            "description": "Displays details of currently selected items",
  4d88d0f1f9a624a4b0c8bd71", // The _id of the store, used for updating/deletion
         "created": "1287514522802",
            "modified": "1287514522802",
            "version": "1.0",
            "author": "ikanow",
            "imageurl": "http://www.hswallpapers.com/wp-content/uploads/2010/08/Bleach-Episode-284.png",
            "approved": true,
            "searchterms": [
                "Details",
                "Displays",
                "details",
                "of",
                "currently",
                "selected",
                "items",
                "ikanow"
            ]
        }
    ]
}