Package de.chojo.universalis.rest.routes.api

Interface HistoryRequest

All Superinterfaces:

BlankHistoryRequest, DataCenterScope<RegionHistoryRequest>, ItemScope<HistoryRequest>, LimitedRequest<HistoryRequest>, RegionHistoryRequest, RegionScope<RegionHistoryRequest>, Request<HistoryResponse>, WorldScope<RegionHistoryRequest>

All Known Implementing Classes:

HistoryRequestImpl

public interface HistoryRequest
extends Request<HistoryResponse>, RegionHistoryRequest, LimitedRequest<HistoryRequest>

Base implementation for a HistoryRequestImpl

Method Summary

Modifier and Type	Method	Description
HistoryRequest	historyTime(Duration duration)	The amount of time before now to take entries within the history data returned by MarketBoardResponse.recentHistory().
HistoryRequest	limit(int limit)	Set the limit of retrieved entries for this request
HistoryRequest	statsTime(Duration duration)	The amount of time before now to calculate stats over.

Methods inherited from interface de.chojo.universalis.rest.routes.api.base.DataCenterScope

dataCenter

Methods inherited from interface de.chojo.universalis.rest.routes.api.base.ItemScope

items, items, itemsIds, itemsIds

Methods inherited from interface de.chojo.universalis.rest.routes.api.base.RegionScope

region

Methods inherited from interface de.chojo.universalis.rest.requests.Request

complete, queue

Methods inherited from interface de.chojo.universalis.rest.routes.api.base.WorldScope

world

Method Details

limit

@CheckReturnValue
HistoryRequest limit(int limit)

Set the limit of retrieved entries for this request

Default: 1800 Max: 999999

Specified by:

limit in interface LimitedRequest<HistoryRequest>

Parameters:

limit - limit

Returns:

request builder

historyTime

@CheckReturnValue
HistoryRequest historyTime(Duration duration)

The amount of time before now to take entries within the history data returned by MarketBoardResponse.recentHistory().

Parameters:

duration - duration

Returns:

request

statsTime

@CheckReturnValue
HistoryRequest statsTime(Duration duration)

The amount of time before now to calculate stats over. By default, this is 7 days.

Affects MarketBoardResponse.saleVelocity()

Parameters:

duration - duration

Returns:

request