Class: Google::Apis::HomegraphV1::ReportStateAndNotificationRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/homegraph_v1/classes.rb,
generated/google/apis/homegraph_v1/representations.rb,
generated/google/apis/homegraph_v1/representations.rb

Overview

Request type for the ReportStateAndNotification call. It may include states, notifications, or both. States and notifications are defined per device_id ( for example, "123" and "456" in the following example). # Example json ` " requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "agentUserId": "1234", " payload": ` "devices": ` "states": ` "123": ` "on": true `, "456": ` "on": true, "brightness": 10 ` `, ` ` `

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ReportStateAndNotificationRequest

Returns a new instance of ReportStateAndNotificationRequest.



443
444
445
 
# File 'generated/google/apis/homegraph_v1/classes.rb', line 443

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#agent_user_id ⇒ String

Required. Third-party user ID. Corresponds to the JSON property agentUserId

Returns:

  • (String) 


418
419
420
 
# File 'generated/google/apis/homegraph_v1/classes.rb', line 418

def agent_user_id
  @agent_user_id
end

#event_id ⇒ String

Unique identifier per event (for example, a doorbell press). Corresponds to the JSON property eventId

Returns:

  • (String) 


423
424
425
 
# File 'generated/google/apis/homegraph_v1/classes.rb', line 423

def event_id
  @event_id
end

#follow_up_token ⇒ String

Token to maintain state in the follow up notification response. Deprecated. See the notifications guide for details on implementing follow up notifications. Corresponds to the JSON property followUpToken

Returns:

  • (String) 


431
432
433
 
# File 'generated/google/apis/homegraph_v1/classes.rb', line 431

def follow_up_token
  @follow_up_token
end

#payload ⇒ Google::Apis::HomegraphV1::StateAndNotificationPayload

Payload containing the state and notification information for devices. Corresponds to the JSON property payload

Returns:



436
437
438
 
# File 'generated/google/apis/homegraph_v1/classes.rb', line 436

def payload
  @payload
end

#request_id ⇒ String

Request ID used for debugging. Corresponds to the JSON property requestId

Returns:

  • (String) 


441
442
443
 
# File 'generated/google/apis/homegraph_v1/classes.rb', line 441

def request_id
  @request_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



448
449
450
451
452
453
454
 
# File 'generated/google/apis/homegraph_v1/classes.rb', line 448

def update!(**args)
  @agent_user_id = args[:agent_user_id] if args.key?(:agent_user_id)
  @event_id = args[:event_id] if args.key?(:event_id)
  @follow_up_token = args[:follow_up_token] if args.key?(:follow_up_token)
  @payload = args[:payload] if args.key?(:payload)
  @request_id = args[:request_id] if args.key?(:request_id)
end