OrganizationsRequest Class

Member Function Documentation

OrganizationsRequest::OrganizationsRequest(const Action action)

Constructs a OrganizationsRequest object for Organizations action.

OrganizationsRequest::OrganizationsRequest(const OrganizationsRequest &other)

Constructs a copy of other.

[protected] OrganizationsRequest::OrganizationsRequest(OrganizationsRequestPrivate * const d)

Constructs aa OrganizationsRequest object with private implementation d.

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

Action OrganizationsRequest::action() const

Returns the Organizations action to be performed by this request.

See also setAction().

QString OrganizationsRequest::actionString() const

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

QString OrganizationsRequest::apiVersion() const

Returns the Organizations API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void OrganizationsRequest::setAction(const Action action)

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

See also action().

void OrganizationsRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the OrganizationsRequest object to be equal to other.

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