Pakku/teksturepako.pakku.api.platforms/Platform

Platform

abstract class Platform(val name: String, val serialName: String, val shortName: String, val apiUrl: String, val apiVersion: Int, val siteUrl: String) : Provider

Platform is a site containing projects.

Parameters

name

Platform name.

serialName

Snake case version of the name.

apiUrl

The API URL address of this platform.

apiVersion

Version of the API.

Inheritors

CurseForge

Modrinth

Constructors

Platform

constructor(name: String, serialName: String, shortName: String, apiUrl: String, apiVersion: Int, siteUrl: String)

Types

Companion

object Companion

Properties

apiUrl

val apiUrl: String

apiVersion

val apiVersion: Int

name

open override val name: String

serialName

open override val serialName: String

shortName

open override val shortName: String

siteUrl

open override val siteUrl: String

Functions

getCommonRequestUrl

open fun getCommonRequestUrl(apiUrl: String = this.apiUrl, apiVersion: Int = this.apiVersion): String

getUrlForProjectType

abstract fun getUrlForProjectType(projectType: ProjectType): String

requestFilesForProject

open suspend fun requestFilesForProject(mcVersions: List<String>, loaders: List<String>, project: Project, fileId: String? = null, numberOfFiles: Int = 1, projectType: ProjectType? = null): <Error class: unknown class><MutableSet<ProjectFile>, ActionError>

Requests project files for provided project, with optional number of files to take.

requestMultipleProjectFiles

abstract suspend fun requestMultipleProjectFiles(mcVersions: List<String>, loaders: List<String>, projectIdsToTypes: Map<String, ProjectType?>, ids: List<String>): <Error class: unknown class><MutableSet<ProjectFile>, ActionError>

requestMultipleProjects

abstract suspend fun requestMultipleProjects(ids: List<String>): <Error class: unknown class><MutableSet<Project>, ActionError>

requestMultipleProjectsWithFiles

abstract suspend fun requestMultipleProjectsWithFiles(mcVersions: List<String>, loaders: List<String>, projectIdsToTypes: Map<String, ProjectType?>, numberOfFiles: Int): <Error class: unknown class><MutableSet<Project>, ActionError>

requestProject

abstract suspend fun requestProject(input: String, projectType: ProjectType? = null): <Error class: unknown class><Project, ActionError>

Requests a project based on provided input.

requestProjectBody

open suspend fun requestProjectBody(input: String): <Error class: unknown class><String, ActionError>

open suspend fun requestProjectBody(input: String, bodyContent: () -> String): <Error class: unknown class><String, ActionError>

requestProjectFiles

abstract suspend fun requestProjectFiles(mcVersions: List<String>, loaders: List<String>, projectId: String, fileId: String? = null, projectType: ProjectType? = null): <Error class: unknown class><MutableSet<ProjectFile>, ActionError>

Requests project files based on minecraft versions, loaders, projectId or projectId&fileId.

requestProjectWithFiles

open suspend override fun requestProjectWithFiles(mcVersions: List<String>, loaders: List<String>, input: String, fileId: String?, numberOfFiles: Int, projectType: ProjectType?): <Error class: unknown class><Project, ActionError>

Requests a project with files, and returns a project, with optional number of files to take.

toString

open override fun toString(): String