Web::Dash::WebAPI - Web API for Web::Dash
This document describes Web API provided by Web::Dash.
Makes a search with a Lens and returns the search results.
Query Parameters
lens
The service name of the Lens to be used.
The service name of a lens is the DBusName parameter written in the .lens file. For example, .lens file for the Application lens is usually located at /usr/share/unity/lenses/applications/applications.lens, and its DBusName is com.canonical.Unity.Lens.Applications
DBusName
/usr/share/unity/lenses/applications/applications.lens
com.canonical.Unity.Lens.Applications
q
Search query. It must be encoded in UTF-8.
Response
In success, the HTTP response code is 200. The response is a JSON object. The error attribute of the object is null, and the results attribute of the object is an array of search results.
error
null
results
Each entry in the results array is a JSON object representing a search result. The search result object is basically an object returned by search_sync() method of Web::Dash::Lens. Its category object returned by category_sync() method of Web::Dash::Lens is joined to the result object's category attribute. See example below.
search_sync()
category_sync()
category
In failure, the HTTP response code is 4** or 5**. The response is a JSON object. The error attribute of the object describes the cause of the error.
Example
Request to Wikipedia Lens.
GET /search.json?lens=net.launchpad.lens.wikipedia&q=dash
Response:
{ "error" : null, "results" : [ { "category_index" : 0, "name" : "Dash", "icon_hint" : "/opt/extras.ubuntu.com/unity-lens-wikipedia/media/wiki_blank-0.png", "uri" : "0xb4b04e90:http://en.wikipedia.org/wiki/Dash", "dnd_uri" : "http://en.wikipedia.org/wiki/Dash", "comment" : "A dash is a punctuation mark, similar to a hyphen or minus sign but differing primarily in length and serving different functions. ", "category" : { "name" : "Articles", "icon_hint" : "/usr/share/icons/unity-icon-theme/places/svg/group-installed.svg", "renderer" : "tile-horizontal" }, "mimetype" : "text/html" }, { "category_index" : 0, "name" : "Dashiell Hammett", "icon_hint" : "http://upload.wikimedia.org/wikipedia/commons/thumb/7/70/Dashiellhammett.jpg/96px-Dashiellhammett.jpg", "uri" : "0xb4b04e90:http://en.wikipedia.org/wiki/Dashiell Hammett", "dnd_uri" : "http://en.wikipedia.org/wiki/Dashiell Hammett", "comment" : "Samuel Dashiell Hammett (; May 27, 1894 – January 10, 1961) was an American author of hard-boiled detective novels and short stories, a screenplay writer, and political activist. ", "category" : { "name" : "Articles", "icon_hint" : "/usr/share/icons/unity-icon-theme/places/svg/group-installed.svg", "renderer" : "tile-horizontal" }, "mimetype" : "text/html" } ] }
Toshio Ito <toshioito [at] cpan.org>
<toshioito [at] cpan.org>
1 POD Error
The following errors were encountered while parsing the POD:
Non-ASCII character seen before =encoding in '–'. Assuming UTF-8
To install Web::Dash, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Web::Dash
CPAN shell
perl -MCPAN -e shell install Web::Dash
For more information on module installation, please visit the detailed CPAN module installation guide.