| ... | ... | @@ -5,7 +5,7 @@ |
|
|
|
### Challenge Modify
|
|
|
|
| Socket | Description | User | Emitters |
|
|
|
|
|--------|-------------|------|----------|
|
|
|
|
| `challengeModify` | Listener will trigger when the challenge room's information changes.| All| [`modifyChallenge`](#modify-challenge) |
|
|
|
|
| `challengeModify` | Receives challenge room's information when the information changes| All| [`modifyChallenge`](#modify-challenge) |
|
|
|
|
|
|
|
|
<details>
|
|
|
|
<summary>Response</summary>
|
| ... | ... | @@ -26,105 +26,178 @@ |
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
### Header
|
|
|
|
### File Status Player
|
|
|
|
| Socket | Description | User | Emitters |
|
|
|
|
|--------|-------------|------|----------|
|
|
|
|
| `name` | Desc | Role | [`name`](#name) |
|
|
|
|
| `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>
|
|
|
|
<summary>Response</summary>
|
|
|
|
|
|
|
|
```json
|
|
|
|
{
|
|
|
|
"fileStatus": "'Approved' | 'Rejected' | 'Not submitted' | 'Not reviewed'",
|
|
|
|
"challengeNumber": "number"
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
### Header
|
|
|
|
### Final Score Update
|
|
|
|
| Socket | Description | User | Emitters |
|
|
|
|
|--------|-------------|------|----------|
|
|
|
|
| `name` | Desc | Role | [`name`](#name) |
|
|
|
|
| `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>
|
|
|
|
<summary>Response</summary>
|
|
|
|
|
|
|
|
```json
|
|
|
|
{
|
|
|
|
"playerName": "string",
|
|
|
|
"playerAvatar": "number",
|
|
|
|
"playerFileIds": [{
|
|
|
|
"CreatedAt": "string",
|
|
|
|
"challengeNumber": "number",
|
|
|
|
"fileId": "string",
|
|
|
|
}],
|
|
|
|
"playerResult": [{
|
|
|
|
"time": "number",
|
|
|
|
"score": null
|
|
|
|
}],
|
|
|
|
"totalTime": "number",
|
|
|
|
"totalScore": "number"
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
### Header
|
|
|
|
### New File
|
|
|
|
| Socket | Description | User | Emitters |
|
|
|
|
|--------|-------------|------|----------|
|
|
|
|
| `name` | Desc | Role | [`name`](#name) |
|
|
|
|
| `newFile` | Receives array of submissions that has not been reviewed.| Gamemaster| [`approveFile`](#approve-file)<br>[`listFiles`](#list-files) |
|
|
|
|
|
|
|
|
<details>
|
|
|
|
<summary>Response</summary>
|
|
|
|
|
|
|
|
```json
|
|
|
|
{
|
|
|
|
"statusCode": 200,
|
|
|
|
"message": "List of received challenge files",
|
|
|
|
"challengeFiles": [{
|
|
|
|
"fileId": "string",
|
|
|
|
"fileName": "string",
|
|
|
|
"fileStatus": "'Not reviewed'",
|
|
|
|
"challengeNumber": "number",
|
|
|
|
"description": "string",
|
|
|
|
}]
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
### Header
|
|
|
|
### New Player
|
|
|
|
| Socket | Description | User | Emitters |
|
|
|
|
|--------|-------------|------|----------|
|
|
|
|
| `name` | Desc | Role | [`name`](#name) |
|
|
|
|
| `newPlayer` | Receives array of room's players when new player joins the room. | All | [`Join Challenge REST`](#join-challenge) |
|
|
|
|
|
|
|
|
<details>
|
|
|
|
<summary>Response</summary>
|
|
|
|
|
|
|
|
```json
|
|
|
|
{
|
|
|
|
"players": [
|
|
|
|
{
|
|
|
|
"name": "string",
|
|
|
|
"avatar": "number",
|
|
|
|
"userId": "string"
|
|
|
|
},
|
|
|
|
]
|
|
|
|
"details": {
|
|
|
|
"challengeRoomId": "string",
|
|
|
|
"challengeRoomCode": "string",
|
|
|
|
"challengeRoomName": "string",
|
|
|
|
"challengeDuration": "string",
|
|
|
|
"challengeStartDelay": "string",
|
|
|
|
"challengeStartDate": "string",
|
|
|
|
"challengeEndDate": "string",
|
|
|
|
"challengeTasks": [{
|
|
|
|
"description": "string",
|
|
|
|
"taskNumber": "number",
|
|
|
|
}]
|
|
|
|
}
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
### Header
|
|
|
|
### Player File Statuses
|
|
|
|
| Socket | Description | User | Emitters |
|
|
|
|
|--------|-------------|------|----------|
|
|
|
|
| `name` | Desc | Role | [`name`](#name) |
|
|
|
|
| `playerFileStatuses` | Receives array of all the player's submissions. | Player | [`fetchPlayerFileStatuses`](#fetch-player-file-statuses) |
|
|
|
|
|
|
|
|
<details>
|
|
|
|
<summary>Response</summary>
|
|
|
|
|
|
|
|
```json
|
|
|
|
{
|
|
|
|
"statusCode": 200,
|
|
|
|
"files": [{
|
|
|
|
"fileId": "string",
|
|
|
|
"fileName": "string",
|
|
|
|
"fileStatus": "'Not reviewed' | 'Approved' | 'Rejected' | 'Not submitted'",
|
|
|
|
"challengeNumber": "number",
|
|
|
|
}]
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
### Header
|
|
|
|
### Player Was Removed
|
|
|
|
| Socket | Description | User | Emitters |
|
|
|
|
|--------|-------------|------|----------|
|
|
|
|
| `name` | Desc | Role | [`name`](#name) |
|
|
|
|
| `playerWasRemoved` | Receives array of room's players when a player leaves the room.| All | [`removePlayer`](#remove-player) |
|
|
|
|
|
|
|
|
<details>
|
|
|
|
<summary>Response</summary>
|
|
|
|
|
|
|
|
```json
|
|
|
|
{
|
|
|
|
"message": "`Player {userName} was removed from Challenge`",
|
|
|
|
"players": [{
|
|
|
|
"userId": "string",
|
|
|
|
"name": "string",
|
|
|
|
"avatar": "number"
|
|
|
|
}],
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
### Header
|
|
|
|
### You Were Removed
|
|
|
|
| Socket | Description | User | Emitters |
|
|
|
|
|--------|-------------|------|----------|
|
|
|
|
| `name` | Desc | Role | [`name`](#name) |
|
|
|
|
| `youWereRemoved` | Listener will trigger when the player has been removed from the challenge room.| Player| [`removePlayer`](#remove-player) |
|
|
|
|
|
|
|
|
<details>
|
|
|
|
<summary>Response</summary>
|
|
|
|
|
|
|
|
```json
|
|
|
|
{
|
|
|
|
"statusCode": 200,
|
|
|
|
"message": "'You were removed from Challenge'"
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
</details>
|
| ... | ... | |
| ... | ... | |
