AppStreamRequest Class

Member Function Documentation

AppStreamRequest::AppStreamRequest(const Action action)

Constructs a AppStreamRequest object for AppStream action.

AppStreamRequest::AppStreamRequest(const AppStreamRequest &other)

Constructs a copy of other.

[protected] AppStreamRequest::AppStreamRequest(AppStreamRequestPrivate * const d)

Constructs aa AppStreamRequest object with private implementation d.

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

Action AppStreamRequest::action() const

Returns the AppStream action to be performed by this request.

See also setAction().

QString AppStreamRequest::actionString() const

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

QString AppStreamRequest::apiVersion() const

Returns the AppStream API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void AppStreamRequest::setAction(const Action action)

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

See also action().

void AppStreamRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the AppStreamRequest object to be equal to other.

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