Adds a heartbeat to the series.
SDKs
- iOS 13.0+
- Mac Catalyst 13.0+
- watchOS 6.0+
Framework
- Health
Kit
Declaration
func addHeartbeatWithTimeInterval(sinceSeriesStartDate timeInterval: Time Interval, precededByGap: Bool, completion: @escaping (Bool, Error?) -> Void)
Parameters
timeInterval
The time of the heartbeat, measured from the series builder’s start date. This must be a positive value.
precededByGap
A Boolean value that indicates whether this heartbeat was immediately preceded by a gap in the data, indicating that one or more heartbeats may be missing.
completion
The completion handler called by the builder after it attempts to add the heartbeat to the series. The completion handler takes the following parameters:
success
A Boolean value that indicates whether the builder successfully added the heartbeat.
error
If the
success
parameter isfalse
, this contains an object that describes the error; otherwise,nil
.