DaxRequest Class

Member Function Documentation

DaxRequest::DaxRequest(const Action action)

Constructs a DaxRequest object for DAX action.

DaxRequest::DaxRequest(const DaxRequest &other)

Constructs a copy of other.

[protected] DaxRequest::DaxRequest(DaxRequestPrivate * const d)

Constructs aa DaxRequest object with private implementation d.

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

Action DaxRequest::action() const

Returns the DAX action to be performed by this request.

See also setAction().

QString DaxRequest::actionString() const

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

QString DaxRequest::apiVersion() const

Returns the DAX API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void DaxRequest::setAction(const Action action)

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

See also action().

void DaxRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the DaxRequest object to be equal to other.

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