Difference between revisions of "Osapi.http (v0.9)"

From VZ Developer Wiki
Jump to: navigation, search
(Created page with '{{NeedsExamples}} <div style="float:right; margin: 0 0 10px 10px;">__TOC__</div> <span style="font-size:150%"><strong>osapi.http</strong></span> Service object for making HTTP …')
 
(No difference)

Latest revision as of 12:24, 29 July 2010

This documentation is not completed yet and will be extended by more examples in future.

osapi.http

Service object for making HTTP requests to third party servers. This is not a JSON-RPC endpoint, but a third party web service.

Methods

osapi.http.head

<static> osapi.Request osapi.http.head(params)
Parameters
Name Type Description
url String The URL where the content is located
params {
Map.<String, Array.<String>> headers,
String format = "json",
int refreshInterval,
String authz = "none",
Boolean sign_viewer = true,
Boolean sign_owner = true,
String oauth_service_name = "",
String oauth_token_name = "",
String oauth_request_token,
String oauth_request_token_secret,
String oauth_use_token,
}
Takes an optional parameter that is a JSON object containing parameters and values similar to the attributes of the [./OpenSocial-Data-Pipelining.xml#HttpRequest <os:HttpRequest>] tag.
Returns
Type Description
osapi.Request A request to retrieve information an arbitrary URL.
Description
Creates a HEAD request to an arbitrary URL.

osapi.http.get

<static> osapi.Request osapi.http.get(params)
Parameters
Name Type Description
url String The URL where the content is located
params {
Map.<String, Array.<String>> headers,
String format = "json",
int refreshInterval,
String authz = "none",
Boolean sign_viewer = true,
Boolean sign_owner = true,
String oauth_service_name = "",
String oauth_token_name = "",
String oauth_request_token,
String oauth_request_token_secret,
String oauth_use_token,
}
Takes an optional parameter that is a JSON object containing parameters and values similar to the attributes of the [./OpenSocial-Data-Pipelining.xml#HttpRequest <os:HttpRequest>] tag.
Returns
Type Description
osapi.Request A request to retrieve information an arbitrary URL.
Description
Creates a GET request to an arbitrary URL.

osapi.http.put

<static> osapi.Request osapi.http.put(params)
Parameters
Name Type Description
url String The URL where the content is located
params {
Map.<String, Array.<String>> headers,
String body,
String format = "json",
int refreshInterval,
String authz = "none",
Boolean sign_viewer = true,
Boolean sign_owner = true,
String oauth_service_name = "",
String oauth_token_name = "",
String oauth_request_token,
String oauth_request_token_secret,
String oauth_use_token,
}
Takes an optional parameter that is a JSON object containing parameters and values similar to the attributes of the [./OpenSocial-Data-Pipelining.xml#HttpRequest <os:HttpRequest>] tag.
Returns
Type Description
osapi.Request A request to retrieve information an arbitrary URL.
Description
Creates a PUT request to an arbitrary URL.

osapi.http.post

<static> osapi.Request osapi.http.post(params)
Parameters
Name Type Description
url String The URL where the content is located
params {
Map.<String, Array.<String>> headers,
String body,
String format = "json",
int refreshInterval,
String authz = "none",
Boolean sign_viewer = true,
Boolean sign_owner = true,
String oauth_service_name = "",
String oauth_token_name = "",
String oauth_request_token,
String oauth_request_token_secret,
String oauth_use_token,
}
Takes an optional parameter that is a JSON object containing parameters and values similar to the attributes of the [./OpenSocial-Data-Pipelining.xml#HttpRequest <os:HttpRequest>] tag.
Returns
Type Description
osapi.Request A request to retrieve information an arbitrary URL.
Description
Creates a POST request to an arbitrary URL.

osapi.http.delete

<static> osapi.Request osapi.http.delete(params)
Parameters
Name Type Description
url String The URL where the content is located
params {
Map.<String, Array.<String>> headers,
String format = "json",
int refreshInterval,
String authz = "none",
Boolean sign_viewer = true,
Boolean sign_owner = true,
String oauth_service_name = "",
String oauth_token_name = "",
String oauth_request_token,
String oauth_request_token_secret,
String oauth_use_token,
}
Takes an optional parameter that is a JSON object containing parameters and values similar to the attributes of the [./OpenSocial-Data-Pipelining.xml#HttpRequest <os:HttpRequest>] tag.
Returns
Type Description
osapi.Request A request to retrieve information an arbitrary URL.
Description
Creates a DELETE request to an arbitrary URL.



OpenSocial (v0.9)

gadgets

gadgets.io

gadgets.json

gadgets.Prefs

gadgets.util

gadgets.views

gadgets.flash

gadgets.MiniMessage

gadgets.oauth.Popup

gadgets.rpc

gadgets.skins

gadgets.pubsub

gadgets.Tab

gadgets.TabSet

gadgets.window

gadgets.i18n

opensocial

opensocial.Activity

opensocial.Address

opensocial.Album

opensocial.BodyType

opensocial.Collection

opensocial.CreateActivityPriority

opensocial.DataRequest

opensocial.DataResponse

opensocial.Email

opensocial.Enum

opensocial.Environment

opensocial.EscapeType

opensocial.IdSpec

opensocial.MediaItem

opensocial.Message

opensocial.MessageCollection

opensocial.Name

opensocial.NavigationParameters

opensocial.Organization

opensocial.Permission

opensocial.Person

opensocial.Phone

opensocial.ResponseItem

opensocial.Url

osapi.Request

osapi.BatchRequest

osapi.people

osapi.activities

osapi.appdata

osapi.messages

osapi.http