Subversion Repositories Applications.papyrus

Compare Revisions

Ignore whitespace Rev 2149 → Rev 2150

/trunk/api/js/dojo1.0/dojox/rpc/README
New file
0,0 → 1,40
-------------------------------------------------------------------------------
DojoX RPC Extras
-------------------------------------------------------------------------------
Version 1.0
Release date: 07/01/2007
-------------------------------------------------------------------------------
Project state:
yahoo.smd: stable
-------------------------------------------------------------------------------
Project authors
Dustin Machi
-------------------------------------------------------------------------------
Project description
 
Extra utilities for use with dojo.rpc as well as additional smd descriptions
for specific services.
-------------------------------------------------------------------------------
Dependencies:
 
Dojo Core (package loader, dojo.rpc).
-------------------------------------------------------------------------------
Documentation
 
See RPC documentation at http://dojotoolkit.org/
 
-------------------------------------------------------------------------------
Installation instructions
 
Grab the following from the Dojo SVN Repository:
http://svn.dojotoolkit.org/var/src/dojo/dojox/trunk/rpc/*
 
Install into the following directory structure:
/dojox/rpc/
 
...which should be at the same level as your Dojo checkout.
 
The use of the actual utilities varies, but typically additional software
will be included with dojo.require() and smd files for services can be loaded
manually with an xhr request or can be provided by url to the service when created
 
/trunk/api/js/dojo1.0/dojox/rpc/yahoo.smd
New file
0,0 → 1,268
{
"SMDVersion":".1",
"objectName":"yahoo",
"serviceType":"JSON-P",
"required": {
"appId": "dojotoolkit",
"output": "json"
},
"methods":[
//
// MAPS
//
{
// http://developer.yahoo.com/maps/rest/V1/mapImage.html
"name":"mapImage",
"serviceURL": "http://api.local.yahoo.com/MapsService/V1/mapImage",
"parameters":[
{ "name":"street", "type":"STRING" },
{ "name":"city", "type":"STRING" },
{ "name":"zip", "type":"INTEGER" },
{ "name":"location", "type":"STRING" },
{ "name":"longitude", "type":"FLOAT" },
{ "name":"latitude", "type":"FLOAT" },
{ "name":"image_type", "type":"STRING" },
{ "name":"image_width", "type":"INTEGER" },
{ "name":"image_height", "type":"INTEGER" },
{ "name":"zoom", "type":"INTEGER" },
{ "name":"radius", "type":"INTEGER" }
]
},
{
// http://developer.yahoo.com/traffic/rest/V1/index.html
"name":"trafficData",
"serviceURL": "http://api.local.yahoo.com/MapsService/V1/trafficData",
"parameters":[
{ "name":"street", "type":"STRING" },
{ "name":"city", "type":"STRING" },
{ "name":"zip", "type":"INTEGER" },
{ "name":"location", "type":"STRING" },
{ "name":"longitude", "type":"FLOAT" },
{ "name":"latitude", "type":"FLOAT" },
{ "name":"severity", "type":"INTEGER" },
{ "name":"include_map", "type":"INTEGER" },
{ "name":"image_type", "type":"STRING" },
{ "name":"image_width", "type":"INTEGER" },
{ "name":"image_height", "type":"INTEGER" },
{ "name":"zoom", "type":"INTEGER" },
{ "name":"radius", "type":"INTEGER" }
]
},
//
// LOCAL SEARCH
//
{
// http://developer.yahoo.com/search/local/V3/localSearch.html
"name":"localSearch",
"serviceURL": "http://api.local.yahoo.com/LocalSearchService/V3/localSearch",
"parameters":[
{ "name":"street", "type":"STRING" },
{ "name":"city", "type":"STRING" },
{ "name":"zip", "type":"INTEGER" },
{ "name":"location", "type":"STRING" },
{ "name":"listing_id", "type":"STRING" },
{ "name":"sort", "type":"STRING" }, // "relevence", "title", "distance", or "rating"
{ "name":"start", "type":"INTEGER" },
{ "name":"radius", "type":"FLOAT" },
{ "name":"results", "type":"INTEGER" }, // 1-50, defaults to 10
{ "name":"longitude", "type":"FLOAT" },
{ "name":"latitude", "type":"FLOAT" },
{ "name":"category", "type":"INTEGER" },
{ "name":"omit_category", "type":"INTEGER" },
{ "name":"minimum_rating", "type":"INTEGER" }
]
},
//
// WEB SEARCH
//
{
// http://developer.yahoo.com/search/web/V1/webSearch.html
"name":"webSearch",
"serviceURL": "http://api.search.yahoo.com/WebSearchService/V1/webSearch",
"parameters":[
{ "name":"query", "type":"STRING" },
{ "name":"type", "type":"STRING" }, // defaults to "all"
{ "name":"region", "type":"STRING" }, // defaults to "us"
{ "name":"results", "type":"INTEGER" }, // defaults to 10
{ "name":"start", "type":"INTEGER" }, // defaults to 1
{ "name":"format", "type":"STRING" }, // defaults to "any", can be "html", "msword", "pdf", "ppt", "rst", "txt", or "xls"
{ "name":"adult_ok", "type":"INTEGER" }, // defaults to null
{ "name":"similar_ok", "type":"INTEGER" }, // defaults to null
{ "name":"language", "type":"STRING" }, // defaults to null
{ "name":"country", "type":"STRING" }, // defaults to null
{ "name":"site", "type":"STRING" }, // defaults to null
{ "name":"subscription", "type":"STRING" }, // defaults to null
{ "name":"license", "type":"STRING" } // defaults to "any"
]
},
{
// http://developer.yahoo.com/search/web/V1/spellingSuggestion.html
"name":"spellingSuggestion",
"serviceURL": "http://api.search.yahoo.com/WebSearchService/V1/spellingSuggestion",
"parameters":[ { "name":"query", "type":"STRING" } ]
},
{
// http://developer.yahoo.com/search/web/V1/relatedSuggestion.html
"name":"spellingSuggestion",
"serviceURL": "http://api.search.yahoo.com/WebSearchService/V1/relatedSuggestion",
"parameters":[
{ "name":"query", "type":"STRING" },
{ "name":"results", "type":"INTEGER" } // 1-50, defaults to 10
]
},
{
// http://developer.yahoo.com/search/content/V1/termExtraction.html
"name":"termExtraction",
"serviceURL": "http://search.yahooapis.com/ContentAnalysisService/V1/termExtraction",
"parameters":[
{ "name":"query", "type":"STRING" },
{ "name":"context", "type":"STRING" },
{ "name":"results", "type":"INTEGER" } // 1-50, defaults to 10
]
},
{
// http://developer.yahoo.com/search/web/V1/contextSearch.html
"name":"contextSearch",
"serviceURL": "http://search.yahooapis.com/WebSearchService/V1/contextSearch",
"parameters":[
{ "name":"query", "type":"STRING" },
{ "name":"context", "type":"STRING" },
{ "name":"type", "type":"STRING" }, // defaults to "all"
{ "name":"results", "type":"INTEGER" }, // defaults to 10
{ "name":"start", "type":"INTEGER" }, // defaults to 1
{ "name":"format", "type":"STRING" }, // defaults to "any", can be "html", "msword", "pdf", "ppt", "rst", "txt", or "xls"
{ "name":"adult_ok", "type":"INTEGER" }, // defaults to null
{ "name":"similar_ok", "type":"INTEGER" }, // defaults to null
{ "name":"language", "type":"STRING" }, // defaults to null
{ "name":"country", "type":"STRING" }, // defaults to null
{ "name":"site", "type":"STRING" }, // defaults to null
{ "name":"license", "type":"STRING" } // defaults to "any", could be "cc_any", "cc_commercial", "cc_modifiable"
]
},
//
// IMAGE SEARCH
//
{
// http://developer.yahoo.com/search/image/V1/imageSearch.html
"name":"imageSearch",
"serviceURL": "http://api.search.yahoo.com/ImageSearchService/V1/imageSearch",
"parameters":[
{ "name":"query", "type":"STRING" },
{ "name":"type", "type":"STRING" }, // defaults to "all", can by "any" or "phrase"
{ "name":"results", "type":"INTEGER" }, // defaults to 10
{ "name":"start", "type":"INTEGER" }, // defaults to 1
{ "name":"format", "type":"STRING" }, // defaults to "any", can be "bmp", "gif", "jpeg", or "png"
{ "name":"adult_ok", "type":"INTEGER" }, // defaults to null
{ "name":"coloration", "type":"STRING" }, // "any", "color", or "bw"
{ "name":"site", "type":"STRING" } // defaults to null
]
},
//
// SITE EXPLORER
//
{
// http://developer.yahoo.com/search/siteexplorer/V1/inlinkData.html
"name":"inlinkData",
"serviceURL": "http://api.search.yahoo.com/SiteExplorerService/V1/inlinkData",
"parameters":[
{ "name":"query", "type":"STRING" },
{ "name":"type", "type":"STRING" }, // defaults to "all", can by "any" or "phrase"
{ "name":"entire_site", "type":"INTEGER" }, // defaults to null
{ "name":"omit_inlinks", "type":"STRING" }, // "domain" or "subdomain", defaults to null
{ "name":"results", "type":"INTEGER" }, // defaults to 50
{ "name":"start", "type":"INTEGER" }, // defaults to 1
{ "name":"site", "type":"STRING" } // defaults to null
]
},
{
// http://developer.yahoo.com/search/siteexplorer/V1/pageData.html
"name":"pageData",
"serviceURL": "http://api.search.yahoo.com/SiteExplorerService/V1/pageData",
"parameters":[
{ "name":"query", "type":"STRING" },
{ "name":"type", "type":"STRING" }, // defaults to "all", can by "any" or "phrase"
{ "name":"domain_only", "type":"INTEGER" }, // defaults to null
{ "name":"results", "type":"INTEGER" }, // defaults to 50
{ "name":"start", "type":"INTEGER" }, // defaults to 1
{ "name":"site", "type":"STRING" } // defaults to null
]
},
//
// MUSIC SEARCH
//
{
// http://developer.yahoo.com/search/audio/V1/artistSearch.html
"name":"artistSearch",
"serviceURL": "http://api.search.yahoo.com/AudioSearchService/V1/artistSearch",
"parameters":[
{ "name":"artist", "type":"STRING" },
{ "name":"artistid", "type":"STRING" },
{ "name":"type", "type":"STRING" }, // "all", "any", or "phrase"
{ "name":"results", "type":"INTEGER" }, // 1-50, defaults to 10
{ "name":"start", "type":"INTEGER" } // defaults to 1
]
},
{
// http://developer.yahoo.com/search/audio/V1/albumSearch.html
"name":"albumSearch",
"serviceURL": "http://api.search.yahoo.com/AudioSearchService/V1/albumSearch",
"parameters":[
{ "name":"artist", "type":"STRING" },
{ "name":"artistid", "type":"STRING" },
{ "name":"album", "type":"STRING" },
{ "name":"type", "type":"STRING" }, // "all", "any", or "phrase"
{ "name":"results", "type":"INTEGER" }, // 1-50, defaults to 10
{ "name":"start", "type":"INTEGER" } // defaults to 1
]
},
{
// http://developer.yahoo.com/search/audio/V1/songSearch.html
"name":"songSearch",
"serviceURL": "http://api.search.yahoo.com/AudioSearchService/V1/songSearch",
"parameters":[
{ "name":"artist", "type":"STRING" },
{ "name":"artistid", "type":"STRING" },
{ "name":"album", "type":"STRING" },
{ "name":"albumid", "type":"STRING" },
{ "name":"song", "type":"STRING" },
{ "name":"songid", "type":"STRING" },
{ "name":"type", "type":"STRING" }, // "all", "any", or "phrase"
{ "name":"results", "type":"INTEGER" }, // 1-50, defaults to 10
{ "name":"start", "type":"INTEGER" } // defaults to 1
]
},
{
// http://developer.yahoo.com/search/audio/V1/songDownloadLocation.html
"name":"songDownloadLocation",
"serviceURL": "http://api.search.yahoo.com/AudioSearchService/V1/songDownloadLocation",
"parameters":[
{ "name":"songid", "type":"STRING" },
// "source" can contain:
// audiolunchbox artistdirect buymusic dmusic
// emusic epitonic garageband itunes yahoo
// livedownloads mp34u msn musicmatch mapster passalong
// rhapsody soundclick theweb
{ "name":"source", "type":"STRING" },
{ "name":"results", "type":"INTEGER" }, // 1-50, defaults to 10
{ "name":"start", "type":"INTEGER" } // defaults to 1
]
},
//
// NEWS SEARCH
//
{
// http://developer.yahoo.com/search/news/V1/newsSearch.html
"name":"newsSearch",
"serviceURL": "http://api.search.yahoo.com/NewsSearchService/V1/newsSearch",
"parameters":[
{ "name":"query", "type":"STRING" },
{ "name":"type", "type":"STRING" }, // defaults to "all"
{ "name":"results", "type":"INTEGER" }, // defaults to 10
{ "name":"start", "type":"INTEGER" }, // defaults to 1
{ "name":"sort", "type":"STRING" }, // "rank" or "date"
{ "name":"language", "type":"STRING" }, // defaults to null
{ "name":"site", "type":"STRING" } // defaults to null
]
}
]
}