Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

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 Infinit.e 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.

Authentication

Required, seeĀ Auth - Login

...

Code Block
langjavascript
{
    "_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
    ]
}

...