AcmRequest Class

Member Function Documentation

AcmRequest::AcmRequest(const Action action)

Constructs a AcmRequest object for ACM action.

AcmRequest::AcmRequest(const AcmRequest &other)

Constructs a copy of other.

[protected] AcmRequest::AcmRequest(AcmRequestPrivate * const d)

Constructs aa AcmRequest object with private implementation d.

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

Action AcmRequest::action() const

Returns the ACM action to be performed by this request.

See also setAction().

QString AcmRequest::actionString() const

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

QString AcmRequest::apiVersion() const

Returns the ACM API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void AcmRequest::setAction(const Action action)

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

See also action().

void AcmRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the AcmRequest object to be equal to other.

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