Skip to content

Commit 3705f96

Browse files
committed
docs: add code flow for send notification flow v2
1 parent 2cbdd62 commit 3705f96

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

docs/send-notification-flow.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -166,31 +166,31 @@ Here is the code flow of the Telegram Git Notifier - send notification flow:
166166

167167
```plaintext
168168
Receive webhook from git repository
169-
-> packages/laravel-telegram-git-notifier/src/Http/Actions/IndexAction::class
169+
packages/laravel-telegram-git-notifier/src/Http/Actions/IndexAction::class
170170
- Check query type (callback_query, message, webhook[gitlab, github])
171-
- create new NotificationService
172-
- call the handle method of the NotificationService
171+
create new NotificationService
172+
- call the handle method of the NotificationService
173173
174-
-> packages/laravel-telegram-git-notifier/src/Services/NotificationService@handle
174+
packages/laravel-telegram-git-notifier/src/Services/NotificationService@handle
175175
- Get and set the event from the request in handleEventFromRequest method
176176
- Call the sendNotification method
177177
178-
-> packages/telegram-git-notifier/src/Trait/EventTrait@handleEventFromRequest
178+
packages/telegram-git-notifier/src/Trait/EventTrait@handleEventFromRequest
179179
- Set event name
180180
- Check and update platform(GitLab, GitHub) for event object
181181
182-
-> go to setPlatFormForEvent method
182+
→ Go to setPlatFormForEvent method
183183
- Detech and set platform file
184-
- Update event config from platform file
184+
- Update event config from the platform file
185185
186-
-> go to sendNotification method of this NotificationService
187-
- call validateAccessEvent to check if the event is allowed
188-
- loop through the recipients and send the notification to each recipient
186+
→ Go to sendNotification method of this NotificationService
187+
- Call validateAccessEvent to check if the event is allowed
188+
- Loop through the recipients and send the notification to each recipient
189189
190-
-> packages/telegram-git-notifier/src/Services/NotificationService@validateAccessEvent
190+
packages/telegram-git-notifier/src/Services/NotificationService@validateAccessEvent
191191
- Set payload and message from the event
192-
- Check if the eventis allowed in the settings
192+
- Check if the event is allowed in the settings
193193
- Check if the event/action is allowed in the platform settings
194194
195-
-> packages/telegram-git-notifier/src/Structures/Notification@sendNotify
195+
packages/telegram-git-notifier/src/Structures/Notification@sendNotify
196196
```

0 commit comments

Comments
 (0)