masecla.modrinth4j.endpoints.teams

Class TeamsEndpoints

java.lang.Object

masecla.modrinth4j.endpoints.teams.TeamsEndpoints

public class TeamsEndpoints
extends Object

This class is used to represent the endpoints for teams.

Constructor Summary

Constructors

Constructor and Description
TeamsEndpoints()

Method Summary

Modifier and Type	Method and Description
CompletableFuture<EmptyResponse>	addMemberToTeam(String teamId, String userId) This endpoint is used to add a member to a team.
CompletableFuture<List<ModrinthTeamMember>>	getProjectTeamMembers(String projectId) This endpoint is used to get the team members of a project.
CompletableFuture<List<List<ModrinthTeamMember>>>	getTeamMembers(List<String> teamIds) This endpoint is used to get the team members of multiple teams by their IDs.
CompletableFuture<List<List<ModrinthTeamMember>>>	getTeamMembers(String... teamIds) This endpoint is used to get the team members of multiple teams by their IDs.
CompletableFuture<List<ModrinthTeamMember>>	getTeamMembers(String teamId) This endpoint is used to get the team members of a team.
CompletableFuture<EmptyResponse>	joinTeam(String teamId) This endpoint is used to join a team.
CompletableFuture<EmptyResponse>	modifyTeamMemberInfo(String teamId, String memberId, ModifyTeamMemberInfo.ModifyTeamMemberInfoRequest request) This endpoint is used to modify a team member's information.
CompletableFuture<EmptyResponse>	removeMemberFromTeam(String teamId, String memberId) This endpoint is used to remove a member from a team.
CompletableFuture<EmptyResponse>	transferOwnership(String teamId, String newOwnerId) This endpoint is used to transfer ownership of a team to another user.

Methods inherited from class java.lang.Object

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

Constructor Detail

TeamsEndpoints

public TeamsEndpoints()

Method Detail

getProjectTeamMembers

public CompletableFuture<List<ModrinthTeamMember>> getProjectTeamMembers(String projectId)

This endpoint is used to get the team members of a project.

Parameters:

projectId - - The ID of the project to get the team members of.

Returns:

- A CompletableFuture that will return the team members of the project.

getTeamMembers

public CompletableFuture<List<ModrinthTeamMember>> getTeamMembers(String teamId)

This endpoint is used to get the team members of a team.

Parameters:

teamId - - The ID of the team to get the members of.

Returns:

- A CompletableFuture that will return the team members of the team.

getTeamMembers

public CompletableFuture<List<List<ModrinthTeamMember>>> getTeamMembers(List<String> teamIds)

This endpoint is used to get the team members of multiple teams by their IDs.

Parameters:

teamIds - - The IDs of the teams to get the members of.

Returns:

- A CompletableFuture that will return the team members of the teams.

See Also:

getTeamMembers(String[])

getTeamMembers

public CompletableFuture<List<List<ModrinthTeamMember>>> getTeamMembers(String... teamIds)

This endpoint is used to get the team members of multiple teams by their IDs.

Parameters:

teamIds - - The IDs of the teams to get the members of.

Returns:

- A CompletableFuture that will return the team members of the teams.

See Also:

getTeamMembers(List)

addMemberToTeam

public CompletableFuture<EmptyResponse> addMemberToTeam(String teamId,
                                                        String userId)

This endpoint is used to add a member to a team.

Parameters:

teamId - - The ID of the team

userId - - The ID of the user (NOT the username)

Returns:

- A CompletableFuture that will return an empty response when completed

joinTeam

public CompletableFuture<EmptyResponse> joinTeam(String teamId)

This endpoint is used to join a team.

Parameters:

teamId - - The ID of the team

Returns:

- A CompletableFuture that will return an empty response when completed

modifyTeamMemberInfo

public CompletableFuture<EmptyResponse> modifyTeamMemberInfo(String teamId,
                                                             String memberId,
                                                             ModifyTeamMemberInfo.ModifyTeamMemberInfoRequest request)

This endpoint is used to modify a team member's information.

Parameters:

teamId - - The ID of the team

memberId - - The ID of the member (NOT the username)

request - - The request to send

Returns:

- A CompletableFuture that will return an empty response when completed

removeMemberFromTeam

public CompletableFuture<EmptyResponse> removeMemberFromTeam(String teamId,
                                                             String memberId)

This endpoint is used to remove a member from a team.

Parameters:

teamId - - The ID of the team

memberId - - The ID of the member (NOT the username)

Returns:

- A CompletableFuture that will return an empty response when completed

transferOwnership

public CompletableFuture<EmptyResponse> transferOwnership(String teamId,
                                                          String newOwnerId)

This endpoint is used to transfer ownership of a team to another user.

Parameters:

teamId - - The ID of the team

newOwnerId - - The ID of the new owner (NOT the username)

Returns:

- A CompletableFuture that will return an empty response when completed