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 @ 0e94f584
...@@ -7,7 +7,7 @@ ...@@ -7,7 +7,7 @@
### Approve File ### Approve File
| Socket | Description | User | Listeners | | Socket | Description | User | Listeners |
|--------|-------------|------|-----------| |--------|-------------|------|-----------|
| `approveFile` | Changes player submission's status to `"Approved"` or `"Rejected"` | Gamemaster | [`fileStatusPlayer`](API/Socket/Listener/File%20Status%20Player)<br>[`newFile`](API/Socket/Listener/New%20File)<br>[`finalScoreUpdate`](API/Socket/Listener/Final%20Score%20Update) | | `approveFile` | Changes player submission's status to `"Approved"` or `"Rejected"` | Gamemaster | `fileStatusPlayer`<br>`newFile`<br>`finalScore_update` |
<details> <details>
<summary> <summary>
...@@ -32,68 +32,25 @@ Requires gamemaster `token`. ...@@ -32,68 +32,25 @@ Requires gamemaster `token`.
### Fetch Scoreboard ### Fetch Scoreboard
| Socket | Description | User | Listeners | | Socket | Description | User | Listeners |
|--------|-------------|------|-----------| |--------|-------------|------|-----------|
| `fetchScoreBoard` | Triggers `finalScore_update` socket listener. The listener will get challenge room's scoreboard information. | All | `finalScore_Update` | | `fetchScoreBoard` | Triggers `finalScore_update` socket listener. The listener will get challenge room's scoreboard information. | All | `finalScore_update` |
<details> Requires `token`.
<summary>
**Required payload**
</summary>
Requires gamemaster `token`.
```json
```
</details>
--- ---
### Header ### List Files
| Socket | Description | User | Listeners | | Socket | Description | User | Listeners |
|--------|-------------|------|-----------| |--------|-------------|------|-----------|
| `socketName` | Description | User role | Listener list | | `listFiles` | Triggers `newFile` listener to receive all unreviewed challenge files in the challenge room. | Gamemaster | `newFile` |
<details>
<summary>
**Required payload**
</summary>
Requires gamemaster `token`. Requires gamemaster `token`.
```json
```
</details>
--- ---
### Header ### Modify Challenge
| Socket | Description | User | Listeners | | Socket | Description | User | Listeners |
|--------|-------------|------|-----------| |--------|-------------|------|-----------|
| `socketName` | Description | User role | Listener list | | `modifyChallenge` | Changes room's information | Gamemaster | `challengeModify` |
<details>
<summary>
**Required payload**
</summary>
Requires gamemaster `token`.
```json
```
</details>
### Header
| Socket | Description | User | Listeners |
|--------|-------------|------|-----------|
| `socketName` | Description | User role | Listener list |
<details> <details>
<summary> <summary>
...@@ -105,33 +62,23 @@ Requires gamemaster `token`. ...@@ -105,33 +62,23 @@ Requires gamemaster `token`.
Requires gamemaster `token`. Requires gamemaster `token`.
```json ```json
{
"challengeName": "string (3-30 characters)",
"challengeTasks":[{
"challengeNumber": "number (min 1)",
"description": "string (3-256 characters)",
}]
}
``` ```
</details> </details>
### Header ---
| Socket | Description | User | Listeners |
|--------|-------------|------|-----------|
| `socketName` | Description | User role | Listener list |
<details>
<summary>
**Required payload**
</summary>
Requires gamemaster `token`.
```json
```
</details>
### Header ### Player Check File
| Socket | Description | User | Listeners | | Socket | Description | User | Listeners |
|--------|-------------|------|-----------| |--------|-------------|------|-----------|
| `socketName` | Description | User role | Listener list | | `playerCheckFile` | Triggers `fileStatusPlayer` listener to receive given file's status. | Player | `fileStatusPlayer` |
<details> <details>
<summary> <summary>
...@@ -140,36 +87,22 @@ Requires gamemaster `token`. ...@@ -140,36 +87,22 @@ Requires gamemaster `token`.
</summary> </summary>
Requires gamemaster `token`. Requires `token`.
```json ```json
{
"challengeNumber": "number"
}
``` ```
</details> </details>
### Header ---
| Socket | Description | User | Listeners |
|--------|-------------|------|-----------|
| `socketName` | Description | User role | Listener list |
<details>
<summary>
**Required payload**
</summary>
Requires gamemaster `token`.
```json
```
</details>
### Header ### Remove Player
| Socket | Description | User | Listeners | | Socket | Description | User | Listeners |
|--------|-------------|------|-----------| |--------|-------------|------|-----------|
| `socketName` | Description | User role | Listener list | | `removePlayer` | Removes player from the challenge room. | Gamemaster | `youWereRemoved`<br>`finalScore_update`<br>`playerWasRemoved` |
<details> <details>
<summary> <summary>
...@@ -181,45 +114,20 @@ Requires gamemaster `token`. ...@@ -181,45 +114,20 @@ Requires gamemaster `token`.
Requires gamemaster `token`. Requires gamemaster `token`.
```json ```json
{
"userName": "string"
}
``` ```
</details> </details>
### Header ---
| Socket | Description | User | Listeners |
|--------|-------------|------|-----------|
| `socketName` | Description | User role | Listener list |
<details>
<summary>
**Required payload**
</summary>
Requires gamemaster `token`.
```json
```
</details>
### Header ### Fetch Player File Statuses
| Socket | Description | User | Listeners | | Socket | Description | User | Listeners |
|--------|-------------|------|-----------| |--------|-------------|------|-----------|
| `socketName` | Description | User role | Listener list | | `fetchPlayerFileStatuses` | Triggers `playerFileStatuses` to receive array of all the player's submissions. | Player | `playerFileStatuses` |
<details> Requires `token`.
<summary>
**Required payload**
</summary>
Requires gamemaster `token`.
```json
```
</details>
---
\ No newline at end of file