MarketplaceEntitlementServiceRequest Class

(QtAws::MarketplaceEntitlementService::MarketplaceEntitlementServiceRequest)

The MarketplaceEntitlementServiceRequest class provides an interface for MarketplaceEntitlementService requests. More...

Header: #include <MarketplaceEntitlementServiceRequest>
Inherits: QtAws::Core::AwsAbstractRequest
Inherited By:

QtAws::MarketplaceEntitlementService::GetEntitlementsRequest

Public Types

enum Action { GetEntitlementsAction }
flags Actions

Public Functions

MarketplaceEntitlementServiceRequest(const Action action)
MarketplaceEntitlementServiceRequest(const MarketplaceEntitlementServiceRequest &other)
Action action() const
QString actionString() const
QString apiVersion() const
void setAction(const Action action)
void setApiVersion(const QString &version)
MarketplaceEntitlementServiceRequest &operator=(const MarketplaceEntitlementServiceRequest &other)
virtual bool operator==(const MarketplaceEntitlementServiceRequest &other) const

Protected Functions

MarketplaceEntitlementServiceRequest(MarketplaceEntitlementServiceRequestPrivate * const d)
int clearParameter(const QString &name)
void clearParameters()
QVariant parameter(const QString &name, const QVariant &defaultValue = QVariant()) const
const QVariantMap &parameters() const
void setParameter(const QString &name, const QVariant &value)
void setParameters(const QVariantMap &parameters)

Reimplemented Protected Functions

virtual QNetworkRequest unsignedRequest(const QUrl &endpoint) const override

Detailed Description

The MarketplaceEntitlementServiceRequest class provides an interface for MarketplaceEntitlementService requests.

Member Type Documentation

enum MarketplaceEntitlementServiceRequest::Action
flags MarketplaceEntitlementServiceRequest::Actions

This enum describes the actions that can be performed as MarketplaceEntitlementService requests.

ConstantValueDescription
QtAws::MarketplaceEntitlementService::MarketplaceEntitlementServiceRequest::GetEntitlementsAction0MarketplaceEntitlementService GetEntitlements action.

The Actions type is a typedef for QFlags<Action>. It stores an OR combination of Action values.

Member Function Documentation

MarketplaceEntitlementServiceRequest::MarketplaceEntitlementServiceRequest(const Action action)

Constructs a MarketplaceEntitlementServiceRequest object for MarketplaceEntitlementService action.

MarketplaceEntitlementServiceRequest::MarketplaceEntitlementServiceRequest(const MarketplaceEntitlementServiceRequest &other)

Constructs a copy of other.

[protected] MarketplaceEntitlementServiceRequest::MarketplaceEntitlementServiceRequest(MarketplaceEntitlementServiceRequestPrivate * const d)

Constructs aa MarketplaceEntitlementServiceRequest object with private implementation d.

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

Action MarketplaceEntitlementServiceRequest::action() const

Returns the MarketplaceEntitlementService action to be performed by this request.

See also setAction().

QString MarketplaceEntitlementServiceRequest::actionString() const

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

QString MarketplaceEntitlementServiceRequest::apiVersion() const

Returns the MarketplaceEntitlementService API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void MarketplaceEntitlementServiceRequest::setAction(const Action action)

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

See also action().

void MarketplaceEntitlementServiceRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the MarketplaceEntitlementServiceRequest object to be equal to other.

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

© 2018 Paul Colby Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.