API Reference
BlogStatus PageDashboard

getMenstruation

Getter function to retrieve menstruation data from Apple Health

Instance method of TerraManager 

getMensturation(type: Connections, 
         startDate: Date, 
         endDate: Date, 
         toWebhook: Bool, 
         completion: @escaping (Bool, TerraMenstruationDataPayloadModel?, TerraError?) -> Void)

getMenstruation(type: Connections, 
         startDate: TimeInterval, 
         endDate: TimeInterval, 
         toWebhook: Bool, 
         completion: @escaping (Bool, TerraMenstruationDataPayloadModel?, TerraError?) -> Void)
  • type: Connections ➡ The Connection to get data from
  • startDate: Date or startDate: TimeInterval ➡ The beginning of the request in either Date or Unix Timestamp
  • endDate: Date or endDate: TimeInterval ➡ The end of the request in either Date or Unix Timestamp
  • toWebhook: Bool ➡ Whether or not to send data to your webhook
  • `completion: (Bool, TerraMenstruationDataPayloadModel?, TerraError?) -> Void ➡

Bool -> If the request was successful or not. If not, a TerraError instance will also be called
TerraMenstruationDataPayloadModel? -> A payload for each data type. If toWebhook is set to true, this returns a class with a property reference referring to the payload reference sent to your webhook. If toWebhook is set to false, then this returns the entire Terra normalised payload.
TerraError? -> Returned if any error occurred while retrieving data