GatewayInfo

Owned by Aaron Allsbrook
Last updated: Feb 15, 2024 by Jeff Slavin (Unlicensed)
2 min read

Used for PublishEventRequest, SetDeviceStateRequest, and GetDeviceConfigRequest if sent through a gateway. Specify delegatedDeviceId or gatewayId. The resource path and authorization token can correspond to the device or gateway.

These cases illustrate the field’s use:

  1. The request is for a device and is not sent through a gateway. The resource path and authorization token belong to the device. gatewayInfo should NOT be set.

  2. The request is for the gateway, not for a delegated device. The resource path and authorization token belong to the gateway. gatewayInfo should NOT be set.

  3. The request has the gateway's resource path and authorization token, but the gateway requests on a device’s behalf. gatewayInfo.delegated_device_id MUST be set to the delegated device’s ID.

  4. The request has the device's resource path and authorization token and is sent through a gateway. gatewayInfo.gateway_id MUST be set to the gateway’s ID.

JSON representation

JSON representation

{ // Union field gateway_or_device can be only one of the following: "delegatedDeviceId": string, "gatewayId": string // End of list of possible types for union field gateway_or_device. }

Fields

Fields

Union field gateway_or_device. Delegated_device_id or gateway_id is set. gateway_or_device can be only one of the following:

delegatedDeviceId

string

The delegated device’s ID. Set only if the request’s resource name corresponds to the gateway.

gatewayId

string

The gateway’s ID. Set only if the request’s resource name corresponds to the delegated device.