SES-128 Endpoint Broni #52

Merged
s426134 merged 7 commits from SES-128 into dev 2021-01-09 14:07:07 +01:00
4 changed files with 1145 additions and 1098 deletions

4
.gitignore vendored
View File

@ -2,6 +2,10 @@
# Created by https://www.toptal.com/developers/gitignore/api/aspnetcore,node,visualstudio,visualstudiocode,vscode,windows,linux,angular
# Edit at https://www.toptal.com/developers/gitignore?templates=aspnetcore,node,visualstudio,visualstudiocode,vscode,windows,linux,angular
#Swagger
./SessionCompanion/SessionCompanion/SessionCompanion.xml
./SessionCompanion/SessionCompanion.ViewModels/SessionCompanion.ViewModels.xml
### Angular ###
## Angular ##
# compiled output

View File

@ -0,0 +1,43 @@
using Microsoft.AspNetCore.Mvc;
using SessionCompanion.Extensions.EitherType;
using SessionCompanion.Services.Interfaces;
using System.Threading.Tasks;
using SessionCompanion.ViewModels.WeaponViewModels;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using SessionCompanion.ViewModels.ApiResponses;
namespace SessionCompanion.Controllers
{
[Route("api/weapon")]
[ApiController]
public class WeaponController : Controller
{
private readonly IWeaponService _service;
public WeaponController(IWeaponService service) => _service = service;
/// <summary>
/// Metoda zwraca wszystkie dostępnasdasde bronie
/// </summary>
/// <returns>Lista wszystkich broni w bazie danych</returns>
[HttpGet("getAllWeapons")]
public async Task<Either<List<WeaponViewModel>, ErrorResponse>> GetWeapons()

Brak Error Response

Brak Error Response
{
try
{
var weapons = _service.Get().ToList();
return weapons;
}
catch (Exception e)
{
return new ErrorResponse()
{
StatusCode = 204,
Message = e.Message
};
}
}
}
}

View File

@ -1,134 +1,134 @@
<?xml version="1.0"?>
<doc>
<assembly>
<name>SessionCompanion</name>
</assembly>
<members>
<member name="M:SessionCompanion.Controllers.CharacterController.Get(System.Int32)">
<summary>
Metoda zwraca postać ze wskazanym identyfikatorem
</summary>
<param name="characterId">Identyfikator postaci</param>
<returns>ViewModel Postaci/ErrorResponse</returns>
</member>
<member name="M:SessionCompanion.Controllers.CharacterController.GetCharacterListForUser(System.Int32)">
<summary>
Metoda zwraca listę postaci przypisanych do danego użytkownika
</summary>
<param name="userId"> Identyfikator użytkownika </param>
<returns> Lista postaci lub wiadomość błędu </returns>
</member>
<member name="M:SessionCompanion.Controllers.CharacterController.GetLoggedUsersCharacters">
<summary>
Metoda zwraca listę zalogowanych postaci
</summary>
<returns> Lista zalogowanych postaci lub wiadomość błędu </returns>
</member>
<member name="M:SessionCompanion.Controllers.CharacterController.GetCharacterEveryStat(System.Int32)">
<summary>
Metoda zwraca wszystkie statystyki dla danej postaci
</summary>
<param name="characterId"> Id postaci </param>
<returns> Listę wszystkich statystyk </returns>
</member>
<member name="M:SessionCompanion.Controllers.OtherEquipmentController.GetOtherEquipment">
<summary>
Metoda zwraca wszystkie dostępne inne przedmioty
</summary>
<returns>Lista wszystkich innych przedmiotów w bazie danych</returns>
</member>
<member name="M:SessionCompanion.Controllers.CharacterController.GetCharacterBasicInfo(System.Int32)">
<summary>
Metoda zwraca podstawowe informacje dla danej postaci
</summary>
<param name="characterId"></param>
<returns>Podstawowe informacje dla danej postaci</returns>
</member>
<member name="M:SessionCompanion.Controllers.UserController.Login(System.String,System.String)">
<summary>
Metoda przyjmuje login oraz hasło i sprawdza czy istnieje użytkownik o podanych parametrach
</summary>
<param name="userName"> Nazwa użytkownika </param>
<param name="password"> Hasło </param>
<returns>Id użytkownika lub wiadomość błędu</returns>
</member>
<member name="M:SessionCompanion.Controllers.UserController.Register(SessionCompanion.ViewModels.UserViewModels.UserRegisterViewModel)">
<summary>
Metoda rejestruje podanego użytkownika
</summary>
<param name="userRegisterModel"> Model uzytkownika do zarejestrowania </param>
<returns> SuccessResponse/ErrorResponse </returns>
</member>
<member name="M:SessionCompanion.Controllers.UserController.IsGameMasterAllreadyLogged">
<summary>
Metoda sprawdza czy ktoś jest już zalogowany jako Game Master
</summary>
<returns>true jesli ktoś jest już zalogowany i false jeśli nie</returns>
</member>
<member name="F:SessionCompanion.Hubs.SessionHub.sessionHubData">
<summary>
Klasa zawierająca wszystkie dane potrzebne w SignalR odnośnie aktualnej sesji
</summary>
</member>
<member name="M:SessionCompanion.Hubs.SessionHub.OnDisconnectedAsync(System.Exception)">
<summary>
Metoda nadpisuje istniejącą metodę wywoływaną na utratę połączenia.
Ma ona za zadanie usunąć odłączonego gracza z listy zalogowanych.
Pozostałe ekrany zostają powiadomione wiadomością "GoodBye"
</summary>
<param name="exception">Błąd/przyczyna odłączenia</param>
</member>
<member name="M:SessionCompanion.Hubs.SessionHub.GameMasterLogin">
<summary>
Logowanie do Huba dla GM
Wysyła wiadomość "Welcome" do wszystkich zalogowanych użytkoników
</summary>
<returns>Zwraca true - jeśli udało się zalogować, false - jesli ktoś zalogował się już jako GM</returns>
</member>
<member name="M:SessionCompanion.Hubs.SessionHub.SendMessageToPlayer(System.Int32,System.String)">
<summary>
Metoda wysyła wiadomość do konkretnego gracza [MessageFromGameMaster]
</summary>
<param name="characterId"> Id postaci któa ma otrzymać wiadomość </param>
<param name="message"> Wiadomość do wysłania </param>
</member>
<member name="M:SessionCompanion.Hubs.SessionHub.SendMessageToAllPlayers(System.String)">
<summary>
Metoda wysyła wiadomość do wszystkich graczy [MessageFromGameMaster]
</summary>
<param name="message"> Wiadomość do wysłania </param>
</member>
<member name="M:SessionCompanion.Hubs.SessionHub.PlayerCharacterLogin(System.Int32)">
<summary>
Logowanie do Huba dla Gracza
</summary>
<param name="characterId"> Identyfikator zalogowanego bohatera </param>
<returns>Wysyła wiadomość "Welcome" do wszystkich zalogowanych użytkoników</returns>
</member>
<member name="T:SessionCompanion.Hubs.SessionHubData">
<summary>
Statyczna klasa przechowujaca informacje dotyczące SignalR dla SessionHub
</summary>
</member>
<member name="F:SessionCompanion.Hubs.SessionHubData.ConnectedCharacters">
<summary>
Lista zalogowanych graczy i identyfikator wybranej postaci
</summary>
</member>
<member name="F:SessionCompanion.Hubs.SessionHubData.GameMasterConnected">
<summary>
Status, czy GM został już zalogowany
</summary>
</member>
<member name="P:SessionCompanion.Hubs.SessionHubData.GameMasterConnected_Prop">
<summary>
Zwraca lub ustawia status zalogowania GM
</summary>
</member>
<member name="P:SessionCompanion.Hubs.SessionHubData.ConnectedCharacters_Prop">
<summary>
Zwraca lub ustawia listę zalogowanych postaci
</summary>
</member>
</members>
</doc>
<?xml version="1.0"?>
<doc>
<assembly>
<name>SessionCompanion</name>
</assembly>
<members>
<member name="M:SessionCompanion.Controllers.CharacterController.Get(System.Int32)">
<summary>
Metoda zwraca postać ze wskazanym identyfikatorem
</summary>
<param name="characterId">Identyfikator postaci</param>
<returns>ViewModel Postaci/ErrorResponse</returns>
</member>
<member name="M:SessionCompanion.Controllers.CharacterController.GetCharacterListForUser(System.Int32)">
<summary>
Metoda zwraca listę postaci przypisanych do danego użytkownika
</summary>
<param name="userId"> Identyfikator użytkownika </param>
<returns> Lista postaci lub wiadomość błędu </returns>
</member>
<member name="M:SessionCompanion.Controllers.CharacterController.GetLoggedUsersCharacters">
<summary>
Metoda zwraca listę zalogowanych postaci
</summary>
<returns> Lista zalogowanych postaci lub wiadomość błędu </returns>
</member>
<member name="M:SessionCompanion.Controllers.CharacterController.GetCharacterEveryStat(System.Int32)">
<summary>
Metoda zwraca wszystkie statystyki dla danej postaci
</summary>
<param name="characterId"> Id postaci </param>
<returns> Listę wszystkich statystyk </returns>
</member>
<member name="M:SessionCompanion.Controllers.OtherEquipmentController.GetOtherEquipment">
<summary>
Metoda zwraca wszystkie dostępne inne przedmioty
</summary>
<returns>Lista wszystkich innych przedmiotów w bazie danych</returns>
</member>
<member name="M:SessionCompanion.Controllers.CharacterController.GetCharacterBasicInfo(System.Int32)">
<summary>
Metoda zwraca podstawowe informacje dla danej postaci
</summary>
<param name="characterId"></param>
<returns>Podstawowe informacje dla danej postaci</returns>
</member>
<member name="M:SessionCompanion.Controllers.UserController.Login(System.String,System.String)">
<summary>
Metoda przyjmuje login oraz hasło i sprawdza czy istnieje użytkownik o podanych parametrach
</summary>
<param name="userName"> Nazwa użytkownika </param>
<param name="password"> Hasło </param>
<returns>Id użytkownika lub wiadomość błędu</returns>
</member>
<member name="M:SessionCompanion.Controllers.UserController.Register(SessionCompanion.ViewModels.UserViewModels.UserRegisterViewModel)">
<summary>
Metoda rejestruje podanego użytkownika
</summary>
<param name="userRegisterModel"> Model uzytkownika do zarejestrowania </param>
<returns> SuccessResponse/ErrorResponse </returns>
</member>
<member name="M:SessionCompanion.Controllers.UserController.IsGameMasterAllreadyLogged">
<summary>
Metoda sprawdza czy ktoś jest już zalogowany jako Game Master
</summary>
<returns>true jesli ktoś jest już zalogowany i false jeśli nie</returns>
</member>
<member name="F:SessionCompanion.Hubs.SessionHub.sessionHubData">
<summary>
Klasa zawierająca wszystkie dane potrzebne w SignalR odnośnie aktualnej sesji
</summary>
</member>
<member name="M:SessionCompanion.Hubs.SessionHub.OnDisconnectedAsync(System.Exception)">
<summary>
Metoda nadpisuje istniejącą metodę wywoływaną na utratę połączenia.
Ma ona za zadanie usunąć odłączonego gracza z listy zalogowanych.
Pozostałe ekrany zostają powiadomione wiadomością "GoodBye"
</summary>
<param name="exception">Błąd/przyczyna odłączenia</param>
</member>
<member name="M:SessionCompanion.Hubs.SessionHub.GameMasterLogin">
<summary>
Logowanie do Huba dla GM
Wysyła wiadomość "Welcome" do wszystkich zalogowanych użytkoników
</summary>
<returns>Zwraca true - jeśli udało się zalogować, false - jesli ktoś zalogował się już jako GM</returns>
</member>
<member name="M:SessionCompanion.Hubs.SessionHub.SendMessageToPlayer(System.Int32,System.String)">
<summary>
Metoda wysyła wiadomość do konkretnego gracza [MessageFromGameMaster]
</summary>
<param name="characterId"> Id postaci któa ma otrzymać wiadomość </param>
<param name="message"> Wiadomość do wysłania </param>
</member>
<member name="M:SessionCompanion.Hubs.SessionHub.SendMessageToAllPlayers(System.String)">
<summary>
Metoda wysyła wiadomość do wszystkich graczy [MessageFromGameMaster]
</summary>
<param name="message"> Wiadomość do wysłania </param>
</member>
<member name="M:SessionCompanion.Hubs.SessionHub.PlayerCharacterLogin(System.Int32)">
<summary>
Logowanie do Huba dla Gracza
</summary>
<param name="characterId"> Identyfikator zalogowanego bohatera </param>
<returns>Wysyła wiadomość "Welcome" do wszystkich zalogowanych użytkoników</returns>
</member>
<member name="T:SessionCompanion.Hubs.SessionHubData">
<summary>
Statyczna klasa przechowujaca informacje dotyczące SignalR dla SessionHub
</summary>
</member>
<member name="F:SessionCompanion.Hubs.SessionHubData.ConnectedCharacters">
<summary>
Lista zalogowanych graczy i identyfikator wybranej postaci
</summary>
</member>
<member name="F:SessionCompanion.Hubs.SessionHubData.GameMasterConnected">
<summary>
Status, czy GM został już zalogowany
</summary>
</member>
<member name="P:SessionCompanion.Hubs.SessionHubData.GameMasterConnected_Prop">
<summary>
Zwraca lub ustawia status zalogowania GM
</summary>
</member>
<member name="P:SessionCompanion.Hubs.SessionHubData.ConnectedCharacters_Prop">
<summary>
Zwraca lub ustawia listę zalogowanych postaci
</summary>
</member>
</members>
</doc>