IoTRequest Class

Member Function Documentation

IoTRequest::IoTRequest(const Action action)

Constructs a IoTRequest object for IoT action.

IoTRequest::IoTRequest(const IoTRequest &other)

Constructs a copy of other.

[protected] IoTRequest::IoTRequest(IoTRequestPrivate * const d)

Constructs aa IoTRequest object with private implementation d.

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

Action IoTRequest::action() const

Returns the IoT action to be performed by this request.

See also setAction().

QString IoTRequest::actionString() const

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

QString IoTRequest::apiVersion() const

Returns the IoT API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void IoTRequest::setAction(const Action action)

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

See also action().

void IoTRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the IoTRequest object to be equal to other.

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