reportStateAndNotification method

Future<ReportStateAndNotificationResponse> reportStateAndNotification(ReportStateAndNotificationRequest request, { String? $fields, })

Reports device state and optionally sends device notifications.

Called by your smart home Action when the state of a third-party device changes or you need to send a notification about the device. See Implement Report State for more information. This method updates the device state according to its declared traits. Publishing a new state value outside of these traits will result in an INVALID_ARGUMENT error response. The third-party user's identity is passed in via the agent_user_id (see ReportStateAndNotificationRequest). This request must be authorized using service account credentials from your Actions console project.

request - The metadata request object.

Request parameters:

$fields - Selector specifying which fields to include in a partial response.

Completes with a ReportStateAndNotificationResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async_1.Future<ReportStateAndNotificationResponse> reportStateAndNotification(
  ReportStateAndNotificationRequest request, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  const url_ = 'v1/devices:reportStateAndNotification';

  final response_ = await _requester.request(
    url_,
    'POST',
    body: body_,
    queryParams: queryParams_,
  );
  return ReportStateAndNotificationResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}