IoT1ClickDevicesServiceRequest Class

(QtAws::IoT1ClickDevicesService::IoT1ClickDevicesServiceRequest)

The IoT1ClickDevicesServiceRequest class provides an interface for IoT1ClickDevicesService requests. More...

Public Types

enum Action { ClaimDevicesByClaimCodeAction, DescribeDeviceAction, FinalizeDeviceClaimAction, GetDeviceMethodsAction, ..., UpdateDeviceStateAction }
flags Actions

Public Functions

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

Protected Functions

IoT1ClickDevicesServiceRequest(IoT1ClickDevicesServiceRequestPrivate * 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 IoT1ClickDevicesServiceRequest class provides an interface for IoT1ClickDevicesService requests.

Member Type Documentation

enum IoT1ClickDevicesServiceRequest::Action
flags IoT1ClickDevicesServiceRequest::Actions

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

ConstantValueDescription
QtAws::IoT1ClickDevicesService::IoT1ClickDevicesServiceRequest::ClaimDevicesByClaimCodeAction0IoT1ClickDevicesService ClaimDevicesByClaimCode action.
QtAws::IoT1ClickDevicesService::IoT1ClickDevicesServiceRequest::DescribeDeviceAction1IoT1ClickDevicesService DescribeDevice action.
QtAws::IoT1ClickDevicesService::IoT1ClickDevicesServiceRequest::FinalizeDeviceClaimAction2IoT1ClickDevicesService FinalizeDeviceClaim action.
QtAws::IoT1ClickDevicesService::IoT1ClickDevicesServiceRequest::GetDeviceMethodsAction3IoT1ClickDevicesService GetDeviceMethods action.
QtAws::IoT1ClickDevicesService::IoT1ClickDevicesServiceRequest::InitiateDeviceClaimAction4IoT1ClickDevicesService InitiateDeviceClaim action.
QtAws::IoT1ClickDevicesService::IoT1ClickDevicesServiceRequest::InvokeDeviceMethodAction5IoT1ClickDevicesService InvokeDeviceMethod action.
QtAws::IoT1ClickDevicesService::IoT1ClickDevicesServiceRequest::ListDeviceEventsAction6IoT1ClickDevicesService ListDeviceEvents action.
QtAws::IoT1ClickDevicesService::IoT1ClickDevicesServiceRequest::ListDevicesAction7IoT1ClickDevicesService ListDevices action.
QtAws::IoT1ClickDevicesService::IoT1ClickDevicesServiceRequest::UnclaimDeviceAction8IoT1ClickDevicesService UnclaimDevice action.
QtAws::IoT1ClickDevicesService::IoT1ClickDevicesServiceRequest::UpdateDeviceStateAction9IoT1ClickDevicesService UpdateDeviceState action.

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

Member Function Documentation

IoT1ClickDevicesServiceRequest::IoT1ClickDevicesServiceRequest(const Action action)

Constructs a IoT1ClickDevicesServiceRequest object for IoT1ClickDevicesService action.

IoT1ClickDevicesServiceRequest::IoT1ClickDevicesServiceRequest(const IoT1ClickDevicesServiceRequest &other)

Constructs a copy of other.

[protected] IoT1ClickDevicesServiceRequest::IoT1ClickDevicesServiceRequest(IoT1ClickDevicesServiceRequestPrivate * const d)

Constructs aa IoT1ClickDevicesServiceRequest object with private implementation d.

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

Action IoT1ClickDevicesServiceRequest::action() const

Returns the IoT1ClickDevicesService action to be performed by this request.

See also setAction().

QString IoT1ClickDevicesServiceRequest::actionString() const

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

QString IoT1ClickDevicesServiceRequest::apiVersion() const

Returns the IoT1ClickDevicesService API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void IoT1ClickDevicesServiceRequest::setAction(const Action action)

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

See also action().

void IoT1ClickDevicesServiceRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the IoT1ClickDevicesServiceRequest object to be equal to other.

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