From de30f681e820d35196fdd477a38e7f9f26d45ac8 Mon Sep 17 00:00:00 2001 From: Myzel394 <50424412+Myzel394@users.noreply.github.com> Date: Thu, 14 Dec 2023 18:04:02 +0100 Subject: [PATCH] docs: Add docs for services --- app/src/main/java/app/myzel394/alibi/services/README.md | 4 ++++ app/src/main/java/app/myzel394/alibi/services/model.svg | 1 + 2 files changed, 5 insertions(+) create mode 100644 app/src/main/java/app/myzel394/alibi/services/README.md create mode 100644 app/src/main/java/app/myzel394/alibi/services/model.svg diff --git a/app/src/main/java/app/myzel394/alibi/services/README.md b/app/src/main/java/app/myzel394/alibi/services/README.md new file mode 100644 index 0000000..bac59f3 --- /dev/null +++ b/app/src/main/java/app/myzel394/alibi/services/README.md @@ -0,0 +1,4 @@ +I found it a bit confusing on how to properly handle the services, so I made this diagram +to help me understand it better. I hope it helps you too. + +![Diagram](model.svg) \ No newline at end of file diff --git a/app/src/main/java/app/myzel394/alibi/services/model.svg b/app/src/main/java/app/myzel394/alibi/services/model.svg new file mode 100644 index 0000000..4cf1534 --- /dev/null +++ b/app/src/main/java/app/myzel394/alibi/services/model.svg @@ -0,0 +1 @@ +UserUserModelModelRecordingRecordingStateStateUser starts recordingModel creates new serviceModel binds to RecordingState is set to `RECORDING` to indicate that the recording is activeState mirrored to ModelUser pauses the recordingCommands Recording to pauseState is set to `PAUSED` to indicate that the recording is pausedActually pauses the recordingUser continues the recordingCommands Recording to continueState is set to `RECORDING` to indicate that the recording is activeActually continues with recordingUser stops recordingCommands Recording to stopState is set to `IDLE` to indicate that the recording will be destroyedRunning cleanupUnbinds from RecordingDestroys model \ No newline at end of file