Osapi.http (v0.9)
- Mark Halvorson (Deactivated)
NeedsExamples
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
NameTypeDescription |
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 tag. |
Returns
TypeDescription |
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
NameTypeDescription |
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 tag. |
Returns
TypeDescription |
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
NameTypeDescription |
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 tag. |
Returns
TypeDescription |
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
NameTypeDescription |
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 tag. |
Returns
TypeDescription |
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
NameTypeDescription |
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 tag. |
Returns
TypeDescription |
A request to retrieve information an arbitrary URL. |
Description
Creates a DELETE request to an arbitrary URL.
{{ JsApiAlphaList_(v0.9) }}