MTurkRequest Class

Member Function Documentation

MTurkRequest::MTurkRequest(const Action action)

Constructs a MTurkRequest object for MTurk action.

MTurkRequest::MTurkRequest(const MTurkRequest &other)

Constructs a copy of other.

[protected] MTurkRequest::MTurkRequest(MTurkRequestPrivate * const d)

Constructs aa MTurkRequest object with private implementation d.

This overload allows derived classes to provide their own private class implementation that inherits from MTurkRequestPrivate.

Action MTurkRequest::action() const

Returns the MTurk action to be performed by this request.

See also setAction().

QString MTurkRequest::actionString() const

Returns the name of the MTurk action to be performed by this request.

QString MTurkRequest::apiVersion() const

Returns the MTurk API version implemented by this request.

See also setApiVersion().

[protected] int MTurkRequest::clearParameter(const QString &name)

Removes the a name parameter from the request, then returns the number of paramters removed (typically 0 or 1).

[protected] void MTurkRequest::clearParameters()

Removes all parameters from the request.

[protected] QVariant MTurkRequest::parameter(const QString &name, const QVariant &defaultValue = QVariant()) const

Returns the value of the name pararemter if set; defaultValue otherwise.

See also setParameter().

[protected] const QVariantMap &MTurkRequest::parameters() const

Returns the parameters included in this request.

See also setParameters().

void MTurkRequest::setAction(const Action action)

Sets the MTurk action to be performed by this request to action.

See also action().

void MTurkRequest::setApiVersion(const QString &version)

Sets the MTurk API version to include in this request to version.

See also apiVersion().

[protected] void MTurkRequest::setParameter(const QString &name, const QVariant &value)

Sets the name parameter to value.

See also parameter().

[protected] void MTurkRequest::setParameters(const QVariantMap &parameters)

Sets the paramters for this request to parameters. Any request parameters set previously will be discarded.

See also parameters().

[override virtual protected] QNetworkRequest MTurkRequest::unsignedRequest(const QUrl &endpoint) const

Reimplemented from AwsAbstractRequest::unsignedRequest().

Returns a network request for the MTurk request using the given endpoint.

This MTurk implementation builds request URLs by combining the common query parameters (such as Action and Version), with any that have been added (via setParameter) by child classes.

MTurkRequest &MTurkRequest::operator=(const MTurkRequest &other)

Sets the MTurkRequest object to be equal to other.

[virtual] bool MTurkRequest::operator==(const MTurkRequest &other) const

Returns true if this request is equal to other; false otherwise.

Note, most derived *Request classes do not need to provider their own implementations of this function, since most such request classes rely on this class' parameters functionality for all request parameters, and that parameters map is already checked via this implementation.