ConnectRequest Class

Member Function Documentation

ConnectRequest::ConnectRequest(const Action action)

Constructs a ConnectRequest object for Connect action.

ConnectRequest::ConnectRequest(const ConnectRequest &other)

Constructs a copy of other.

[protected] ConnectRequest::ConnectRequest(ConnectRequestPrivate * const d)

Constructs aa ConnectRequest object with private implementation d.

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

Action ConnectRequest::action() const

Returns the Connect action to be performed by this request.

See also setAction().

QString ConnectRequest::actionString() const

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

QString ConnectRequest::apiVersion() const

Returns the Connect API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void ConnectRequest::setAction(const Action action)

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

See also action().

void ConnectRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the ConnectRequest object to be equal to other.

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