DeviceFarmRequest Class

Member Function Documentation

DeviceFarmRequest::DeviceFarmRequest(const Action action)

Constructs a DeviceFarmRequest object for DeviceFarm action.

DeviceFarmRequest::DeviceFarmRequest(const DeviceFarmRequest &other)

Constructs a copy of other.

[protected] DeviceFarmRequest::DeviceFarmRequest(DeviceFarmRequestPrivate * const d)

Constructs aa DeviceFarmRequest object with private implementation d.

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

Action DeviceFarmRequest::action() const

Returns the DeviceFarm action to be performed by this request.

See also setAction().

QString DeviceFarmRequest::actionString() const

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

QString DeviceFarmRequest::apiVersion() const

Returns the DeviceFarm API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void DeviceFarmRequest::setAction(const Action action)

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

See also action().

void DeviceFarmRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the DeviceFarmRequest object to be equal to other.

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