Mastodon
/
mastodon-app-ufficiale-iphone-ios
mirror of https://github.com/mastodon/mastodon-ios.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

chore: add some doc

This commit is contained in:
CMK 2022-07-06 16:56:43 +08:00
parent 938af7c571
commit 38ecae1bb7
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Documentation/How-it-works.md
View File

@ -25,4 +25,14 @@ There is a self-hosted Swift Pacakge contains the common libraries to build this
Some brief for important packets:
#### CoreDataStack
// TODO:
App uses Core Data as the backend to persist all entitles from the server. So the app has the capability to keep the timeline and notifications. Another reason for using a database makes the app could responses entity changes between different sources. For example, a user could skim in the home timeline and then interact with the same post on other pages with favorite or reblog actions. Core Data will handle the property modifications and notify the home timeline to update the view.
The app use one stack two context Core Data setup. There is a main managed object context for UI displaying and a background context to persists entities creating and updating. We assert the background context performs in a queue. But should derive a new background context for long-time database operation to avoid concurrency persistent conflict issues.
#### NotificationService
Mastodon server accepts push notification register and we use the [toot-relay](https://github.com/DagAgren/toot-relay) to pass the server notifications to APNs. The message is E2E encrypted. The app will create an on-device private key for notification and save it into the keychain.
When the push notification is incoming. iOS will spawn our NotificationService extension to handle the message. At that time the message is decrypted and displayed as a banner or in-app silent notification event when the app is in the foreground. All the notification count and deep-link logic are handled by the main app.
#### ShareActionExtension
TBD