PinpointRequest Class

Member Function Documentation

PinpointRequest::PinpointRequest(const Action action)

Constructs a PinpointRequest object for Pinpoint action.

PinpointRequest::PinpointRequest(const PinpointRequest &other)

Constructs a copy of other.

[protected] PinpointRequest::PinpointRequest(PinpointRequestPrivate * const d)

Constructs aa PinpointRequest object with private implementation d.

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

Action PinpointRequest::action() const

Returns the Pinpoint action to be performed by this request.

See also setAction().

QString PinpointRequest::actionString() const

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

QString PinpointRequest::apiVersion() const

Returns the Pinpoint API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void PinpointRequest::setAction(const Action action)

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

See also action().

void PinpointRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the PinpointRequest object to be equal to other.

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