FmsRequest Class

Member Function Documentation

FmsRequest::FmsRequest(const Action action)

Constructs a FmsRequest object for FMS action.

FmsRequest::FmsRequest(const FmsRequest &other)

Constructs a copy of other.

[protected] FmsRequest::FmsRequest(FmsRequestPrivate * const d)

Constructs aa FmsRequest object with private implementation d.

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

Action FmsRequest::action() const

Returns the FMS action to be performed by this request.

See also setAction().

QString FmsRequest::actionString() const

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

QString FmsRequest::apiVersion() const

Returns the FMS API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void FmsRequest::setAction(const Action action)

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

See also action().

void FmsRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the FmsRequest object to be equal to other.

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