blob: 47948f454999edd461627c07815e6c709cee9b75 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
|
using System;
using System.Threading.Tasks;
using DevHive.Common.Models.Identity;
using DevHive.Services.Models.User;
namespace DevHive.Services.Interfaces
{
public interface IUserService
{
/// <summary>
/// Log ins an existing user and gives him/her a JWT Token for further authorization
/// </summary>
/// <param name="loginModel">Login service model, conaining user's username and password</param>
/// <returns>A JWT Token for authorization</returns>
Task<TokenModel> LoginUser(LoginServiceModel loginModel);
/// <summary>
/// Registers a new user and gives him/her a JWT Token for further authorization
/// </summary>
/// <param name="registerModel">Register service model, containing the new user's data</param>
/// <returns>A JWT Token for authorization</returns>
Task<TokenModel> RegisterUser(RegisterServiceModel registerModel);
/// <summary>
/// Get a user by his username. Used for querying profiles without provided authentication
/// </summary>
/// <param name="username">User's username, who's to be queried</param>
/// <returns>The queried user or null, if non existant</returns>
Task<UserServiceModel> GetUserByUsername(string username);
/// <summary>
/// Get a user by his Guid. Used for querying full user's profile
/// Requires authenticated user
/// </summary>
/// <param name="id">User's username, who's to be queried</param>
/// <returns>The queried user or null, if non existant</returns>
Task<UserServiceModel> GetUserById(Guid id);
/// <summary>
/// Updates a user's data, provided a full model with new details
/// Requires authenticated user
/// </summary>
/// <param name="updateUserServiceModel">Full update user model for updating</param>
/// <returns>Read model of the new user</returns>
Task<UserServiceModel> UpdateUser(UpdateUserServiceModel updateUserServiceModel);
/// <summary>
/// Uploads the given picture and assigns it's link to the user in the database
/// Requires authenticated user
/// </summary>
/// <param name="updateProfilePictureServiceModel">Contains User's Guid and the new picture to be updated</param>
/// <returns>The new picture's URL</returns>
Task<ProfilePictureServiceModel> UpdateProfilePicture(UpdateProfilePictureServiceModel updateProfilePictureServiceModel);
Task<bool> AddFriend(Guid id, UpdateFriendServiceModel updateFriendServiceModel);
/// <summary>
/// Deletes a user from the database and removes his data entirely
/// Requires authenticated user
/// </summary>
/// <param name="id">The user's Guid, who's to be deleted</param>
/// <returns>True if successfull, false otherwise</returns>
Task<bool> DeleteUser(Guid id);
/// <summary>
/// We don't talk about that!
/// </summary>
/// <param name="userId"></param>
/// <returns></returns>
Task<TokenModel> SuperSecretPromotionToAdmin(Guid userId);
}
}
|
