MqRequest Class

Member Function Documentation

MqRequest::MqRequest(const Action action)

Constructs a MqRequest object for MQ action.

MqRequest::MqRequest(const MqRequest &other)

Constructs a copy of other.

[protected] MqRequest::MqRequest(MqRequestPrivate * const d)

Constructs aa MqRequest object with private implementation d.

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

Action MqRequest::action() const

Returns the MQ action to be performed by this request.

See also setAction().

QString MqRequest::actionString() const

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

QString MqRequest::apiVersion() const

Returns the MQ API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void MqRequest::setAction(const Action action)

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

See also action().

void MqRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the MqRequest object to be equal to other.

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