dojox.data.GoogleVideoSearchStore¶
| Status: | Draft |
|---|---|
| Version: | 1.0 |
| Project owner: | Shane O’Sullivan |
| Available: | since 1.2? |
dojox.data.GoogleVideoSearchStore is a data store that can be used to search YouTube and Google Video.
Introduction¶
dojox.data.GoogleVideoSearchStore is a read only data store that can be used to search YouTube and Google Video. It implements the ‘dojo.data.api.Read API <dojo/data/api/Read>’_, which you should refer to for general usage.
Usage¶
- The pattern of using the GoogleSearchStore is
- Instantiate the class, passing in whatever variables required, all of which are optional. These include:
- label The argument to use as the label. This is used when the getLabel function is called to retrieve the correct part of the data item. You generally shouldn’t set this.
- key Your Google API key. This is optional, and should only be used if you for some reason want Google to track the number of requests made by your code (for analytical purposes maybe)
- lang The language you want the results returned in. This defaults to the browsers’ language.
- urlPreventCache Specifies whether or not to forcibly prevent caching of results. This defaults to true.
- Call the fetch method, passing it the search query and the function to call when the query is completed. The only supported attribute of the query is text, the text to search for.
- Iterate over the results, calling the getValue function to retrieve values from each result item. The pieces of data in each result item are
- title The page title in HTML format
- titleNoFormatting The page title in plain text. This is the default field used as the label.
- content A snippet of information about the page
- url The URL for the item.
- published The published date, in RFC-822 format.
- publisher The name of the publisher.
- tbWidth The width in pixels of the video thumbnail image
- tbHeight The height in pixels of the video thumbnail image
- tbUrl The URL to a thumbnail representation of the video
- playUrl If present, supplies the url of the flash version of the video that can be played inline on your page. To play this video simply create and <embed> element on your page using this value as the src attribute and using application/x-shockwave-flash as the type attribute. If you want the video to play right away, make sure to append &autoPlay=true to the url
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 | <script type="text/javascript">
dojo.require("dojox.data.GoogleSearchStore");
var store = new dojox.data.GoogleVideoSearchStore();
var query = {text: "dojo ajax toolkit"};
var callbackFunction = function(items /* Array */) {
console.log("Successfully retrieved " + items.length + " items for the query '" + query.text + "'");
dojo.forEach(items, function(item){
console.log ("Title is " + store.getValue(item, "title"));
console.log ("Url is " + store.getValue(item, "url"));
console.log ("Duration is " + store.getValue(item, "duration"));
console.log ("Thubnail image Url is " + store.getValue(item, "tbUrl"));
})
};
var onErrorFunction = function() {
console.log("An error occurred getting Google Search data");
}
store.fetch({
query: query,
count: 20,
start: 0,
onComplete: callbackFunction,
onError: onErrorFunction
});
</script>
|
Examples¶
Programmatic example¶
<script type="text/javascript">
dojo.require("dojox.data.GoogleSearchStore");
function doSearch() {
var store = new dojox.data.GoogleVideoSearchStore();
var query = {text: dojo.byId("searchInput").value};
var callbackFunction = function(items /* Array */) {
var table = dojo.byId("resultTable");
var tableBody = table.tBodies[0];
dojo.empty(tableBody);
// Show the table
dojo.style(table, "display", "");
dojo.forEach(items, function(item, index){
var row = dojo.create("tr", {}, tableBody);
var numberCell = dojo.create("td", {innerHTML: index}, row);
var titleCell = dojo.create("td", {innerHTML: store.getValue(item, "titleNoFormatting")}, row);
var urlCell = dojo.create("td", {}, row);
var link = dojo.create("a", {
href: store.getValue(item, "url"),
target: "_blank"
}, urlCell);
var thumbnail = dojo.create("img", {
src: store.getValue(item, "tbUrl")
}, link);
})
};
var onErrorFunction = function() {
console.log("An error occurred getting Google Search data");
}
store.fetch({
query: query,
count: 20,
start: 0,
onComplete: callbackFunction,
onError: onErrorFunction
});
console.log("called fetch with query", query);
}
</script>
<div>
<span>Enter Search Text</span>
<input type="text" value="dojo ajax toolkit" id="searchInput">
<button onclick="doSearch()">Search</button>
</div>
<table id="resultTable" style="border: 1px solid black; display: none;">
<thead>
<th>#</th>
<th>Title</th>
<th>URL</th>
</thead>
<tbody>
</tbody>
</table>