SupportRequest Class

Member Function Documentation

SupportRequest::SupportRequest(const Action action)

Constructs a SupportRequest object for Support action.

SupportRequest::SupportRequest(const SupportRequest &other)

Constructs a copy of other.

[protected] SupportRequest::SupportRequest(SupportRequestPrivate * const d)

Constructs aa SupportRequest object with private implementation d.

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

Action SupportRequest::action() const

Returns the Support action to be performed by this request.

See also setAction().

QString SupportRequest::actionString() const

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

QString SupportRequest::apiVersion() const

Returns the Support API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void SupportRequest::setAction(const Action action)

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

See also action().

void SupportRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the SupportRequest object to be equal to other.

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