com.google.api.services.homegraph.v1

Class HomeGraphService.Devices

java.lang.Object

com.google.api.services.homegraph.v1.HomeGraphService.Devices

Enclosing class:

HomeGraphService

public class HomeGraphService.Devices extends Object

The "devices" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	HomeGraphService.Devices.Query
class	HomeGraphService.Devices.ReportStateAndNotification
class	HomeGraphService.Devices.RequestSync
class	HomeGraphService.Devices.Sync

Constructor Summary

Constructors

Constructor and Description
Devices()

Method Summary

Modifier and Type	Method and Description
HomeGraphService.Devices.Query	query(QueryRequest content) Gets the current states in Home Graph for the given set of the third-party user's devices.
HomeGraphService.Devices.ReportStateAndNotification	reportStateAndNotification(ReportStateAndNotificationRequest content) Reports device state and optionally sends device notifications.
HomeGraphService.Devices.RequestSync	requestSync(RequestSyncDevicesRequest content) Requests Google to send an `action.devices.SYNC` [intent](https://developers.home.google.com/cloud-to-cloud/intents/sync) to your smart home Action to update device metadata for the given user.
HomeGraphService.Devices.Sync	sync(SyncRequest content) Gets all the devices associated with the given third-party user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Devices

public Devices()

Method Detail

query

public HomeGraphService.Devices.Query query(QueryRequest content)                                      throws IOException

Gets the current states in Home Graph for the given set of the third-party user's devices. The third-party user's identity is passed in via the `agent_user_id` (see QueryRequest). This request must be authorized using service account credentials from your Actions console project. Create a request for the method "devices.query". This request holds the parameters needed by the homegraph server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

content - the QueryRequest

Returns:

the request

Throws:

IOException

reportStateAndNotification

public HomeGraphService.Devices.ReportStateAndNotification reportStateAndNotification(ReportStateAndNotificationRequest content)                                                                                throws IOException

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](https://developers.home.google.com/cloud-to- cloud/integration/report-state) for more information. This method updates the device state according to its declared [traits](https://developers.home.google.com/cloud-to- cloud/primer/device-types-and-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. Create a request for the method "devices.reportStateAndNotification". This request holds the parameters needed by the homegraph server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

content - the ReportStateAndNotificationRequest

Returns:

the request

Throws:

IOException

requestSync

public HomeGraphService.Devices.RequestSync requestSync(RequestSyncDevicesRequest content)                                                  throws IOException

Requests Google to send an `action.devices.SYNC` [intent](https://developers.home.google.com/cloud-to-cloud/intents/sync) to your smart home Action to update device metadata for the given user. The third-party user's identity is passed via the `agent_user_id` (see RequestSyncDevicesRequest). This request must be authorized using service account credentials from your Actions console project. Create a request for the method "devices.requestSync". This request holds the parameters needed by the homegraph server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

content - the RequestSyncDevicesRequest

Returns:

the request

Throws:

IOException

sync

public HomeGraphService.Devices.Sync sync(SyncRequest content)                                    throws IOException

Gets all the devices associated with the given third-party user. The third-party user's identity is passed in via the `agent_user_id` (see SyncRequest). This request must be authorized using service account credentials from your Actions console project. Create a request for the method "devices.sync". This request holds the parameters needed by the homegraph server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

content - the SyncRequest

Returns:

the request

Throws:

IOException