MobileAnalyticsRequest Class

Member Function Documentation

MobileAnalyticsRequest::MobileAnalyticsRequest(const Action action)

Constructs a MobileAnalyticsRequest object for MobileAnalytics action.

MobileAnalyticsRequest::MobileAnalyticsRequest(const MobileAnalyticsRequest &other)

Constructs a copy of other.

[protected] MobileAnalyticsRequest::MobileAnalyticsRequest(MobileAnalyticsRequestPrivate * const d)

Constructs aa MobileAnalyticsRequest object with private implementation d.

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

Action MobileAnalyticsRequest::action() const

Returns the MobileAnalytics action to be performed by this request.

See also setAction().

QString MobileAnalyticsRequest::actionString() const

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

QString MobileAnalyticsRequest::apiVersion() const

Returns the MobileAnalytics API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void MobileAnalyticsRequest::setAction(const Action action)

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

See also action().

void MobileAnalyticsRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the MobileAnalyticsRequest object to be equal to other.

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