ConnectivityEventSettingsV1
Information regarding the connectivity event settings and action to modify them.
Trait Type: Standard
Action Mutations
Note: See Overview: Device Action Lifecycle for more information on action flows
ConnectivityEventSettingsV1SetConnectityEventSettings action
Modify writable connectivity event settings states.
Mutation Inputs
Input Name | Description | Data Type | Nullable |
deviceId | uuid of the device to which mutation should apply | ID! | false |
traitActionArgs | See table below for specific fields | connectivityEventSettingsV1SetConnectityEventSettingsArgs! | false |
ConnectivityEventSettingsV1SetConnectityEventSettingsArgs Fields
Field Name | Description | Data Type | Nullable |
receiveWifiConnectionEvents | The desired device value for receiveWifiConnectionEvents | receiveWifiConnectionEventsEnums! | false |
receiveWifiConnectionEventsEnums Values
Enumerated String | Description |
ENABLED | receiveWifiConnectionEvents is enabled. |
DISABLED | receiveWifiConnectionEvents is disabled. |
GQL Examples
Request Example
mutation ConnectivityEventSettingsV1SetConnectityEventSettings {
ConnectivityEventSettingsV1SetConnectityEventSettings(
deviceId: "9a8f6104-6c50-476e-90ee-16b9a2dafc8d"
traitActionArgs: { receiveWifiConnectionEvents: “ENABLED" }
){
deviceId
actionId
}
}Response Example
{
"data": {
"ConnectivityEventSettingsV1SetConnectityEventSettings": {
"actionId": "7eb3629a-a1c3-49f0-89b6-2831d500ac68",
"deviceId": "9a8f6104-6c50-476e-90ee-16b9a2dafc8d"
}
}
}
Reported States
Note: See Overview: Device Reported State for more information on reported state flows.
State Definitions
receiveWifiConnectionEvents State
Setting to determine if notification should publish whenever device connects/disconnects with wifi network.
Data Type: receiveWifiConnectionEventsEnums
receiveWifiConnectionEventsEnums Values
Enumerated String | Description |
ENABLED | receiveWifiConnectionEvents is enabled. |
DISABLED | receiveWifiConnectionEvents is disabled. |
UNSUPPORTED | Device does not report values for this field. |
Device State Query GQL Examples
Request Example
query Device {
device(deviceId: "9a8f6104-6c50-476e-90ee-16b9a2dafc8d") {
id
traits {
name
... on ConnectivityEventSettingsV1DeviceTrait {
name
state {
receiveWifiConnectionEvents {
reported {
value
}
}
}
}
}
}
}
Response Example
{
"data": {
"device": {
"id": "9a8f6104-6c50-476e-90ee-16b9a2dafc8d",
"traits": [
{
"name": "ConnectivityEventSettingsV1",
"state": {
"receiveWifiConnectionEvents": {
"reported": {
"value": "ENABLED"
}
}
}
}
]
}
}
}
On this page
- ConnectivityEventSettingsV1