SfnRequest Class

Member Function Documentation

SfnRequest::SfnRequest(const Action action)

Constructs a SfnRequest object for SFN action.

SfnRequest::SfnRequest(const SfnRequest &other)

Constructs a copy of other.

[protected] SfnRequest::SfnRequest(SfnRequestPrivate * const d)

Constructs aa SfnRequest object with private implementation d.

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

Action SfnRequest::action() const

Returns the SFN action to be performed by this request.

See also setAction().

QString SfnRequest::actionString() const

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

QString SfnRequest::apiVersion() const

Returns the SFN API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void SfnRequest::setAction(const Action action)

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

See also action().

void SfnRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the SfnRequest object to be equal to other.

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