TimedTopperAPI

https://topper-mc.github.io/TimedTopperAPI
Admin
TimedTopperAPI is an API for the TimedTopper project, providing core functionalities and event...
Tokens:3,383
Snippets:25
Trust Score:8.3
Update:8 months ago
Show doc for...
Tokens:
Raw
### TimedTopperAPI Instance

Source: https://topper-mc.github.io/TimedTopperAPI/me/hsgamer/timedtopper/api/TimedTopperAPI

Provides a way to get the singleton instance of the TimedTopperAPI.

```APIDOC
## GET /api/timetopper/instance

### Description
Retrieves the singleton instance of the TimedTopperAPI.

### Method
GET

### Endpoint
/api/timetopper/instance

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **instance** (TimedTopperAPI) - The instance of the TimedTopperAPI.

#### Response Example
```json
{
  "instance": "com.example.TimedTopperAPI@12345678"
}
```
```

--------------------------------

### Get Data by Holder

Source: https://topper-mc.github.io/TimedTopperAPI/me/hsgamer/timedtopper/api/TimedTopperAPI

Retrieves all timed data associated with a specific holder.

```APIDOC
## GET /api/timetopper/data/{holder}

### Description
Gets the data of the holder.

### Method
GET

### Endpoint
/api/timetopper/data/{holder}

### Parameters
#### Path Parameters
- **holder** (String) - Required - The name of the holder whose data is to be retrieved.

### Request Example
None

### Response
#### Success Response (200)
- **data** (Map<UUID, TimedData>) - A map where keys are UUIDs and values are TimedData objects associated with the holder.

#### Response Example
```json
{
  "data": {
    "a1b2c3d4-e5f6-7890-1234-567890abcdef": {
      "timestamp": 1678886400,
      "value": "some data"
    }
  }
}
```
```

--------------------------------

### TimeRange Interface

Source: https://topper-mc.github.io/TimedTopperAPI/me/hsgamer/timedtopper/api/data/TimeRange

Documentation for the TimeRange interface, which represents a time range with start and end times.

```APIDOC
## TimeRange Interface

### Description
Represents a time range with methods to retrieve the start and end times as Unix timestamps in milliseconds.

### Methods

#### `startTime()`

##### Description
Gets the Unix timestamp in milliseconds of the start time.

##### Method
`long`

##### Return Value
- `long`: The start time in milliseconds.

#### `endTime()`

##### Description
Gets the Unix timestamp in milliseconds of the end time.

##### Method
`long`

##### Return Value
- `long`: The end time in milliseconds.
```

--------------------------------

### Get Holders

Source: https://topper-mc.github.io/TimedTopperAPI/me/hsgamer/timedtopper/api/TimedTopperAPI

Retrieves a collection of all available holder names from the TimedTopperAPI.

```APIDOC
## GET /api/timetopper/holders

### Description
Gets the names of all available holders.

### Method
GET

### Endpoint
/api/timetopper/holders

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **holders** (Collection<String>) - A collection of strings, where each string is a holder name.

#### Response Example
```json
{
  "holders": [
    "holder1",
    "holder2"
  ]
}
```
```

--------------------------------

### Get Data by Holder and UUID

Source: https://topper-mc.github.io/TimedTopperAPI/me/hsgamer/timedtopper/api/TimedTopperAPI

Retrieves specific timed data for a holder using a unique UUID.

```APIDOC
## GET /api/timetopper/data/{holder}/{uuid}

### Description
Gets the data of a unique id within the holder.

### Method
GET

### Endpoint
/api/timetopper/data/{holder}/{uuid}

### Parameters
#### Path Parameters
- **holder** (String) - Required - The name of the holder.
- **uuid** (UUID) - Required - The unique identifier for the data.

### Request Example
None

### Response
#### Success Response (200)
- **timedData** (TimedData) - The TimedData object corresponding to the provided UUID and holder, if found.

#### Error Response (404)
- **message** (String) - Indicates that the data for the given UUID was not found.

#### Response Example
```json
{
  "timedData": {
    "timestamp": 1678886400,
    "value": "specific data"
  }
}
```
```

--------------------------------

### Get Time Range by Holder

Source: https://topper-mc.github.io/TimedTopperAPI/me/hsgamer/timedtopper/api/TimedTopperAPI

Retrieves the time range associated with a specific holder.

```APIDOC
## GET /api/timetopper/timerange/{holder}

### Description
Gets the time range of the holder.

### Method
GET

### Endpoint
/api/timetopper/timerange/{holder}

### Parameters
#### Path Parameters
- **holder** (String) - Required - The name of the holder whose time range is to be retrieved.

### Request Example
None

### Response
#### Success Response (200)
- **timeRange** (TimeRange) - An object representing the time range (e.g., start and end times) of the holder.

#### Error Response (404)
- **message** (String) - Indicates that the holder does not exist.

#### Response Example
```json
{
  "timeRange": {
    "startTime": 1678886400,
    "endTime": 1678972800
  }
}
```
```

--------------------------------

### TimedTopperAPI Instance Retrieval

Source: https://topper-mc.github.io/TimedTopperAPI/me/hsgamer/timedtopper/api/class-use/TimedTopperAPI

This section details how to obtain an instance of the TimedTopperAPI.

```APIDOC
## GET /api/timedtopper/instance

### Description
Retrieves the singleton instance of the TimedTopperAPI.

### Method
GET

### Endpoint
/api/timedtopper/instance

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **instance** (TimedTopperAPI) - The singleton instance of the TimedTopperAPI.

#### Response Example
```json
{
  "instance": "[TimedTopperAPI Object Reference]"
}
```
```

--------------------------------

### TimedTopperAPI Usage in me.hsgamer.timedtopper.api

Source: https://topper-mc.github.io/TimedTopperAPI/me/hsgamer/timedtopper/api/class-use/TimedTopperAPI

Information on how the TimedTopperAPI is utilized within the me.hsgamer.timedtopper.api package.

```APIDOC
## Package: me.hsgamer.timedtopper.api

### Description
This package utilizes the TimedTopperAPI. It provides access to the API instance through a static field and a static method.

### Fields
#### `static final AtomicReference<TimedTopperAPI> INSTANCE`
- **Description**: The reference of the instance of the API.

### Methods
#### `static TimedTopperAPI getInstance()`
- **Description**: Get the instance of the API.
- **Returns**: An instance of TimedTopperAPI.
```

--------------------------------

### TimedData Interface Methods

Source: https://topper-mc.github.io/TimedTopperAPI/me/hsgamer/timedtopper/api/data/TimedData

This section details the methods available within the TimedData interface for accessing and calculating data points.

```APIDOC
## TimedData Interface

### Description
The TimedData interface represents a data entry with associated timing information. It provides methods to retrieve the initial value, the current value, the difference between them, and the timestamp of the last update.

### Methods

#### `initial()`

##### Description
Get the initial value of the timed data entry.

##### Method
GET

##### Endpoint
`/timeddata/initial`

##### Response
* **Success Response (200)**
  - **value** (double) - The initial value.

##### Response Example
```json
{
  "value": 100.5
}
```

#### `current()`

##### Description
Get the current value of the timed data entry.

##### Method
GET

##### Endpoint
`/timeddata/current`

##### Response
* **Success Response (200)**
  - **value** (double) - The current value.

##### Response Example
```json
{
  "value": 120.75
}
```

#### `timestamp()`

##### Description
Get the Unix timestamp in milliseconds of the last update.

##### Method
GET

##### Endpoint
`/timeddata/timestamp`

##### Response
* **Success Response (200)**
  - **timestamp** (long) - The Unix timestamp in milliseconds.

##### Response Example
```json
{
  "timestamp": 1678886400000
}
```

#### `diff()`

##### Description
Get the difference between the initial value and the current value.

##### Method
GET

##### Endpoint
`/timeddata/diff`

##### Response
* **Success Response (200)**
  - **difference** (double) - The difference between the initial and current values.

##### Response Example
```json
{
  "difference": 20.25
}
```
```

--------------------------------

### TimedTopperAPI - getData(String holder)

Source: https://topper-mc.github.io/TimedTopperAPI/me/hsgamer/timedtopper/api/data/class-use/TimedData

Retrieves all TimedData associated with a given holder.

```APIDOC
## GET /api/timedtopper/{holder}/data

### Description
Retrieves all TimedData associated with a given holder.

### Method
GET

### Endpoint
`/api/timedtopper/{holder}/data`

### Parameters
#### Path Parameters
- **holder** (String) - Required - The identifier of the holder.

### Response
#### Success Response (200)
- **Map<UUID, TimedData>** - A map where keys are UUIDs and values are TimedData objects.

#### Response Example
```json
{
  "example": "{\"uuid1\": {\"data\": \"some_value\"}, \"uuid2\": {\"data\": \"another_value\"}}"
}
```
```

--------------------------------

### HolderResetEvent

Source: https://topper-mc.github.io/TimedTopperAPI/me/hsgamer/timedtopper/api/data/class-use/TimedData

Represents an event triggered when a holder's data is reset. Provides access to the ordered list of entries.

```APIDOC
## Event: HolderResetEvent

### Description
Represents an event triggered when a holder's data is reset. Provides access to the ordered list of entries.

### Constructor
`HolderResetEvent(boolean isAsync, String holder, List<Map.Entry<UUID,TimedData>> top)`
`HolderResetEvent(String holder, List<Map.Entry<UUID,TimedData>> top)`

### Methods
#### getTop()
- **Returns**: `List<Map.Entry<UUID,TimedData>>` - The list of entries, ordered by the difference of the data.

### Response Example (Conceptual)
```json
{
  "holder": "example_holder",
  "topEntries": [
    {
      "uuid": "uuid1",
      "timedData": {"data": "value1"}
    },
    {
      "uuid": "uuid2",
      "timedData": {"data": "value2"}
    }
  ]
}
```
```

--------------------------------

### Check Holder Existence

Source: https://topper-mc.github.io/TimedTopperAPI/me/hsgamer/timedtopper/api/TimedTopperAPI

Checks if a specific holder exists within the TimedTopperAPI.

```APIDOC
## GET /api/timetopper/holders/{holder}

### Description
Checks if a holder exists.

### Method
GET

### Endpoint
/api/timetopper/holders/{holder}

### Parameters
#### Path Parameters
- **holder** (String) - Required - The name of the holder to check.

### Request Example
None

### Response
#### Success Response (200)
- **exists** (boolean) - True if the holder exists, false otherwise.

#### Response Example
```json
{
  "exists": true
}
```
```

--------------------------------

### TimedTopperAPI - getData(String holder, UUID uuid)

Source: https://topper-mc.github.io/TimedTopperAPI/me/hsgamer/timedtopper/api/data/class-use/TimedData

Retrieves specific TimedData for a given holder and unique identifier.

```APIDOC
## GET /api/timedtopper/{holder}/data/{uuid}

### Description
Retrieves specific TimedData for a given holder and unique identifier.

### Method
GET

### Endpoint
`/api/timedtopper/{holder}/data/{uuid}`

### Parameters
#### Path Parameters
- **holder** (String) - Required - The identifier of the holder.
- **uuid** (UUID) - Required - The unique identifier for the TimedData.

### Response
#### Success Response (200)
- **Optional<TimedData>** - An optional TimedData object if found.

#### Response Example
```json
{
  "example": "{\"data\": \"specific_value\"}"
}
```
```
Tokens:
Raw