Subscription
About subscriptions
The Subscription type defines GraphQL operations that subscribe to ongoing
events, for as long as the subscription connection persists.
Subscriptions to the Worlds server are handled using either the Server-Sent
Events (SSE) protocol or the graphql-transport-ws protocol as defined by the
graphql-ws library. For more information, see the server
transports supported by Spring GraphQL. These
protocols are supported by most of the popular GraphQL clients for receiving
subscription information.
detectionActivity
Subscribes to changes in any Detection based on the given filter.
Type: Detection
Arguments for detectionActivity
| Name | Description |
|---|---|
filter (FilterDetectionActivityInput) | Filter detections by unique identifier of the device, unique identifier of the zone or geofence, type of the event, etc. |
zoneIntersections
Subscribes to changes in any ZoneIntersection based on the given filter.
Type: ZoneIntersectionMessage
Arguments for zoneIntersections
| Name | Description |
|---|---|
filter (FilterZoneIntersectionMessageInput) | Filter detections by unique identifier of the device, unique identifier of the zone, message state, etc. |
geofenceIntersections
Subscribes to changes in any GeofenceIntersection based on the given filter.
Type: GeofenceIntersectionMessage
Arguments for geofenceIntersections
| Name | Description |
|---|---|
filter (FilterGeofenceIntersectionMessageInput) | Filter detections by unique identifier of the device, unique identifier of the geofence, tag, message state, etc. |
eventActivity
Subscribes to changes in any Event based on the given filter.
Type: Event
Arguments for eventActivity
| Name | Description |
|---|---|
filter (FilterEventActivityInput) | Filter events by unique identifier of the event producer or type of event, etc. |
measurementActivity
Subscribes to changes in any Measurement based on the given filter.
Type: Measurement
Arguments for measurementActivity
| Name | Description |
|---|---|
filter (FilterMeasurementActivityInput) | Filter measurements by unique identifier of the sensor, type of the event, etc. |
videoActivity
Subscribes to any created Video from a given DataSource.
Type: Video
Arguments for videoActivity
| Name | Description |
|---|---|
filter (FilterVideoActivityInput) | Filter videos by unique identifier of the data source. |