LexRuntimeServiceRequest Class

Member Function Documentation

LexRuntimeServiceRequest::LexRuntimeServiceRequest(const Action action)

Constructs a LexRuntimeServiceRequest object for LexRuntimeService action.

LexRuntimeServiceRequest::LexRuntimeServiceRequest(const LexRuntimeServiceRequest &other)

Constructs a copy of other.

[protected] LexRuntimeServiceRequest::LexRuntimeServiceRequest(LexRuntimeServiceRequestPrivate * const d)

Constructs aa LexRuntimeServiceRequest object with private implementation d.

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

Action LexRuntimeServiceRequest::action() const

Returns the LexRuntimeService action to be performed by this request.

See also setAction().

QString LexRuntimeServiceRequest::actionString() const

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

QString LexRuntimeServiceRequest::apiVersion() const

Returns the LexRuntimeService API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void LexRuntimeServiceRequest::setAction(const Action action)

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

See also action().

void LexRuntimeServiceRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the LexRuntimeServiceRequest object to be equal to other.

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