masecla.modrinth4j.endpoints.user

Class UserEndpoints

java.lang.Object

masecla.modrinth4j.endpoints.user.UserEndpoints

public class UserEndpoints
extends Object

This class is used to represent the endpoints for users.

Constructor Summary

Constructors

Constructor and Description
UserEndpoints()

Method Summary

Modifier and Type	Method and Description
CompletableFuture<EmptyResponse>	changeProfilePicture(String id, File file) Modifies the profile picture of a user by their ID
CompletableFuture<EmptyResponse>	changeProfilePicture(String id, InputStream stream, String filename) Modifies the profile picture of a user by their ID
CompletableFuture<EmptyResponse>	deleteUser(String id) Deletes a user by their ID
CompletableFuture<List<ModrinthUserNotification>>	getNotifications(String id) Gets the notifications of a user by their ID
CompletableFuture<ModrinthUser>	getSelf() Gets the current user from the API
CompletableFuture<List<ModrinthUser>>	getUser(List<String> ids) Gets multiple users by their IDs.
CompletableFuture<List<ModrinthUser>>	getUser(String... ids) Gets multiple users by their IDs.
CompletableFuture<ModrinthUser>	getUser(String id) Gets a user by their ID or username
CompletableFuture<List<Project>>	getUserFollowedProjects(String id) Gets the followed projects of a user by their ID
CompletableFuture<List<Project>>	getUserProjects(String id) Gets the projects of a user by their ID
CompletableFuture<EmptyResponse>	modifyUser(String id, ModifyUser.ModifyUserRequest request) Modifies a user by their ID
CompletableFuture<ReportProjectUserOrVersion.ReportProjectUserOrVersionResponse>	reportProjectUserOrVersion(ReportProjectUserOrVersion.ReportProjectUserOrVersionRequest request) Reports a project, user, or version

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserEndpoints

public UserEndpoints()

Method Detail

getUser

public CompletableFuture<ModrinthUser> getUser(String id)

Gets a user by their ID or username

Parameters:

id - - The ID or username of the user

Returns:

- The user

getUser

public CompletableFuture<List<ModrinthUser>> getUser(String... ids)

Gets multiple users by their IDs. Note: This will only work with IDs, not usernames. unlike getUser(String)

Parameters:

ids - - The IDs of the users

Returns:

- The users

getUser

public CompletableFuture<List<ModrinthUser>> getUser(List<String> ids)

Gets multiple users by their IDs. Note: This will only work with IDs, not usernames. unlike getUser(String)

Parameters:

ids - - The IDs of the users

Returns:

- The users

modifyUser

public CompletableFuture<EmptyResponse> modifyUser(String id,
                                                   ModifyUser.ModifyUserRequest request)

Modifies a user by their ID

Parameters:

id - - The ID of the user

request - - The request to send

Returns:

- A CompletableFuture that will return an EmptyResponse when complete

deleteUser

public CompletableFuture<EmptyResponse> deleteUser(String id)

Deletes a user by their ID

Parameters:

id - - The ID of the user

Returns:

- A CompletableFuture that will return an EmptyResponse when complete

getSelf

public CompletableFuture<ModrinthUser> getSelf()

Gets the current user from the API

Returns:

- The current user

changeProfilePicture

public CompletableFuture<EmptyResponse> changeProfilePicture(String id,
                                                             File file)
                                                      throws FileNotFoundException

Modifies the profile picture of a user by their ID

Parameters:

id - - The ID of the user

file - - The file to use as the profile picture

Returns:

- A CompletableFuture that will return an EmptyResponse when complete

Throws:

FileNotFoundException - - If the file cannot be found

changeProfilePicture

public CompletableFuture<EmptyResponse> changeProfilePicture(String id,
                                                             InputStream stream,
                                                             String filename)

Modifies the profile picture of a user by their ID

Parameters:

id - - The ID of the user

stream - - The stream to use as the profile picture

filename - - The filename of the profile picture

Returns:

- A CompletableFuture that will return an EmptyResponse when complete

getUserProjects

public CompletableFuture<List<Project>> getUserProjects(String id)

Gets the projects of a user by their ID

Parameters:

id - - The ID of the user

Returns:

- A CompletableFuture that will return a List of Projects when complete

getUserFollowedProjects

public CompletableFuture<List<Project>> getUserFollowedProjects(String id)

Gets the followed projects of a user by their ID

Parameters:

id - - The ID of the user

Returns:

- A CompletableFuture that will return a List of Projects when complete

getNotifications

public CompletableFuture<List<ModrinthUserNotification>> getNotifications(String id)

Gets the notifications of a user by their ID

Parameters:

id - - The ID of the user

Returns:

- A CompletableFuture that will return a List of ModrinthUserNotifications when complete

reportProjectUserOrVersion

public CompletableFuture<ReportProjectUserOrVersion.ReportProjectUserOrVersionResponse> reportProjectUserOrVersion(ReportProjectUserOrVersion.ReportProjectUserOrVersionRequest request)

Reports a project, user, or version

Parameters:

request - - The request to send

Returns:

- A CompletableFuture that will return a ReportProjectUserOrVersion.ReportProjectUserOrVersionResponse when complete