DirectoryServiceRequest Class

Member Function Documentation

DirectoryServiceRequest::DirectoryServiceRequest(const Action action)

Constructs a DirectoryServiceRequest object for DirectoryService action.

DirectoryServiceRequest::DirectoryServiceRequest(const DirectoryServiceRequest &other)

Constructs a copy of other.

[protected] DirectoryServiceRequest::DirectoryServiceRequest(DirectoryServiceRequestPrivate * const d)

Constructs aa DirectoryServiceRequest object with private implementation d.

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

Action DirectoryServiceRequest::action() const

Returns the DirectoryService action to be performed by this request.

See also setAction().

QString DirectoryServiceRequest::actionString() const

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

QString DirectoryServiceRequest::apiVersion() const

Returns the DirectoryService API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void DirectoryServiceRequest::setAction(const Action action)

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

See also action().

void DirectoryServiceRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the DirectoryServiceRequest object to be equal to other.

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