CloudDirectoryRequest Class

Member Function Documentation

CloudDirectoryRequest::CloudDirectoryRequest(const Action action)

Constructs a CloudDirectoryRequest object for CloudDirectory action.

CloudDirectoryRequest::CloudDirectoryRequest(const CloudDirectoryRequest &other)

Constructs a copy of other.

[protected] CloudDirectoryRequest::CloudDirectoryRequest(CloudDirectoryRequestPrivate * const d)

Constructs aa CloudDirectoryRequest object with private implementation d.

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

Action CloudDirectoryRequest::action() const

Returns the CloudDirectory action to be performed by this request.

See also setAction().

QString CloudDirectoryRequest::actionString() const

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

QString CloudDirectoryRequest::apiVersion() const

Returns the CloudDirectory API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void CloudDirectoryRequest::setAction(const Action action)

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

See also action().

void CloudDirectoryRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the CloudDirectoryRequest object to be equal to other.

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