S3Request Class

Member Function Documentation

S3Request::S3Request(const Action action)

Constructs a S3Request object for S3 action.

S3Request::S3Request(const S3Request &other)

Constructs a copy of other.

[protected] S3Request::S3Request(S3RequestPrivate * const d)

Constructs aa S3Request object with private implementation d.

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

Action S3Request::action() const

Returns the S3 action to be performed by this request.

See also setAction().

QString S3Request::actionString() const

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

QString S3Request::apiVersion() const

Returns the S3 API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void S3Request::setAction(const Action action)

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

See also action().

void S3Request::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the S3Request object to be equal to other.

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