com.google.gdata.client

Interface GDataProtocol.Parameter

All Known Subinterfaces:

GDataProtocol.Query

Enclosing class:

GDataProtocol

public static interface GDataProtocol.Parameter

The Parameters interface defines basic query parameter names used within the Data protocol.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALT The ALT parameter is used to request an alternate output representation.
static String	CALLBACK The CALLBACK parameter is used to specify the name of the JavaScript callback function that should be invoked when the response is received for in-script response formats.
static String	CONTEXT The CONTEXT parameter is added into the envelope of any JSONC element that is output.
static String	FIELDS The FIELDS parameters is used to specify a field selection that will be used to provide a partial response containing only the selected fields.
static String	LANGUAGE The HL query parameter selects the language of the automatically-generated text in the result.
static String	PRETTYPRINT The PRETTYPRINT parameter requests that character-based output representations have their content be pretty-printed for debugging.
static String	REQID The REQID parameter is forwarded to a JavaScript callback function that is invoked.
static String	STRICT The STRICT parameter is used to tell the server to parse in strict mode, which will reject any unknown query parameters or xml content.
static String	VERSION The VERSION parameter used to request a specific version.
static String	XOAUTH_REQUESTOR_ID The XOAUTH_REQUESTOR_ID parameter is used in 2 Legged OAuth to specify the email address of the user whose data is being accessed.

Field Detail

ALT

static final String ALT

The ALT parameter is used to request an alternate output representation.

See Also:

Constant Field Values

VERSION

static final String VERSION

The VERSION parameter used to request a specific version. The value of the parameter will be in the format <major>.<minor> and will be interpreted relative to the version model of the target service. The GDataProtocol.Header.VERSION header (if present on the same request) will have precedence.

See Also:

Constant Field Values

STRICT

static final String STRICT

The STRICT parameter is used to tell the server to parse in strict mode, which will reject any unknown query parameters or xml content.

See Also:

Constant Field Values

LANGUAGE

static final String LANGUAGE

The HL query parameter selects the language of the automatically-generated text in the result. The value is a language code as defined by BCP 47.

See Also:

Constant Field Values

PRETTYPRINT

static final String PRETTYPRINT

The PRETTYPRINT parameter requests that character-based output representations have their content be pretty-printed for debugging. A value of "true" selects pretty-printing, otherwise responses will not be formatted.

See Also:

Constant Field Values

CALLBACK

static final String CALLBACK

The CALLBACK parameter is used to specify the name of the JavaScript callback function that should be invoked when the response is received for in-script response formats. The default callback (if unspecified) is "gdata.io.handleScriptLoaded".

See Also:

Constant Field Values

REQID

static final String REQID

The REQID parameter is forwarded to a JavaScript callback function that is invoked. It must be a number. By default no reqid is available so the callback function will only get one parameter.

See Also:

Constant Field Values

CONTEXT

static final String CONTEXT

The CONTEXT parameter is added into the envelope of any JSONC element that is output. It can be any string.

See Also:

Constant Field Values

FIELDS

static final String FIELDS

The FIELDS parameters is used to specify a field selection that will be used to provide a partial response containing only the selected fields.

See Also:

Constant Field Values

XOAUTH_REQUESTOR_ID

static final String XOAUTH_REQUESTOR_ID

The XOAUTH_REQUESTOR_ID parameter is used in 2 Legged OAuth to specify the email address of the user whose data is being accessed.

See Also:

Constant Field Values