---
title: shouldCollectWorkoutEvents
framework: healthkit
role: symbol
role_heading: Instance Property
path: healthkit/hkliveworkoutbuilder/shouldcollectworkoutevents
---

# shouldCollectWorkoutEvents

A Boolean value that determines whether the workout builder automatically adds events generated by the workout session.

## Declaration

```swift
var shouldCollectWorkoutEvents: Bool { get set }
```

## Mentioned in

Running workout sessions

## Discussion

Discussion By default, this property is true. Set it to false if your app adds its own events to the workout builder, and you want to ignore events from the workout session. You must set this property before calling the workout builder’s beginCollection(withStart:completion:) method.

## See Also

### Monitoring and controlling the workout

- [currentWorkoutActivity](healthkit/hkliveworkoutbuilder/currentworkoutactivity.md)