Module modrinthapi

Package ovh.paulem.modrinthapi

Class Modrinth

java.lang.Object

ovh.paulem.modrinthapi.Modrinth

public class Modrinth
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static String	MODRINTH_API_LINK

Constructor Summary

Constructors

Constructor	Description
Modrinth(@Nullable String authorization, @NotNull String projectName)
Modrinth(@Nullable String authorization, @Nullable String githubUsername, @NotNull String projectName, @Nullable String version)
Modrinth(@Nullable String authorization, @Nullable String githubUsername, @NotNull String projectName, @Nullable String version, @NotNull String mail, @NotNull String mailDomain)
Modrinth(@Nullable String authorization, @Nullable String githubUsername, @NotNull String projectName, @Nullable String version, @Nullable String website)

Method Summary

Modifier and Type	Method	Description
@Nullable String	getAuthorization()
Project	getProject(@NotNull String slugOrId)
String	getUserAgent()
ListVersions	listVersions(@NotNull String slugOrId)
ListVersions	listVersions(@NotNull Project project)
SearchProject	searchProject(@Nullable String query, @Nullable String facets, @Nullable String index, @Nullable Integer offset, @Nullable Integer limit)

Methods inherited from class java.lang.Object

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

Field Details

MODRINTH_API_LINK

public static String MODRINTH_API_LINK

Constructor Details

Modrinth

public Modrinth(@Nullable
 @Nullable String authorization,
 @NotNull
 @NotNull String projectName)

Modrinth

public Modrinth(@Nullable
 @Nullable String authorization,
 @Nullable
 @Nullable String githubUsername,
 @NotNull
 @NotNull String projectName,
 @Nullable
 @Nullable String version)

Modrinth

public Modrinth(@Nullable
 @Nullable String authorization,
 @Nullable
 @Nullable String githubUsername,
 @NotNull
 @NotNull String projectName,
 @Nullable
 @Nullable String version,
 @NotNull
 @NotNull String mail,
 @NotNull
 @NotNull String mailDomain)

Modrinth

public Modrinth(@Nullable
 @Nullable String authorization,
 @Nullable
 @Nullable String githubUsername,
 @NotNull
 @NotNull String projectName,
 @Nullable
 @Nullable String version,
 @Nullable
 @Nullable String website)

Method Details

searchProject

public SearchProject searchProject(@Nullable
 @Nullable String query,
 @Nullable
 @Nullable String facets,
 @Nullable
 @Nullable String index,
 @Nullable
 @Nullable Integer offset,
 @Nullable
 @Nullable Integer limit)
                            throws IOException,
URISyntaxException

Throws:

IOException

URISyntaxException

getProject

public Project getProject(@NotNull
 @NotNull String slugOrId)
                   throws URISyntaxException,
IOException

Throws:

URISyntaxException

IOException

listVersions

public ListVersions listVersions(@NotNull
 @NotNull Project project)
                          throws URISyntaxException,
IOException

Throws:

URISyntaxException

IOException

listVersions

public ListVersions listVersions(@NotNull
 @NotNull String slugOrId)
                          throws URISyntaxException,
IOException

Throws:

URISyntaxException

IOException

getUserAgent

public String getUserAgent()

getAuthorization

@Nullable
public @Nullable String getAuthorization()