SesRequest Class

Member Function Documentation

SesRequest::SesRequest(const Action action)

Constructs a SesRequest object for SES action.

SesRequest::SesRequest(const SesRequest &other)

Constructs a copy of other.

[protected] SesRequest::SesRequest(SesRequestPrivate * const d)

Constructs aa SesRequest object with private implementation d.

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

Action SesRequest::action() const

Returns the SES action to be performed by this request.

See also setAction().

QString SesRequest::actionString() const

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

QString SesRequest::apiVersion() const

Returns the SES API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void SesRequest::setAction(const Action action)

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

See also action().

void SesRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the SesRequest object to be equal to other.

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