Interface MarketBoardRequest

All Superinterfaces:

BlankMarketBoardRequest, DataCenterScope<RegionMarketBoardRequest>, ItemScope<MarketBoardRequest>, RegionMarketBoardRequest, RegionScope<RegionMarketBoardRequest>, Request<MarketBoardResponse>, WorldScope<RegionMarketBoardRequest>

All Known Implementing Classes:

MarketBoardRequestImpl

public interface MarketBoardRequest
extends Request<MarketBoardResponse>, RegionMarketBoardRequest

Base implementation for a MarketBoardRequestImpl

Method Summary

Modifier and Type	Method	Description
default MarketBoardRequest	highQuality()	Filter for HQ listings and entries.
MarketBoardRequest	highQuality(boolean highQuality)	Filter for HQ listings and entries.
MarketBoardRequest	historyLimit(int limit)	The number of entries to return.
MarketBoardRequest	historyTime(Duration duration)	The amount of time before now to take entries within the history data returned by MarketBoardResponse.recentHistory().
MarketBoardRequest	listingsLimit(int limit)	The number of entries to return.
default MarketBoardRequest	normalQuality()	Filter for NQ listings and entries.
MarketBoardRequest	statsTime(Duration duration)	The amount of time before now to calculate stats over.

Methods inherited from interface DataCenterScope

dataCenter

Methods inherited from interface ItemScope

items, items, itemsIds, itemsIds

Methods inherited from interface RegionScope

region

Methods inherited from interface Request

complete, queue

Methods inherited from interface WorldScope

world

Method Details

listingsLimit

@CheckReturnValue
MarketBoardRequest listingsLimit(int limit)

The number of entries to return. By default, all listings will be returned.

Parameters:

limit - limit

Returns:

request

historyLimit

@CheckReturnValue
MarketBoardRequest historyLimit(int limit)

The number of entries to return. By default, a maximum of 5 entries will be returned.

Parameters:

limit - limit

Returns:

request

highQuality

@CheckReturnValue
default MarketBoardRequest highQuality()

Filter for HQ listings and entries. By default, both HQ and NQ listings and entries will be returned.

Returns:

request

normalQuality

@CheckReturnValue
default MarketBoardRequest normalQuality()

Filter for NQ listings and entries. By default, both HQ and NQ listings and entries will be returned.

Returns:

request

highQuality

@CheckReturnValue
MarketBoardRequest highQuality(boolean highQuality)

Filter for HQ listings and entries. By default, both HQ and NQ listings and entries will be returned.

Parameters:

highQuality - set to true to only receive hq listings

Returns:

request

historyTime

@CheckReturnValue
MarketBoardRequest 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
MarketBoardRequest 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