| ... | ... | @@ -2,12 +2,141 @@ |
|
|
|
|
|
|
|
## Front-end listeners
|
|
|
|
|
|
|
|
### Challenge Modify
|
|
|
|
| Socket | Description | User | Emitters |
|
|
|
|
|--------|-------------|------|----------|
|
|
|
|
| `challengeModify` | Listener will trigger when the challenge room's information changes.| All| [`modifyChallenge`](#modify-challenge) |
|
|
|
|
|
|
|
|
<details>
|
|
|
|
<summary>Response</summary>
|
|
|
|
|
|
|
|
```json
|
|
|
|
{
|
|
|
|
"challengeRoomName": "string",
|
|
|
|
"challengeTasks": [{
|
|
|
|
"description": "string",
|
|
|
|
"challengeNumber": "number"
|
|
|
|
}],
|
|
|
|
"challengeStartDate": "string",
|
|
|
|
"challengeEndDate": "string",
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
### Header
|
|
|
|
| Socket | Description | User | Emitters |
|
|
|
|
|--------|-------------|------|----------|
|
|
|
|
| `name` | Desc | Role | [`name`](#name) |
|
|
|
|
|
|
|
|
<details>
|
|
|
|
<summary>Response</summary>
|
|
|
|
|
|
|
|
```json
|
|
|
|
```
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
### Header
|
|
|
|
| Socket | Description | User | Emitters |
|
|
|
|
|--------|-------------|------|----------|
|
|
|
|
| `name` | Desc | Role | [`name`](#name) |
|
|
|
|
|
|
|
|
<details>
|
|
|
|
<summary>Response</summary>
|
|
|
|
|
|
|
|
```json
|
|
|
|
```
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
### Header
|
|
|
|
| Socket | Description | User | Emitters |
|
|
|
|
|--------|-------------|------|----------|
|
|
|
|
| `name` | Desc | Role | [`name`](#name) |
|
|
|
|
|
|
|
|
<details>
|
|
|
|
<summary>Response</summary>
|
|
|
|
|
|
|
|
```json
|
|
|
|
```
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
### Header
|
|
|
|
| Socket | Description | User | Emitters |
|
|
|
|
|--------|-------------|------|----------|
|
|
|
|
| `name` | Desc | Role | [`name`](#name) |
|
|
|
|
|
|
|
|
<details>
|
|
|
|
<summary>Response</summary>
|
|
|
|
|
|
|
|
```json
|
|
|
|
```
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
### Header
|
|
|
|
| Socket | Description | User | Emitters |
|
|
|
|
|--------|-------------|------|----------|
|
|
|
|
| `name` | Desc | Role | [`name`](#name) |
|
|
|
|
|
|
|
|
<details>
|
|
|
|
<summary>Response</summary>
|
|
|
|
|
|
|
|
```json
|
|
|
|
```
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
### Header
|
|
|
|
| Socket | Description | User | Emitters |
|
|
|
|
|--------|-------------|------|----------|
|
|
|
|
| `name` | Desc | Role | [`name`](#name) |
|
|
|
|
|
|
|
|
<details>
|
|
|
|
<summary>Response</summary>
|
|
|
|
|
|
|
|
```json
|
|
|
|
```
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
### Header
|
|
|
|
| Socket | Description | User | Emitters |
|
|
|
|
|--------|-------------|------|----------|
|
|
|
|
| `name` | Desc | Role | [`name`](#name) |
|
|
|
|
|
|
|
|
<details>
|
|
|
|
<summary>Response</summary>
|
|
|
|
|
|
|
|
```json
|
|
|
|
```
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
## Front-end emitters
|
|
|
|
|
|
|
|
### Approve File
|
|
|
|
| Socket | Description | User | Listeners |
|
|
|
|
|--------|-------------|------|-----------|
|
|
|
|
| `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>
|
|
|
|
<summary>
|
| ... | ... | @@ -41,7 +170,7 @@ Requires `token`. |
|
|
|
### List Files
|
|
|
|
| Socket | Description | User | Listeners |
|
|
|
|
|--------|-------------|------|-----------|
|
|
|
|
| `listFiles` | Triggers `newFile` listener to receive all unreviewed challenge files in the challenge room. | Gamemaster | [`newFile`](#new-file) |
|
|
|
|
| `listFiles` | Triggers `newFile` listener to receive all unreviewed challenge files in the challenge room. | Gamemaster | [`newFile`](#new-file) |
|
|
|
|
|
|
|
|
Requires gamemaster `token`.
|
|
|
|
|
| ... | ... | @@ -50,7 +179,7 @@ Requires gamemaster `token`. |
|
|
|
### Modify Challenge
|
|
|
|
| Socket | Description | User | Listeners |
|
|
|
|
|--------|-------------|------|-----------|
|
|
|
|
| `modifyChallenge` | Changes room's information | Gamemaster | [`challengeModify`](#challenge-modify)|
|
|
|
|
| `modifyChallenge` | Changes room's information | Gamemaster | [`challengeModify`](#challenge-modify) |
|
|
|
|
|
|
|
|
<details>
|
|
|
|
<summary>
|
| ... | ... | @@ -126,7 +255,7 @@ Requires gamemaster `token`. |
|
|
|
### Fetch Player File Statuses
|
|
|
|
| Socket | Description | User | Listeners |
|
|
|
|
|--------|-------------|------|-----------|
|
|
|
|
| `fetchPlayerFileStatuses` | Triggers `playerFileStatuses` to receive array of all the player's submissions. | Player |[`playerFileStatuses`](#player-file-statuses) |
|
|
|
|
| `fetchPlayerFileStatuses` | Triggers `playerFileStatuses` to receive array of all the player's submissions. | Player | [`playerFileStatuses`](#player-file-statuses) |
|
|
|
|
|
|
|
|
Requires `token`.
|
|
|
|
|
| ... | ... | |
| ... | ... | |