SqsRequest Class

Member Function Documentation

SqsRequest::SqsRequest(const Action action)

Constructs a SqsRequest object for SQS action.

SqsRequest::SqsRequest(const SqsRequest &other)

Constructs a copy of other.

[protected] SqsRequest::SqsRequest(SqsRequestPrivate * const d)

Constructs aa SqsRequest object with private implementation d.

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

Action SqsRequest::action() const

Returns the SQS action to be performed by this request.

See also setAction().

QString SqsRequest::actionString() const

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

QString SqsRequest::apiVersion() const

Returns the SQS API version implemented by this request.

See also setApiVersion().

[protected] int SqsRequest::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 SqsRequest::clearParameters()

Removes all parameters from the request.

[protected] QVariant SqsRequest::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 &SqsRequest::parameters() const

Returns the parameters included in this request.

See also setParameters().

void SqsRequest::setAction(const Action action)

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

See also action().

void SqsRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

[protected] void SqsRequest::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 SqsRequest::unsignedRequest(const QUrl &endpoint) const

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

This SQS 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.

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

Sets the SqsRequest object to be equal to other.

[virtual] bool SqsRequest::operator==(const SqsRequest &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.