/TheAltening4j

TheAltening API implementation in Java

Primary LanguageJavaGNU Lesser General Public License v3.0LGPL-3.0

The Altening API for Java

Java 8+ Maven Central

GitHub license

TheAltening API made by Vladymyr now branded under the official repo with the release tag "4.0.0"

Gradle

repositories {
	mavenCentral()
}
dependencies {
	implementation 'com.thealtening.api:api:@BADGE-VERSION@'
}

Maven

<dependencies>
	<dependency>
		<groupId>com.thealtening.api</groupId>
		<artifactId>api</artifactId>
		<version>@BADGE-VERSION@</version>
	</dependency>
</dependencies>

Prerequisites

  • Use JDK 1.8+

Usage

To create a new BasicDataRetriever instance depending on the wanted type:

import com.thealtening.api.TheAltening

BasicDataRetriever basicDataRetriever = TheAltening.newBasicRetriever("api key");
AsynchronousDataRetriever asynchronousDataRetriever = TheAltening.newAsyncRetriever("api key");

you also can pass the BasicDataRetriever to AsynchronousDataRetriever using toAsync:

AsynchronousDataRetriever asynchronousDataRetriever = basicDataRetriever.toAsync();

Even though most of the other methods are self-explanatory. If you want a little bit more detailed use of the API check out the tests.