SwfRequest Class

Member Function Documentation

SwfRequest::SwfRequest(const Action action)

Constructs a SwfRequest object for SWF action.

SwfRequest::SwfRequest(const SwfRequest &other)

Constructs a copy of other.

[protected] SwfRequest::SwfRequest(SwfRequestPrivate * const d)

Constructs aa SwfRequest object with private implementation d.

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

Action SwfRequest::action() const

Returns the SWF action to be performed by this request.

See also setAction().

QString SwfRequest::actionString() const

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

QString SwfRequest::apiVersion() const

Returns the SWF API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void SwfRequest::setAction(const Action action)

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

See also action().

void SwfRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the SwfRequest object to be equal to other.

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