SmsRequest Class

Member Function Documentation

SmsRequest::SmsRequest(const Action action)

Constructs a SmsRequest object for SMS action.

SmsRequest::SmsRequest(const SmsRequest &other)

Constructs a copy of other.

[protected] SmsRequest::SmsRequest(SmsRequestPrivate * const d)

Constructs aa SmsRequest object with private implementation d.

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

Action SmsRequest::action() const

Returns the SMS action to be performed by this request.

See also setAction().

QString SmsRequest::actionString() const

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

QString SmsRequest::apiVersion() const

Returns the SMS API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void SmsRequest::setAction(const Action action)

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

See also action().

void SmsRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the SmsRequest object to be equal to other.

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