s426135/session-companion
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge pull request 'SES-129 Endpoint zaklęć' (#53) from SES-129 into dev

Browse Source 
Reviewed-on: #53
This commit is contained in:
Łukasz Góreczny 2021-01-09 14:09:32 +01:00
commit 046ba41ebb
2 changed files with 176 additions and 134 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
SessionCompanion/SessionCompanion/Controllers/SpellController.cs Normal file
View File

@ -0,0 +1,42 @@
using Microsoft.AspNetCore.Mvc;
using SessionCompanion.Extensions.EitherType;
using SessionCompanion.Services.Interfaces;
using SessionCompanion.ViewModels.ApiResponses;
using SessionCompanion.ViewModels.SpellViewModels;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
namespace SessionCompanion.Controllers
{
[Route("api/spell")]
[ApiController]
public class SpellController : Controller
{
private readonly ISpellService _service;
public SpellController(ISpellService service) => _service = service;
/// <summary>
/// Metoda zwraca wszystkie dostępne zaklecia
/// </summary>
/// <returns>Lista wszystkich zaklęć w bazie danych</returns>
[HttpGet("getAllSpells")]
public async Task<Either<List<SpellViewModel>, ErrorResponse>> GetSpells()
{
try
{
var spells = _service.Get().ToList();
return spells;
}
catch (Exception e)
{
return new ErrorResponse()
{
StatusCode = 204,
Message = e.Message
};
}
}
}
}

268
SessionCompanion/SessionCompanion/SessionCompanion.xml
View File

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