KmsRequest Class

Member Function Documentation

KmsRequest::KmsRequest(const Action action)

Constructs a KmsRequest object for KMS action.

KmsRequest::KmsRequest(const KmsRequest &other)

Constructs a copy of other.

[protected] KmsRequest::KmsRequest(KmsRequestPrivate * const d)

Constructs aa KmsRequest object with private implementation d.

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

Action KmsRequest::action() const

Returns the KMS action to be performed by this request.

See also setAction().

QString KmsRequest::actionString() const

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

QString KmsRequest::apiVersion() const

Returns the KMS API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void KmsRequest::setAction(const Action action)

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

See also action().

void KmsRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the KmsRequest object to be equal to other.

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