ReaderSettingsV1
Information regarding the device reader settings and action to modify them.
Trait Type: Standard
Action Mutations
Note: See Overview: Device Action Lifecycle for more information on action flows
ReaderSettingsV1SetReaderSettings action
Modify the reader settings on the device.
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. | ReaderSettingsV1SetReaderSettingsArgs! | false |
ReaderSettingsV1SetReaderSettingsArgs Fields
Field Name | Description | Data Type | Nullable |
antiPassbackDuration | The desired anti passback duration of the device. | Int | true |
noTour | The desired noTour setting on the device. | noTourEnum | true |
noTourEnum Values
Enumerated Value | Description |
ENABLED | noTour setting is enabled. |
DISABLED | noTour setting is disabled. |
GQL Examples
Request Example
mutation ReaderSettingsV1SetReaderSettings {
ReaderSettingsV1SetReaderSettings(
deviceId: "9a8f6104-6c50-476e-90ee-16b9a2dafc8d"
traitActionArgs: { noTour: ENABLED, antiPassbackDuration: 10 }
) {
deviceId
actionId
traitName
}
}Response Example
{
"data": {
"ReaderSettingsV1SetReaderSettings": {
"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
antiPassbackDuration state
Indicates the anti passback duration of the device.
Data Type: Int
noTour state
Indicates if the device no tour settings is enabled or disabled.
Data Type: Enum
Valid Values
Enumerated Value | Description |
ENABLED | noTour setting is enabled. |
DISABLED | noTour setting is disabled. |
UNSUPPORTED | Device has not yet reported a value for this field. |
Device State Query GQL Examples
Request Example
query Device {
device(deviceId: "9a8f6104-6c50-476e-90ee-16b9a2dafc8d") {
id
traits {
... on ReaderSettingsV1DeviceTrait {
name
state {
antiPassbackDuration {
reported {
value
}
}
noTour {
reported {
value
}
}
}
}
}
}
}Response Example
{
"data": {
"device": {
"id": "9a8f6104-6c50-476e-90ee-16b9a2dafc8d",
"traits": [
{
"name": "ReaderSettingsV1",
"state": {
"antiPassbackDuration": {
"reported": {
"value": 0
}
},
"noTour": {
"reported": {
"value": "DISABLED"
}
}
}
}
]
}
}
}On this page
- ReaderSettingsV1