IoT1ClickProjectsRequest Class
(QtAws::IoT1ClickProjects::IoT1ClickProjectsRequest)The IoT1ClickProjectsRequest class provides an interface for IoT1ClickProjects requests. More...
Public Types
| enum | Action { AssociateDeviceWithPlacementAction, CreatePlacementAction, CreateProjectAction, DeletePlacementAction, ..., UpdateProjectAction } |
| flags | Actions |
Public Functions
| IoT1ClickProjectsRequest(const Action action) | |
| IoT1ClickProjectsRequest(const IoT1ClickProjectsRequest &other) | |
| Action | action() const |
| QString | actionString() const |
| QString | apiVersion() const |
| void | setAction(const Action action) |
| void | setApiVersion(const QString &version) |
| IoT1ClickProjectsRequest & | operator=(const IoT1ClickProjectsRequest &other) |
| virtual bool | operator==(const IoT1ClickProjectsRequest &other) const |
- 7 public functions inherited from QtAws::Core::AwsAbstractRequest
Protected Functions
| IoT1ClickProjectsRequest(IoT1ClickProjectsRequestPrivate * 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 ¶meters) |
Reimplemented Protected Functions
| virtual QNetworkRequest | unsignedRequest(const QUrl &endpoint) const override |
- 4 protected functions inherited from QtAws::Core::AwsAbstractRequest
Detailed Description
The IoT1ClickProjectsRequest class provides an interface for IoT1ClickProjects requests.
Member Type Documentation
enum IoT1ClickProjectsRequest::Action
flags IoT1ClickProjectsRequest::Actions
This enum describes the actions that can be performed as IoT1ClickProjects requests.
| Constant | Value | Description |
|---|---|---|
QtAws::IoT1ClickProjects::IoT1ClickProjectsRequest::AssociateDeviceWithPlacementAction | 0 | IoT1ClickProjects AssociateDeviceWithPlacement action. |
QtAws::IoT1ClickProjects::IoT1ClickProjectsRequest::CreatePlacementAction | 1 | IoT1ClickProjects CreatePlacement action. |
QtAws::IoT1ClickProjects::IoT1ClickProjectsRequest::CreateProjectAction | 2 | IoT1ClickProjects CreateProject action. |
QtAws::IoT1ClickProjects::IoT1ClickProjectsRequest::DeletePlacementAction | 3 | IoT1ClickProjects DeletePlacement action. |
QtAws::IoT1ClickProjects::IoT1ClickProjectsRequest::DeleteProjectAction | 4 | IoT1ClickProjects DeleteProject action. |
QtAws::IoT1ClickProjects::IoT1ClickProjectsRequest::DescribePlacementAction | 5 | IoT1ClickProjects DescribePlacement action. |
QtAws::IoT1ClickProjects::IoT1ClickProjectsRequest::DescribeProjectAction | 6 | IoT1ClickProjects DescribeProject action. |
QtAws::IoT1ClickProjects::IoT1ClickProjectsRequest::DisassociateDeviceFromPlacementAction | 7 | IoT1ClickProjects DisassociateDeviceFromPlacement action. |
QtAws::IoT1ClickProjects::IoT1ClickProjectsRequest::GetDevicesInPlacementAction | 8 | IoT1ClickProjects GetDevicesInPlacement action. |
QtAws::IoT1ClickProjects::IoT1ClickProjectsRequest::ListPlacementsAction | 9 | IoT1ClickProjects ListPlacements action. |
QtAws::IoT1ClickProjects::IoT1ClickProjectsRequest::ListProjectsAction | 10 | IoT1ClickProjects ListProjects action. |
QtAws::IoT1ClickProjects::IoT1ClickProjectsRequest::UpdatePlacementAction | 11 | IoT1ClickProjects UpdatePlacement action. |
QtAws::IoT1ClickProjects::IoT1ClickProjectsRequest::UpdateProjectAction | 12 | IoT1ClickProjects UpdateProject action. |
The Actions type is a typedef for QFlags<Action>. It stores an OR combination of Action values.
Member Function Documentation
IoT1ClickProjectsRequest::IoT1ClickProjectsRequest(const Action action)
Constructs a IoT1ClickProjectsRequest object for IoT1ClickProjects action.
IoT1ClickProjectsRequest::IoT1ClickProjectsRequest(const IoT1ClickProjectsRequest &other)
Constructs a copy of other.
[protected] IoT1ClickProjectsRequest::IoT1ClickProjectsRequest(IoT1ClickProjectsRequestPrivate * const d)
Constructs aa IoT1ClickProjectsRequest object with private implementation d.
This overload allows derived classes to provide their own private class implementation that inherits from IoT1ClickProjectsRequestPrivate.
Action IoT1ClickProjectsRequest::action() const
Returns the IoT1ClickProjects action to be performed by this request.
See also setAction().
QString IoT1ClickProjectsRequest::actionString() const
Returns the name of the IoT1ClickProjects action to be performed by this request.
QString IoT1ClickProjectsRequest::apiVersion() const
Returns the IoT1ClickProjects API version implemented by this request.
See also setApiVersion().
[protected] int IoT1ClickProjectsRequest::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 IoT1ClickProjectsRequest::clearParameters()
Removes all parameters from the request.
[protected] QVariant IoT1ClickProjectsRequest::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 &IoT1ClickProjectsRequest::parameters() const
Returns the parameters included in this request.
See also setParameters().
void IoT1ClickProjectsRequest::setAction(const Action action)
Sets the IoT1ClickProjects action to be performed by this request to action.
See also action().
void IoT1ClickProjectsRequest::setApiVersion(const QString &version)
Sets the IoT1ClickProjects API version to include in this request to version.
See also apiVersion().
[protected] void IoT1ClickProjectsRequest::setParameter(const QString &name, const QVariant &value)
Sets the name parameter to value.
See also parameter().
[protected] void IoT1ClickProjectsRequest::setParameters(const QVariantMap ¶meters)
Sets the paramters for this request to parameters. Any request parameters set previously will be discarded.
See also parameters().
[override virtual protected] QNetworkRequest IoT1ClickProjectsRequest::unsignedRequest(const QUrl &endpoint) const
Reimplemented from AwsAbstractRequest::unsignedRequest().
Returns a network request for the IoT1ClickProjects request using the given endpoint.
This IoT1ClickProjects 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.
IoT1ClickProjectsRequest &IoT1ClickProjectsRequest::operator=(const IoT1ClickProjectsRequest &other)
Sets the IoT1ClickProjectsRequest object to be equal to other.
[virtual] bool IoT1ClickProjectsRequest::operator==(const IoT1ClickProjectsRequest &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.