IoTDataPlaneClient Class
(QtAws::IoTDataPlane::IoTDataPlaneClient)The IoTDataPlaneClient class provides access to the AWS IoT Data Plane service. More...
| Header: | #include <IoTDataPlaneClient> |
| Inherits: | QtAws::Core::AwsAbstractClient |
Public Functions
| IoTDataPlaneClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0) | |
| IoTDataPlaneClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0) |
- 12 public functions inherited from QtAws::Core::AwsAbstractClient
Public Slots
| DeleteThingShadowResponse * | deleteThingShadow(const DeleteThingShadowRequest &request) |
| GetThingShadowResponse * | getThingShadow(const GetThingShadowRequest &request) |
| PublishResponse * | publish(const PublishRequest &request) |
| UpdateThingShadowResponse * | updateThingShadow(const UpdateThingShadowRequest &request) |
Additional Inherited Members
- 2 protected functions inherited from QtAws::Core::AwsAbstractClient
Detailed Description
The IoTDataPlaneClient class provides access to the AWS IoT Data Plane service.
<fullname>AWS IoT</fullname>
AWS IoT-Data enables secure, bi-directional communication between Internet-connected things (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud. It implements a broker for applications and things to publish messages over HTTP (Publish) and retrieve, update, and delete thing shadows. A thing shadow is a persistent representation of your things and their state in the AWS
Member Function Documentation
IoTDataPlaneClient::IoTDataPlaneClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)
Constructs a IoTDataPlaneClient object.
The new client object will region, credentials, and manager for network operations.
The new object will be owned by parent, if set.
IoTDataPlaneClient::IoTDataPlaneClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)
This function overloads IoTDataPlaneClient().
This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).
See also QtAws::Core::AwsEndpoint::getEndpoint.
[slot] DeleteThingShadowResponse *IoTDataPlaneClient::deleteThingShadow(const DeleteThingShadowRequest &request)
Sends request to the IoTDataPlaneClient service, and returns a pointer to an DeleteThingShadowResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Deletes the thing shadow for the specified
thing>
For more information, see <a href="http://docs.aws.amazon.com/iot/latest/developerguide/API_DeleteThingShadow.html">DeleteThingShadow</a> in the <i>AWS IoT Developer
[slot] GetThingShadowResponse *IoTDataPlaneClient::getThingShadow(const GetThingShadowRequest &request)
Sends request to the IoTDataPlaneClient service, and returns a pointer to an GetThingShadowResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Gets the thing shadow for the specified
thing>
For more information, see <a href="http://docs.aws.amazon.com/iot/latest/developerguide/API_GetThingShadow.html">GetThingShadow</a> in the <i>AWS IoT Developer
[slot] PublishResponse *IoTDataPlaneClient::publish(const PublishRequest &request)
Sends request to the IoTDataPlaneClient service, and returns a pointer to an PublishResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Publishes state
information>
For more information, see <a href="http://docs.aws.amazon.com/iot/latest/developerguide/protocols.html#http">HTTP Protocol</a> in the <i>AWS IoT Developer
[slot] UpdateThingShadowResponse *IoTDataPlaneClient::updateThingShadow(const UpdateThingShadowRequest &request)
Sends request to the IoTDataPlaneClient service, and returns a pointer to an UpdateThingShadowResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Updates the thing shadow for the specified
thing>
For more information, see <a href="http://docs.aws.amazon.com/iot/latest/developerguide/API_UpdateThingShadow.html">UpdateThingShadow</a> in the <i>AWS IoT Developer
© 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.