Aws::Iotshadow::ClientV2 Class Reference

Inheritance diagram for Aws::Iotshadow::ClientV2:

Public Member Functions
	ClientV2 (Aws::Crt::Allocator *allocator, std::shared_ptr< Aws::Iot::RequestResponse::IMqttRequestResponseClient > bindingClient)
virtual	~ClientV2 ()=default
bool	DeleteNamedShadow (const DeleteNamedShadowRequest &request, const DeleteNamedShadowResultHandler &handler) override
bool	DeleteShadow (const DeleteShadowRequest &request, const DeleteShadowResultHandler &handler) override
bool	GetNamedShadow (const GetNamedShadowRequest &request, const GetNamedShadowResultHandler &handler) override
bool	GetShadow (const GetShadowRequest &request, const GetShadowResultHandler &handler) override
bool	UpdateNamedShadow (const UpdateNamedShadowRequest &request, const UpdateNamedShadowResultHandler &handler) override
bool	UpdateShadow (const UpdateShadowRequest &request, const UpdateShadowResultHandler &handler) override
std::shared_ptr< Aws::Iot::RequestResponse::IStreamingOperation >	CreateNamedShadowDeltaUpdatedStream (const NamedShadowDeltaUpdatedSubscriptionRequest &request, const Aws::Iot::RequestResponse::StreamingOperationOptions< ShadowDeltaUpdatedEvent > &options) override
std::shared_ptr< Aws::Iot::RequestResponse::IStreamingOperation >	CreateNamedShadowUpdatedStream (const NamedShadowUpdatedSubscriptionRequest &request, const Aws::Iot::RequestResponse::StreamingOperationOptions< ShadowUpdatedEvent > &options) override
std::shared_ptr< Aws::Iot::RequestResponse::IStreamingOperation >	CreateShadowDeltaUpdatedStream (const ShadowDeltaUpdatedSubscriptionRequest &request, const Aws::Iot::RequestResponse::StreamingOperationOptions< ShadowDeltaUpdatedEvent > &options) override
std::shared_ptr< Aws::Iot::RequestResponse::IStreamingOperation >	CreateShadowUpdatedStream (const ShadowUpdatedSubscriptionRequest &request, const Aws::Iot::RequestResponse::StreamingOperationOptions< ShadowUpdatedEvent > &options) override
Public Member Functions inherited from Aws::Iotshadow::IClientV2
virtual	~IClientV2 ()=default

Constructor & Destructor Documentation

ClientV2()

Aws::Iotshadow::ClientV2::ClientV2	(	Aws::Crt::Allocator *	allocator,
		std::shared_ptr< Aws::Iot::RequestResponse::IMqttRequestResponseClient >	bindingClient )

~ClientV2()

virtual Aws::Iotshadow::ClientV2::~ClientV2 ( )

virtualdefault

Member Function Documentation

CreateNamedShadowDeltaUpdatedStream()

std::shared_ptr< Aws::Iot::RequestResponse::IStreamingOperation > Aws::Iotshadow::ClientV2::CreateNamedShadowDeltaUpdatedStream ( const NamedShadowDeltaUpdatedSubscriptionRequest & request, const Aws::Iot::RequestResponse::StreamingOperationOptions< ShadowDeltaUpdatedEvent > & options )

overridevirtual

Create a stream for NamedShadowDelta events for a named shadow of an AWS IoT thing.

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-delta-pub-sub-topic

Parameters

request	Modeled streaming operation subscription configuration.
options	Configuration options for the streaming operation.

Returns

A streaming operation which will emit a modeled event every time a message is received on the associated MQTT topic.

Implements Aws::Iotshadow::IClientV2.

CreateNamedShadowUpdatedStream()

std::shared_ptr< Aws::Iot::RequestResponse::IStreamingOperation > Aws::Iotshadow::ClientV2::CreateNamedShadowUpdatedStream ( const NamedShadowUpdatedSubscriptionRequest & request, const Aws::Iot::RequestResponse::StreamingOperationOptions< ShadowUpdatedEvent > & options )

overridevirtual

Create a stream for ShadowUpdated events for a named shadow of an AWS IoT thing.

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-documents-pub-sub-topic

Parameters

request	Modeled streaming operation subscription configuration.
options	Configuration options for the streaming operation.

Returns

A streaming operation which will emit a modeled event every time a message is received on the associated MQTT topic.

Implements Aws::Iotshadow::IClientV2.

CreateShadowDeltaUpdatedStream()

std::shared_ptr< Aws::Iot::RequestResponse::IStreamingOperation > Aws::Iotshadow::ClientV2::CreateShadowDeltaUpdatedStream ( const ShadowDeltaUpdatedSubscriptionRequest & request, const Aws::Iot::RequestResponse::StreamingOperationOptions< ShadowDeltaUpdatedEvent > & options )

overridevirtual

Create a stream for ShadowDelta events for the (classic) shadow of an AWS IoT thing.

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-delta-pub-sub-topic

Parameters

request	Modeled streaming operation subscription configuration.
options	Configuration options for the streaming operation.

Returns

A streaming operation which will emit a modeled event every time a message is received on the associated MQTT topic.

Implements Aws::Iotshadow::IClientV2.

CreateShadowUpdatedStream()

std::shared_ptr< Aws::Iot::RequestResponse::IStreamingOperation > Aws::Iotshadow::ClientV2::CreateShadowUpdatedStream ( const ShadowUpdatedSubscriptionRequest & request, const Aws::Iot::RequestResponse::StreamingOperationOptions< ShadowUpdatedEvent > & options )

overridevirtual

Create a stream for ShadowUpdated events for the (classic) shadow of an AWS IoT thing.

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-documents-pub-sub-topic

Parameters

request	Modeled streaming operation subscription configuration.
options	Configuration options for the streaming operation.

Returns

A streaming operation which will emit a modeled event every time a message is received on the associated MQTT topic.

Implements Aws::Iotshadow::IClientV2.

DeleteNamedShadow()

bool Aws::Iotshadow::ClientV2::DeleteNamedShadow ( const DeleteNamedShadowRequest & request, const DeleteNamedShadowResultHandler & handler )

overridevirtual

Deletes a named shadow for an AWS IoT thing.

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#delete-pub-sub-topic

Parameters

request	operation to perform
handler	function object to invoke upon operation completion

Returns

success/failure

Implements Aws::Iotshadow::IClientV2.

DeleteShadow()

bool Aws::Iotshadow::ClientV2::DeleteShadow ( const DeleteShadowRequest & request, const DeleteShadowResultHandler & handler )

overridevirtual

Deletes the (classic) shadow for an AWS IoT thing.

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#delete-pub-sub-topic

Parameters

request	operation to perform
handler	function object to invoke upon operation completion

Returns

success/failure

Implements Aws::Iotshadow::IClientV2.

GetNamedShadow()

bool Aws::Iotshadow::ClientV2::GetNamedShadow ( const GetNamedShadowRequest & request, const GetNamedShadowResultHandler & handler )

overridevirtual

Gets a named shadow for an AWS IoT thing.

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#get-pub-sub-topic

Parameters

request	operation to perform
handler	function object to invoke upon operation completion

Returns

success/failure

Implements Aws::Iotshadow::IClientV2.

GetShadow()

bool Aws::Iotshadow::ClientV2::GetShadow ( const GetShadowRequest & request, const GetShadowResultHandler & handler )

overridevirtual

Gets the (classic) shadow for an AWS IoT thing.

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#get-pub-sub-topic

Parameters

request	operation to perform
handler	function object to invoke upon operation completion

Returns

success/failure

Implements Aws::Iotshadow::IClientV2.

UpdateNamedShadow()

bool Aws::Iotshadow::ClientV2::UpdateNamedShadow ( const UpdateNamedShadowRequest & request, const UpdateNamedShadowResultHandler & handler )

overridevirtual

Update a named shadow for a device.

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-pub-sub-topic

Parameters

request	operation to perform
handler	function object to invoke upon operation completion

Returns

success/failure

Implements Aws::Iotshadow::IClientV2.

UpdateShadow()

bool Aws::Iotshadow::ClientV2::UpdateShadow ( const UpdateShadowRequest & request, const UpdateShadowResultHandler & handler )

overridevirtual

Update a device's (classic) shadow.

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-pub-sub-topic

Parameters

request	operation to perform
handler	function object to invoke upon operation completion

Returns

success/failure

Implements Aws::Iotshadow::IClientV2.

---

The documentation for this class was generated from the following file:

• shadow/source/IotShadowClientV2.cpp