Skip to content

Changes

Page history
Update Socket API authored by H9031's avatar H9031
Show whitespace changes
Inline Side-by-side
API/Socket-API.md
View page @ b58e25df
...@@ -32,7 +32,7 @@ ...@@ -32,7 +32,7 @@
| `fileStatusPlayer` | Receives submission review result when gamemaster approves or rejects the player's submission, or `playerCheckFile` has been emitted.| Player | [`approveFile`](#approve-file)<br>[`playerCheckFile`](#player-check-file) | | `fileStatusPlayer` | Receives submission review result when gamemaster approves or rejects the player's submission, or `playerCheckFile` has been emitted.| Player | [`approveFile`](#approve-file)<br>[`playerCheckFile`](#player-check-file) |
<details> <details>
<summary>Response</summary> <summary><b>Response</b></summary>
```json ```json
{ {
...@@ -51,7 +51,7 @@ ...@@ -51,7 +51,7 @@
| `finalScore_update` | Receives challenge room's scoreboard information when the information updates or `fetchScoreBoard` has been emitted.| All | [`fetchScoreBoard`](#fetch-scoreboard)<br>[`approveFile`](#approve-file)<br>[`removePlayer`](#remove-player) | | `finalScore_update` | Receives challenge room's scoreboard information when the information updates or `fetchScoreBoard` has been emitted.| All | [`fetchScoreBoard`](#fetch-scoreboard)<br>[`approveFile`](#approve-file)<br>[`removePlayer`](#remove-player) |
<details> <details>
<summary>Response</summary> <summary><b>Response</b></summary>
```json ```json
{ {
...@@ -81,7 +81,7 @@ ...@@ -81,7 +81,7 @@
| `newFile` | Receives array of submissions that has not been reviewed.| Gamemaster| [`approveFile`](#approve-file)<br>[`listFiles`](#list-files) | | `newFile` | Receives array of submissions that has not been reviewed.| Gamemaster| [`approveFile`](#approve-file)<br>[`listFiles`](#list-files) |
<details> <details>
<summary>Response</summary> <summary><b>Response</b></summary>
```json ```json
{ {
...@@ -107,7 +107,7 @@ ...@@ -107,7 +107,7 @@
| `newPlayer` | Receives array of room's players when new player joins the room. | All | [`Join Challenge REST`](#join-challenge) | | `newPlayer` | Receives array of room's players when new player joins the room. | All | [`Join Challenge REST`](#join-challenge) |
<details> <details>
<summary>Response</summary> <summary><b>Response</b></summary>
```json ```json
{ {
...@@ -144,7 +144,7 @@ ...@@ -144,7 +144,7 @@
| `playerFileStatuses` | Receives array of all the player's submissions. | Player | [`fetchPlayerFileStatuses`](#fetch-player-file-statuses) | | `playerFileStatuses` | Receives array of all the player's submissions. | Player | [`fetchPlayerFileStatuses`](#fetch-player-file-statuses) |
<details> <details>
<summary>Response</summary> <summary><b>Response</b></summary>
```json ```json
{ {
...@@ -168,7 +168,7 @@ ...@@ -168,7 +168,7 @@
| `playerWasRemoved` | Receives array of room's players when a player leaves the room.| All | [`removePlayer`](#remove-player) | | `playerWasRemoved` | Receives array of room's players when a player leaves the room.| All | [`removePlayer`](#remove-player) |
<details> <details>
<summary>Response</summary> <summary><b>Response</b></summary>
```json ```json
{ {
...@@ -191,7 +191,7 @@ ...@@ -191,7 +191,7 @@
| `youWereRemoved` | Listener will trigger when the player has been removed from the challenge room.| Player| [`removePlayer`](#remove-player) | | `youWereRemoved` | Listener will trigger when the player has been removed from the challenge room.| Player| [`removePlayer`](#remove-player) |
<details> <details>
<summary>Response</summary> <summary><b>Response</b></summary>
```json ```json
{ {
...@@ -214,11 +214,7 @@ ...@@ -214,11 +214,7 @@
| `approveFile` | Changes player submission's status to `"Approved"` or `"Rejected"` | Gamemaster | [`fileStatusPlayer`](#file-status-player)<br>[`newFile`](#new-file)<br>[`finalScore_update`](#final-score-update) | | `approveFile` | Changes player submission's status to `"Approved"` or `"Rejected"` | Gamemaster | [`fileStatusPlayer`](#file-status-player)<br>[`newFile`](#new-file)<br>[`finalScore_update`](#final-score-update) |
<details> <details>
<summary> <summary><b>Required payload</b></summary>
**Required payload**
</summary>
Requires gamemaster `token`. Requires gamemaster `token`.
...@@ -257,11 +253,7 @@ Requires gamemaster `token`. ...@@ -257,11 +253,7 @@ Requires gamemaster `token`.
| `modifyChallenge` | Changes room's information | Gamemaster | [`challengeModify`](#challenge-modify) | | `modifyChallenge` | Changes room's information | Gamemaster | [`challengeModify`](#challenge-modify) |
<details> <details>
<summary> <summary><b>Required payload</b></summary>
**Required payload**
</summary>
Requires gamemaster `token`. Requires gamemaster `token`.
...@@ -285,11 +277,7 @@ Requires gamemaster `token`. ...@@ -285,11 +277,7 @@ Requires gamemaster `token`.
| `playerCheckFile` | Triggers `fileStatusPlayer` listener to receive given file's status. | Player | [`fileStatusPlayer`](#file-status-player) | | `playerCheckFile` | Triggers `fileStatusPlayer` listener to receive given file's status. | Player | [`fileStatusPlayer`](#file-status-player) |
<details> <details>
<summary> <summary><b>Required payload</b></summary>
**Required payload**
</summary>
Requires `token`. Requires `token`.
...@@ -309,11 +297,7 @@ Requires `token`. ...@@ -309,11 +297,7 @@ Requires `token`.
| `removePlayer` | Removes player from the challenge room. | Gamemaster | [`youWereRemoved`](#you-were-removed)<br>[`finalScore_update`](#final-score-update)<br>[`playerWasRemoved`](#player-was-removed) | | `removePlayer` | Removes player from the challenge room. | Gamemaster | [`youWereRemoved`](#you-were-removed)<br>[`finalScore_update`](#final-score-update)<br>[`playerWasRemoved`](#player-was-removed) |
<details> <details>
<summary> <summary><b>Required payload</b></summary>
**Required payload**
</summary>
Requires gamemaster `token`. Requires gamemaster `token`.
... ...
......