API Docs for: undefined
Show:

YQLRESTClient Class

Defined in: js/yql-rest-client-oauth.js:6

Methods

_buildAuthorizationHeader

(
  • oAuthParams
)
String private

Defined in js/yql-rest-client-oauth.js:218

Creates the OAuth Authorization Header

Parameters:

Returns:

String:

_encode

(
  • string
)
String private

Defined in js/yql-rest-client-oauth.js:233

Performs the more strict version of URL Encode required by OAuth.

Parameters:

Returns:

String:

_normalizeParameters

(
  • content
  • oAuthParams
  • query
)
String private

Defined in js/yql-rest-client-oauth.js:250

Performs paramater sorting and normalization required by OAuth.

Parameters:

  • content Object

    Parameters from POST or PUT body content

  • oAuthParams Object

    Parameters from OAuth

  • query Object

    Parameters from the query string.

Returns:

String:

_randomString

() String private

Defined in js/yql-rest-client-oauth.js:298

Generates a random string containing digits and upper-case letters.

Returns:

String:

request

(
  • params
  • callbackFunction
  • yqlParams
  • yqlOpts
)

Defined in js/yql-rest-client-oauth.js:11

Sends a REST request.

Parameters:

  • params Object

    Request parameters object.

    accept
    Specifies the type of content to send in the response using the Accept HTTP header. This tells YQL what kind of data format you want returned, as well as how to parse it.
    content
    The body content of a POST or PUT request. This can be an object or a string. If an object is used, contentType is assumed to be application/x-www-form-urlencoded.
    contentType
    Specifies the content-type of the body content of a POST or PUT request.
    fallbackCharsets
    Overrides the list of fallback character sets, which is set to "utf-8, iso-8859-1" by default, for decoding the returned response. YQL attempts to decode the response using the character sets listed here when the response either does not specify the character set or specifies an incorrect character set that results in a failed decoding. This value may be an array of strings or one string with comma separated values.
    forceCharset
    Forces YQL to use the character set specified. Using this overrides both the character set specified by the response and the fallback character sets.
    headers
    Adds HTTP headers to the request.
    jsonCompat
    Set this value to 'new' to get "lossless" JSON when making a REST call to a Web service. jsonCompat: 'new' must also be set in the yqlParams object.
    method
    The HTTP method to use. Must be one of 'DELETE', 'GET', 'HEAD', 'POST' or 'PUT'.
    oAuth
    oAuth is an object with the following members:
    consumer
    an object with two members: key and secret
    signatureMethod
    must be either 'HMAC-SHA1' or 'PLAINTEXT'
    token
    an optional object with three optional members: key, verifier, and secret.
    query
    Query parameters to add to the request.
    timeout
    Specifies the request timeout in milliseconds. This is useful when you want to cancel requests that take longer than expected.
    url
    Provides a URL endpoint to query. The url scheme and host must be lower case. If you are using the default port, there must not be a port specified in the url. Querystring parameters must be defined in the query member and not part of the url string.
  • callbackFunction Function

    The response object is the only parameter.

  • yqlParams Object

    (optional) Passes through to Y.YQL.

  • yqlOpts Object

    (optional) Passes through to Y.YQL.