IoT1ClickDevicesServiceClient Class

Member Function Documentation

IoT1ClickDevicesServiceClient::IoT1ClickDevicesServiceClient(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 IoT1ClickDevicesServiceClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

IoT1ClickDevicesServiceClient::IoT1ClickDevicesServiceClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads IoT1ClickDevicesServiceClient().

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] ClaimDevicesByClaimCodeResponse *IoT1ClickDevicesServiceClient::claimDevicesByClaimCode(const ClaimDevicesByClaimCodeRequest &request)

Sends request to the IoT1ClickDevicesServiceClient service, and returns a pointer to an ClaimDevicesByClaimCodeResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Adds device(s) to your account (i.e., claim one or more devices) if and only if you received a claim code with the

[slot] DescribeDeviceResponse *IoT1ClickDevicesServiceClient::describeDevice(const DescribeDeviceRequest &request)

Sends request to the IoT1ClickDevicesServiceClient service, and returns a pointer to an DescribeDeviceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Given a device ID, returns a DescribeDeviceResponse object describing the details of the

[slot] FinalizeDeviceClaimResponse *IoT1ClickDevicesServiceClient::finalizeDeviceClaim(const FinalizeDeviceClaimRequest &request)

Sends request to the IoT1ClickDevicesServiceClient service, and returns a pointer to an FinalizeDeviceClaimResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Given a device ID, finalizes the claim request for the associated device.</p><note>

Claiming a device consists of initiating a claim, then publishing a device event, and finalizing the claim. For a device of type button, a device event can be published by simply clicking the

[slot] GetDeviceMethodsResponse *IoT1ClickDevicesServiceClient::getDeviceMethods(const GetDeviceMethodsRequest &request)

Sends request to the IoT1ClickDevicesServiceClient service, and returns a pointer to an GetDeviceMethodsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Given a device ID, returns the invokable methods associated with the

[slot] InitiateDeviceClaimResponse *IoT1ClickDevicesServiceClient::initiateDeviceClaim(const InitiateDeviceClaimRequest &request)

Sends request to the IoT1ClickDevicesServiceClient service, and returns a pointer to an InitiateDeviceClaimResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Given a device ID, initiates a claim request for the associated device.</p><note>

Claiming a device consists of initiating a claim, then publishing a device event, and finalizing the claim. For a device of type button, a device event can be published by simply clicking the

[slot] InvokeDeviceMethodResponse *IoT1ClickDevicesServiceClient::invokeDeviceMethod(const InvokeDeviceMethodRequest &request)

Sends request to the IoT1ClickDevicesServiceClient service, and returns a pointer to an InvokeDeviceMethodResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Given a device ID, issues a request to invoke a named device method (with possible parameters). See the "Example POST" code snippet

[slot] ListDeviceEventsResponse *IoT1ClickDevicesServiceClient::listDeviceEvents(const ListDeviceEventsRequest &request)

Sends request to the IoT1ClickDevicesServiceClient service, and returns a pointer to an ListDeviceEventsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Using a device ID, returns a DeviceEventsResponse object containing an array of events for the

[slot] ListDevicesResponse *IoT1ClickDevicesServiceClient::listDevices(const ListDevicesRequest &request)

Sends request to the IoT1ClickDevicesServiceClient service, and returns a pointer to an ListDevicesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the 1-Click compatible devices associated with your AWS

[slot] UnclaimDeviceResponse *IoT1ClickDevicesServiceClient::unclaimDevice(const UnclaimDeviceRequest &request)

Sends request to the IoT1ClickDevicesServiceClient service, and returns a pointer to an UnclaimDeviceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Disassociates a device from your AWS account using its device

[slot] UpdateDeviceStateResponse *IoT1ClickDevicesServiceClient::updateDeviceState(const UpdateDeviceStateRequest &request)

Sends request to the IoT1ClickDevicesServiceClient service, and returns a pointer to an UpdateDeviceStateResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Using a Boolean value (true or false), this operation enables or disables the device given a device