HuskSync/docs/API.md

HuskSync API v2

The HuskSync API provides methods for retrieving and updating user data, as well as a number of events for tracking when user data is synced and saved.

The API is distributed via JitPack. Please note that the HuskSync v1 API is not compatible. (Some) javadocs are also available to view on Jitpack here.

Table of contents

1. Adding the API to your project
2. Adding HuskSync as a dependency
3. Next steps

API Introduction

1.1 Setup with Maven

Maven setup information

• Add the repository to your pom.xml as per below.

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

• Add the dependency to your pom.xml as per below. Replace version with the latest version of HuskSync (without the v):

<dependency>
    <groupId>net.william278</groupId>
    <artifactId>HuskSync</artifactId>
    <version>version</version>
    <scope>provided</scope>
</dependency>

1.2 Setup with Gradle

Gradle setup information

• Add the dependency like so to your build.gradle:

allprojects {
	repositories {
		maven { url 'https://jitpack.io' }
	}
}

• Add the dependency as per below. Replace version with the latest version of HuskSync (without the v):

dependencies {
    compileOnly 'net.william278:HuskSync:version'
}

2. Adding HuskSync as a dependency

• Add HuskSync to your softdepend (if you want to optionally use HuskSync) or depend (if your plugin relies on HuskSync) section in plugin.yml of your project.

name: MyPlugin
version: 1.0
main: net.william278.myplugin.MyPlugin
author: William278
description: 'A plugin that hooks with the HuskSync API!'
softdepend: # Or, use 'depend' here
  - HuskSync

3. Next steps

Now that you've got everything ready, you can start doing stuff with the HuskSync API!

• UserData API — Get data snapshots and update current user data
• API Events — Listen to, cancel and modify the result of data synchronization events