Package de.chojo.universalis.rest.routes.requests

Class MarketBoardRequestImpl

java.lang.Object

de.chojo.universalis.rest.requests.RequestBuilder<MarketBoardResponse>

de.chojo.universalis.rest.routes.requests.MarketBoardRequestImpl

All Implemented Interfaces:

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

public class MarketBoardRequestImpl
extends RequestBuilder<MarketBoardResponse>
implements MarketBoardRequest

Implementation for a MarketBoardRequest

Field Summary

Fields inherited from class de.chojo.universalis.rest.requests.RequestBuilder

rest

Constructor Summary

Constructors

Constructor	Description
MarketBoardRequestImpl(UniversalisRestImpl rest)	Create a new market board request

Method Summary

Modifier and Type	Method	Description
MarketBoardRequest	dataCenter(DataCenter dataCenter)	Data center scope of the request.
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	items(Item... items)	Items to lookup
MarketBoardRequest	items(Collection<Item> items)	Items to lookup
MarketBoardRequest	itemsIds(Integer... itemIds)	Item ids to lookup
MarketBoardRequest	itemsIds(Collection<Integer> itemIds)	Item ids to lookup
MarketBoardRequest	listingsLimit(int limit)	The number of entries to return.
MarketBoardRequest	noGst()	Deprecated, for removal: This API element is subject to removal in a future version.
MarketBoardRequest	noGst(boolean noGst)	Deprecated, for removal: This API element is subject to removal in a future version.
MarketBoardRequest	region(Region region)	Region scope of the request.
MarketBoardRequest	statsTime(Duration duration)	The amount of time before now to calculate stats over.
MarketBoardRequest	world(World world)	World scope of the request.

Methods inherited from class de.chojo.universalis.rest.requests.RequestBuilder

complete, parameter, path, path, queue, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.chojo.universalis.rest.routes.api.MarketBoardRequest

normalQuality

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

complete, queue

Constructor Details

MarketBoardRequestImpl

public MarketBoardRequestImpl(UniversalisRestImpl rest)

Create a new market board request

Parameters:

rest - rest client

Method Details

region

@CheckReturnValue
public MarketBoardRequest region(Region region)

Description copied from interface: RegionScope

Region scope of the request.

Calling this again will remove other scopes.

Specified by:

region in interface RegionScope<RegionMarketBoardRequest>

Parameters:

region - region

Returns:

request builder

dataCenter

@CheckReturnValue
public MarketBoardRequest dataCenter(DataCenter dataCenter)

Description copied from interface: DataCenterScope

Data center scope of the request.

Calling this again will remove other scopes.

Specified by:

dataCenter in interface DataCenterScope<RegionMarketBoardRequest>

Parameters:

dataCenter - data center

Returns:

request builder

world

@CheckReturnValue
public MarketBoardRequest world(World world)

Description copied from interface: WorldScope

World scope of the request.

Calling this again will remove other scopes.

Specified by:

world in interface WorldScope<RegionMarketBoardRequest>

Parameters:

world - world

Returns:

request builder

items

@CheckReturnValue
public MarketBoardRequest items(Item... items)

Description copied from interface: ItemScope

Items to lookup

Specified by:

items in interface ItemScope<MarketBoardRequest>

Parameters:

items - items

Returns:

request builder

items

@CheckReturnValue
public MarketBoardRequest items(Collection<Item> items)

Description copied from interface: ItemScope

Items to lookup

Specified by:

items in interface ItemScope<MarketBoardRequest>

Parameters:

items - items

Returns:

request builder

itemsIds

@CheckReturnValue
public MarketBoardRequest itemsIds(Integer... itemIds)

Description copied from interface: ItemScope

Item ids to lookup

Specified by:

itemsIds in interface ItemScope<MarketBoardRequest>

Parameters:

itemIds - item ids

Returns:

request builder

itemsIds

@CheckReturnValue
public MarketBoardRequest itemsIds(Collection<Integer> itemIds)

Description copied from interface: ItemScope

Item ids to lookup

Specified by:

itemsIds in interface ItemScope<MarketBoardRequest>

Parameters:

itemIds - item ids

Returns:

request builder

listingsLimit

@CheckReturnValue
public MarketBoardRequest listingsLimit(int limit)

Description copied from interface: MarketBoardRequest

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

Specified by:

listingsLimit in interface MarketBoardRequest

Parameters:

limit - limit

Returns:

request

historyLimit

@CheckReturnValue
public MarketBoardRequest historyLimit(int limit)

Description copied from interface: MarketBoardRequest

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

Specified by:

historyLimit in interface MarketBoardRequest

Parameters:

limit - limit

Returns:

request

noGst

@CheckReturnValue
@Deprecated(forRemoval=true)
public MarketBoardRequest noGst()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: MarketBoardRequest

If the result should not have Gil sales tax (GST) factored in. GST is applied to all consumer purchases in-game, and is separate from the retainer city tax that impacts what sellers receive. By default, GST is factored in.

Specified by:

noGst in interface MarketBoardRequest

Returns:

request

noGst

@CheckReturnValue
@Deprecated(forRemoval=true)
public MarketBoardRequest noGst(boolean noGst)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: MarketBoardRequest

If the result should not have Gil sales tax (GST) factored in. GST is applied to all consumer purchases in-game, and is separate from the retainer city tax that impacts what sellers receive. By default, GST is factored in.

Specified by:

noGst in interface MarketBoardRequest

Parameters:

noGst - set to true to disable GST

Returns:

request

highQuality

@CheckReturnValue
public MarketBoardRequest highQuality()

Description copied from interface: MarketBoardRequest

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

Specified by:

highQuality in interface MarketBoardRequest

Returns:

request

highQuality

@CheckReturnValue
public MarketBoardRequest highQuality(boolean highQuality)

Description copied from interface: MarketBoardRequest

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

Specified by:

highQuality in interface MarketBoardRequest

Parameters:

highQuality - set to true to only receive hq listings

Returns:

request

historyTime

@CheckReturnValue
public MarketBoardRequest historyTime(Duration duration)

Description copied from interface: MarketBoardRequest

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

Specified by:

historyTime in interface MarketBoardRequest

Parameters:

duration - duration

Returns:

request

statsTime

@CheckReturnValue
public MarketBoardRequest statsTime(Duration duration)

Description copied from interface: MarketBoardRequest

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

Affects MarketBoardResponse.saleVelocity()

Specified by:

statsTime in interface MarketBoardRequest

Parameters:

duration - duration

Returns:

request