SnsRequest Class

Member Function Documentation

SnsRequest::SnsRequest(const Action action)

Constructs a SnsRequest object for SNS action.

SnsRequest::SnsRequest(const SnsRequest &other)

Constructs a copy of other.

[protected] SnsRequest::SnsRequest(SnsRequestPrivate * const d)

Constructs aa SnsRequest object with private implementation d.

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

Action SnsRequest::action() const

Returns the SNS action to be performed by this request.

See also setAction().

QString SnsRequest::actionString() const

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

QString SnsRequest::apiVersion() const

Returns the SNS API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void SnsRequest::setAction(const Action action)

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

See also action().

void SnsRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the SnsRequest object to be equal to other.

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