AlexaForBusinessRequest Class

Member Function Documentation

AlexaForBusinessRequest::AlexaForBusinessRequest(const Action action)

Constructs a AlexaForBusinessRequest object for AlexaForBusiness action.

AlexaForBusinessRequest::AlexaForBusinessRequest(const AlexaForBusinessRequest &other)

Constructs a copy of other.

[protected] AlexaForBusinessRequest::AlexaForBusinessRequest(AlexaForBusinessRequestPrivate * const d)

Constructs aa AlexaForBusinessRequest object with private implementation d.

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

Action AlexaForBusinessRequest::action() const

Returns the AlexaForBusiness action to be performed by this request.

See also setAction().

QString AlexaForBusinessRequest::actionString() const

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

QString AlexaForBusinessRequest::apiVersion() const

Returns the AlexaForBusiness API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void AlexaForBusinessRequest::setAction(const Action action)

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

See also action().

void AlexaForBusinessRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the AlexaForBusinessRequest object to be equal to other.

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