WorkSpacesRequest Class

Member Function Documentation

WorkSpacesRequest::WorkSpacesRequest(const Action action)

Constructs a WorkSpacesRequest object for WorkSpaces action.

WorkSpacesRequest::WorkSpacesRequest(const WorkSpacesRequest &other)

Constructs a copy of other.

[protected] WorkSpacesRequest::WorkSpacesRequest(WorkSpacesRequestPrivate * const d)

Constructs aa WorkSpacesRequest object with private implementation d.

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

Action WorkSpacesRequest::action() const

Returns the WorkSpaces action to be performed by this request.

See also setAction().

QString WorkSpacesRequest::actionString() const

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

QString WorkSpacesRequest::apiVersion() const

Returns the WorkSpaces API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void WorkSpacesRequest::setAction(const Action action)

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

See also action().

void WorkSpacesRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the WorkSpacesRequest object to be equal to other.

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