WorkMailRequest Class

Member Function Documentation

WorkMailRequest::WorkMailRequest(const Action action)

Constructs a WorkMailRequest object for WorkMail action.

WorkMailRequest::WorkMailRequest(const WorkMailRequest &other)

Constructs a copy of other.

[protected] WorkMailRequest::WorkMailRequest(WorkMailRequestPrivate * const d)

Constructs aa WorkMailRequest object with private implementation d.

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

Action WorkMailRequest::action() const

Returns the WorkMail action to be performed by this request.

See also setAction().

QString WorkMailRequest::actionString() const

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

QString WorkMailRequest::apiVersion() const

Returns the WorkMail API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void WorkMailRequest::setAction(const Action action)

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

See also action().

void WorkMailRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the WorkMailRequest object to be equal to other.

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