Daily Summaries

Pre-requisite: The user has to be signed in to perform the following operations.

A daily summary is a per-camera, per-day recap: a title and subtitle, a snapshot, a video, and a count of events by tag (DailySummaryTagInfo — person, vehicle, animal, bird, pet, wildlife, cry, doorbell, alarm, motion and the temperature / humidity alerts). Pet summaries also list the petIds seen. The model is DailySummaryModel; the list response calls them timelapses.

Summaries have their own deletion sync, like events: deleted ids stay retrievable so a device that was offline can catch up.

List Daily Summaries

To fetch the daily summaries of a space, The following method can be used. Filter and page with the same QueryItem / SortItem as events:

  • spaceId (required): The space id.
  • queryItems (required): Filters — typically deviceId, startTime / endTime, skip, limit.
  • sortItem (optional): Ordering, normally descending date.
Factory.spaceService.dailySummaryList(spaceId: String, queryItems: [QueryItem], sortItem: SortItem?) -> IVPublisher<ListDailySummaryModel>

To save a summary video locally use EventDownloader.buildCommandForDailySummary — see Event Download.

Delete Daily Summaries

To delete one or more summaries, The following method can be used:

  • spaceId (required): The space id.
  • request (required): DeleteTimelapseRequest(timelapseIds:).
Factory.spaceService.deleteDailySummaries(spaceId: String, request: DeleteTimelapseRequest) -> IVPublisher<Void>

Get Deleted Daily Summaries

To fetch the ids of summaries deleted from any device, so a local cache can drop them, The following method can be used:

  • spaceId (required): The space id.
Factory.spaceService.getDeletedDailySummaries(spaceId: String) -> IVPublisher<DeletedTimelapseModel>

DeletedTimelapseModel.deletedTimelapses is the list of ids.