WorkDocsRequest Class

Member Function Documentation

WorkDocsRequest::WorkDocsRequest(const Action action)

Constructs a WorkDocsRequest object for WorkDocs action.

WorkDocsRequest::WorkDocsRequest(const WorkDocsRequest &other)

Constructs a copy of other.

[protected] WorkDocsRequest::WorkDocsRequest(WorkDocsRequestPrivate * const d)

Constructs aa WorkDocsRequest object with private implementation d.

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

Action WorkDocsRequest::action() const

Returns the WorkDocs action to be performed by this request.

See also setAction().

QString WorkDocsRequest::actionString() const

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

QString WorkDocsRequest::apiVersion() const

Returns the WorkDocs API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void WorkDocsRequest::setAction(const Action action)

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

See also action().

void WorkDocsRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the WorkDocsRequest object to be equal to other.

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