Skip to content

Commit db94a59

Browse files
committed
Update matching service readme
1 parent c147f6c commit db94a59

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

backend/matching-service/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,12 @@
5555
| Event Name | Description | Parameters | Response Event |
5656
| ------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
5757
| **user_connected** | User joins the matching process | `uid` (string): ID of the user. | None |
58-
| **user_disconnected** | User leaves the matching process | `uid` (string): ID of the user. | **match_unsuccessful**: If the user left during the match offer phase, notify the partner user that the match was unsuccessful |
58+
| **user_disconnected** | User leaves the matching process (if not reconnected within 3 seconds) | `uid` (string): ID of the user. | **match_unsuccessful**: If the user left during the match offer phase, notify the partner user that the match was unsuccessful. |
5959
| **match_request** | Sends a match request | `matchRequest` (`MatchRequest`): Match request details. <br><br> `callback` (`(requested: boolean) => void`): To check if the match request was successfully sent. | **match_found**: Notify the user that a match has been found. <br><br> **match_request_exists**: Notify the user that only one match request can be processed at a time. <br><br> **match_request_error**: Notify the user that the match request failed to send. |
60-
| **match_cancel_request** | Cancels the match request | `uid` (string): ID of the user. | None |
61-
| **match_accept_request** | Accepts the match request | `uid` (string): ID of the user. | **match_successful**: If both users have accepted the match offer, notify them that the match is successful. |
62-
| **match_decline_request** | Declines the match request | `uid` (string): ID of the user. <br><br> `matchId` (string): ID of the user. <br><br> `isTimeout` (boolean): Whether the match was declined due to match offer timeout. | **match_unsuccessful**: If the match was not declined due to match offer timeout (was explicitly rejected by the user), notify the partner user that the match is unsuccessful. |
63-
| **rematch_request** | Sends a rematch request | `matchId` (string): ID of the match. <br><br> `partnerId` (string): ID of the partner user. <br><br> `rematchRequest` (`MatchRequest`): Rematch request details. <br><br> `callback` (`(requested: boolean) => void`): To check if the rematch request was successfully sent. | **match_request_error**: Notify the user that the rematch request failed to send. |
60+
| **match_cancel_request** | Cancels the match request before a match has been found | `uid` (string): ID of the user. | None |
61+
| **match_accept_request** | Accepts the match offer | `uid` (string): ID of the user. | **match_successful**: If both users have accepted the match offer, notify them that the match is successful. |
62+
| **match_decline_request** | Declines the match offer | `uid` (string): ID of the user. <br><br> `matchId` (string): ID of the user. <br><br> `isTimeout` (boolean): Whether the match was declined due to match offer timeout. | **match_unsuccessful**: If the match was not declined due to match offer timeout (was explicitly rejected by the user), notify the partner user that the match is unsuccessful. |
63+
| **rematch_request** | Sends a rematch request | `matchId` (string): ID of the match. <br><br> `partnerId` (string): ID of the partner user. <br><br> `rematchRequest` (`MatchRequest`): Rematch request details. <br><br> `callback` (`(requested: boolean) => void`): To check if the rematch request was successfully sent. | **match_unsuccessful**: Notify the partner user that the match is unsuccessful. <br><br> **match_request_error**: Notify the user that the rematch request failed to send. |
6464
| **match_end_request** | User leaves the matching process upon leaving the collaboration session | `uid` (string): ID of the user. <br><br> `matchId` (string): ID of the match. | None |
6565

6666
### Event Parameter Types

0 commit comments

Comments
 (0)