ktuniversalis/cloud.drakon.ktuniversalis

Package-level declarations

Functions

Link copied to clipboard
suspend fun getAvailableDataCenters(): List<SupportedDataCenter>

Returns all data centers supported by the Universalis API.

getAvailableDataCentersAsync
Link copied to clipboard
fun getAvailableDataCentersAsync(): Promise<Array<SupportedDataCenter>>

Returns all data centers supported by the Universalis API.

fun getAvailableDataCentersAsync(): CompletableFuture<List<SupportedDataCenter>>

Returns all data centers supported by the Universalis API.

Link copied to clipboard
suspend fun getAvailableWorlds(): List<SupportedWorld>

Returns the IDs and names of all worlds supported by the Universalis API.

getAvailableWorldsAsync
Link copied to clipboard
fun getAvailableWorldsAsync(): Promise<Array<SupportedWorld>>

Returns the IDs and names of all worlds supported by the Universalis API.

fun getAvailableWorldsAsync(): CompletableFuture<List<SupportedWorld>>

Returns the IDs and names of all worlds supported by the Universalis API.

Link copied to clipboard
suspend fun getLeastRecentlyUpdatedItems(dcName: DataCenter, entries: Short? = null): RecentlyUpdatedItems

Returns the least-recently updated items on the specified data center, along with the upload times for each item.

suspend fun getLeastRecentlyUpdatedItems(world: World, entries: Short? = null): RecentlyUpdatedItems

Returns the least-recently updated items on the specified world, along with the upload times for each item.

getLeastRecentlyUpdatedItemsAsync
Link copied to clipboard
fun getLeastRecentlyUpdatedItemsAsync(dcName: DataCenter, entries: Short? = null): Promise<RecentlyUpdatedItems>

Returns the least-recently updated items on the specified data center, along with the upload times for each item.

fun getLeastRecentlyUpdatedItemsAsync(world: World, entries: Short? = null): Promise<RecentlyUpdatedItems>

Returns the least-recently updated items on the specified world, along with the upload times for each item.

@JvmOverloads
fun getLeastRecentlyUpdatedItemsAsync(dcName: DataCenter, entries: Short? = null): CompletableFuture<RecentlyUpdatedItems>

Returns the least-recently updated items on the specified data center, along with the upload times for each item.

@JvmOverloads
fun getLeastRecentlyUpdatedItemsAsync(world: World, entries: Short? = null): CompletableFuture<RecentlyUpdatedItems>

Returns the least-recently updated items on the specified world, along with the upload times for each item.

Link copied to clipboard
suspend fun getMarketableItems(): List<Int>

Returns a list of marketable item IDs.

getMarketableItemsAsync
Link copied to clipboard
fun getMarketableItemsAsync(): Promise<IntArray>

Returns an array of marketable item IDs.

fun getMarketableItemsAsync(): CompletableFuture<List<Int>>

Returns a list of marketable item IDs.

Link copied to clipboard
suspend fun getMarketBoardCurrentData(dcName: DataCenter, itemId: Int, listings: Int? = null, entries: Int? = null, noGst: Boolean? = null, hq: Boolean? = null, statsWithin: Int? = null, entriesWithin: Int? = null): CurrentlyShown

Returns the data currently shown on the market board for the requested item ID and data center.

suspend fun getMarketBoardCurrentData(dcName: DataCenter, itemIds: List<Int>, listings: Int? = null, entries: Int? = null, noGst: Boolean? = null, hq: Boolean? = null, statsWithin: Int? = null, entriesWithin: Int? = null): Multi<CurrentlyShown>

Returns the data currently shown on the market board for the requested list of item IDs and data center.

suspend fun getMarketBoardCurrentData(region: Region, itemId: Int, listings: Int? = null, entries: Int? = null, noGst: Boolean? = null, hq: Boolean? = null, statsWithin: Int? = null, entriesWithin: Int? = null): CurrentlyShown

Returns the data currently shown on the market board for the requested item ID and region.

suspend fun getMarketBoardCurrentData(region: Region, itemIds: List<Int>, listings: Int? = null, entries: Int? = null, noGst: Boolean? = null, hq: Boolean? = null, statsWithin: Int? = null, entriesWithin: Int? = null): Multi<CurrentlyShown>

Returns the data currently shown on the market board for the requested list of item IDs and region.

suspend fun getMarketBoardCurrentData(world: World, itemId: Int, listings: Int? = null, entries: Int? = null, noGst: Boolean? = null, hq: Boolean? = null, statsWithin: Int? = null, entriesWithin: Int? = null): CurrentlyShown

Returns the data currently shown on the market board for the requested item ID and world.

suspend fun getMarketBoardCurrentData(world: World, itemIds: List<Int>, listings: Int? = null, entries: Int? = null, noGst: Boolean? = null, hq: Boolean? = null, statsWithin: Int? = null, entriesWithin: Int? = null): Multi<CurrentlyShown>

Returns the data currently shown on the market board for the requested list of item IDs and world.

getMarketBoardCurrentDataAsync
Link copied to clipboard
fun getMarketBoardCurrentDataAsync(dcName: DataCenter, itemId: Int, listings: Int? = null, entries: Int? = null, noGst: Boolean? = null, hq: Boolean? = null, statsWithin: Int? = null, entriesWithin: Int? = null): Promise<CurrentlyShown>

Returns the data currently shown on the market board for the requested item ID and data center.

fun getMarketBoardCurrentDataAsync(dcName: DataCenter, itemIds: IntArray, listings: Int? = null, entries: Int? = null, noGst: Boolean? = null, hq: Boolean? = null, statsWithin: Int? = null, entriesWithin: Int? = null): Promise<Multi<CurrentlyShown>>

Returns the data currently shown on the market board for the requested array of item IDs and data center.

fun getMarketBoardCurrentDataAsync(region: Region, itemId: Int, listings: Int? = null, entries: Int? = null, noGst: Boolean? = null, hq: Boolean? = null, statsWithin: Int? = null, entriesWithin: Int? = null): Promise<CurrentlyShown>

Returns the data currently shown on the market board for the requested item ID and region.

fun getMarketBoardCurrentDataAsync(region: Region, itemIds: IntArray, listings: Int? = null, entries: Int? = null, noGst: Boolean? = null, hq: Boolean? = null, statsWithin: Int? = null, entriesWithin: Int? = null): Promise<Multi<CurrentlyShown>>

Returns the data currently shown on the market board for the requested array of item IDs and region.

fun getMarketBoardCurrentDataAsync(world: World, itemId: Int, listings: Int? = null, entries: Int? = null, noGst: Boolean? = null, hq: Boolean? = null, statsWithin: Int? = null, entriesWithin: Int? = null): Promise<CurrentlyShown>

Returns the data currently shown on the market board for the requested item ID and world.

fun getMarketBoardCurrentDataAsync(world: World, itemIds: IntArray, listings: Int? = null, entries: Int? = null, noGst: Boolean? = null, hq: Boolean? = null, statsWithin: Int? = null, entriesWithin: Int? = null): Promise<Multi<CurrentlyShown>>

Returns the data currently shown on the market board for the requested array of item IDs and world.

@JvmOverloads
fun getMarketBoardCurrentDataAsync(dcName: DataCenter, itemId: Int, listings: Int? = null, entries: Int? = null, noGst: Boolean? = null, hq: Boolean? = null, statsWithin: Int? = null, entriesWithin: Int? = null): CompletableFuture<CurrentlyShown>

Returns the data currently shown on the market board for the requested item ID and data center.

@JvmOverloads
fun getMarketBoardCurrentDataAsync(dcName: DataCenter, itemIds: List<Int>, listings: Int? = null, entries: Int? = null, noGst: Boolean? = null, hq: Boolean? = null, statsWithin: Int? = null, entriesWithin: Int? = null): CompletableFuture<CurrentlyShown>

Returns the data currently shown on the market board for the requested list of item IDs and data center.

@JvmOverloads
fun getMarketBoardCurrentDataAsync(region: Region, itemId: Int, listings: Int? = null, entries: Int? = null, noGst: Boolean? = null, hq: Boolean? = null, statsWithin: Int? = null, entriesWithin: Int? = null): CompletableFuture<CurrentlyShown>

Returns the data currently shown on the market board for the requested item ID and region.

@JvmOverloads
fun getMarketBoardCurrentDataAsync(region: Region, itemIds: List<Int>, listings: Int? = null, entries: Int? = null, noGst: Boolean? = null, hq: Boolean? = null, statsWithin: Int? = null, entriesWithin: Int? = null): CompletableFuture<CurrentlyShown>

Returns the data currently shown on the market board for the requested list of item IDs and region.

@JvmOverloads
fun getMarketBoardCurrentDataAsync(world: World, itemId: Int, listings: Int? = null, entries: Int? = null, noGst: Boolean? = null, hq: Boolean? = null, statsWithin: Int? = null, entriesWithin: Int? = null): CompletableFuture<CurrentlyShown>

Returns the data currently shown on the market board for the requested item ID and world.

@JvmOverloads
fun getMarketBoardCurrentDataAsync(world: World, itemIds: List<Int>, listings: Int? = null, entries: Int? = null, noGst: Boolean? = null, hq: Boolean? = null, statsWithin: Int? = null, entriesWithin: Int? = null): CompletableFuture<CurrentlyShown>

Returns the data currently shown on the market board for the requested list of item IDs and world.

Link copied to clipboard
suspend fun getMarketBoardSaleHistory(dcName: DataCenter, itemId: Int, entriesToReturn: Int? = null, statsWithin: Int? = null, entriesWithin: Int? = null): History

Returns the history data for the requested item ID and data center.

suspend fun getMarketBoardSaleHistory(dcName: DataCenter, itemIds: List<Int>, entriesToReturn: Int? = null, statsWithin: Int? = null, entriesWithin: Int? = null): Multi<History>

Returns the history data for the requested list of item IDs and data center.

suspend fun getMarketBoardSaleHistory(region: Region, itemId: Int, entriesToReturn: Int? = null, statsWithin: Int? = null, entriesWithin: Int? = null): History

Returns the history data for the requested item ID and region.

suspend fun getMarketBoardSaleHistory(region: Region, itemIds: List<Int>, entriesToReturn: Int? = null, statsWithin: Int? = null, entriesWithin: Int? = null): Multi<History>

Returns the history data for the requested list of item IDs and region.

suspend fun getMarketBoardSaleHistory(world: World, itemId: Int, entriesToReturn: Int? = null, statsWithin: Int? = null, entriesWithin: Int? = null): History

Returns the history data for the requested item ID and world.

suspend fun getMarketBoardSaleHistory(world: World, itemIds: List<Int>, entriesToReturn: Int? = null, statsWithin: Int? = null, entriesWithin: Int? = null): Multi<History>

Returns the history data for the requested list of item IDs and world.

getMarketBoardSaleHistoryAsync
Link copied to clipboard
fun getMarketBoardSaleHistoryAsync(dcName: DataCenter, itemId: Int, entriesToReturn: Int? = null, statsWithin: Int? = null, entriesWithin: Int? = null): Promise<History>

Returns the history data for the requested item ID and data center.

fun getMarketBoardSaleHistoryAsync(dcName: DataCenter, itemIds: IntArray, entriesToReturn: Int? = null, statsWithin: Int? = null, entriesWithin: Int? = null): Promise<Multi<History>>

Returns the history data for the requested array of item IDs and data center.

fun getMarketBoardSaleHistoryAsync(region: Region, itemId: Int, entriesToReturn: Int? = null, statsWithin: Int? = null, entriesWithin: Int? = null): Promise<History>

Returns the history data for the requested item ID and region.

fun getMarketBoardSaleHistoryAsync(region: Region, itemIds: IntArray, entriesToReturn: Int? = null, statsWithin: Int? = null, entriesWithin: Int? = null): Promise<Multi<History>>

Returns the history data for the requested array of item IDs and region.

fun getMarketBoardSaleHistoryAsync(world: World, itemId: Int, entriesToReturn: Int? = null, statsWithin: Int? = null, entriesWithin: Int? = null): Promise<History>

Returns the history data for the requested item ID and world.

fun getMarketBoardSaleHistoryAsync(world: World, itemIds: IntArray, entriesToReturn: Int? = null, statsWithin: Int? = null, entriesWithin: Int? = null): Promise<Multi<History>>

Returns the history data for the requested array of item IDs and world.

@JvmOverloads
fun getMarketBoardSaleHistoryAsync(dcName: DataCenter, itemId: Int, entriesToReturn: Int? = null, statsWithin: Int? = null, entriesWithin: Int? = null): CompletableFuture<History>
@JvmOverloads
fun getMarketBoardSaleHistoryAsync(dcName: DataCenter, itemIds: List<Int>, entriesToReturn: Int? = null, statsWithin: Int? = null, entriesWithin: Int? = null): CompletableFuture<History>

Returns the history data for the requested list of item IDs and data center.

@JvmOverloads
fun getMarketBoardSaleHistoryAsync(region: Region, itemId: Int, entriesToReturn: Int? = null, statsWithin: Int? = null, entriesWithin: Int? = null): CompletableFuture<History>
@JvmOverloads
fun getMarketBoardSaleHistoryAsync(region: Region, itemIds: List<Int>, entriesToReturn: Int? = null, statsWithin: Int? = null, entriesWithin: Int? = null): CompletableFuture<History>

Returns the history data for the requested list of item IDs and region.

@JvmOverloads
fun getMarketBoardSaleHistoryAsync(world: World, itemId: Int, entriesToReturn: Int? = null, statsWithin: Int? = null, entriesWithin: Int? = null): CompletableFuture<History>
@JvmOverloads
fun getMarketBoardSaleHistoryAsync(world: World, itemIds: List<Int>, entriesToReturn: Int? = null, statsWithin: Int? = null, entriesWithin: Int? = null): CompletableFuture<History>

Returns the history data for the requested list of item IDs and world.

Link copied to clipboard
suspend fun getMarketTaxRates(world: World): TaxRates

Returns the current tax rate data for the specified world.

getMarketTaxRatesAsync
Link copied to clipboard
fun getMarketTaxRatesAsync(world: World): Promise<TaxRates>

Returns the current tax rate data for the specified world.

fun getMarketTaxRatesAsync(world: World): CompletableFuture<TaxRates>

Returns the current tax rate data for the specified world.

Link copied to clipboard
suspend fun getMostRecentlyUpdatedItems(dcName: DataCenter, entries: Short? = null): RecentlyUpdatedItems

Returns the most-recently updated items on the specified data center, along with the upload times for each item.

suspend fun getMostRecentlyUpdatedItems(world: World, entries: Short? = null): RecentlyUpdatedItems

Returns the most-recently updated items on the specified world, along with the upload times for each item.

getMostRecentlyUpdatedItemsAsync
Link copied to clipboard
fun getMostRecentlyUpdatedItemsAsync(dcName: DataCenter, entries: Short? = null): Promise<RecentlyUpdatedItems>

Returns the most-recently updated items on the specified data center, along with the upload times for each item.

fun getMostRecentlyUpdatedItemsAsync(world: World, entries: Short? = null): Promise<RecentlyUpdatedItems>

Returns the most-recently updated items on the specified world, along with the upload times for each item.

@JvmOverloads
fun getMostRecentlyUpdatedItemsAsync(dcName: DataCenter, entries: Short? = null): CompletableFuture<RecentlyUpdatedItems>

Returns the most-recently updated items on the specified data center, along with the upload times for each item.

@JvmOverloads
fun getMostRecentlyUpdatedItemsAsync(world: World, entries: Short? = null): CompletableFuture<RecentlyUpdatedItems>

Returns the most-recently updated items on the specified world, along with the upload times for each item.

Link copied to clipboard
suspend fun getUploadCountsByUploadApplication(): List<SourceUploadCount>

Returns the total upload counts for each client application that uploads data to Universalis.

getUploadCountsByUploadApplicationAsync
Link copied to clipboard
fun getUploadCountsByUploadApplicationAsync(): Promise<Array<SourceUploadCount>>

Returns the total upload counts for each client application that uploads data to Universalis.

fun getUploadCountsByUploadApplicationAsync(): CompletableFuture<List<SourceUploadCount>>

Returns the total upload counts for each client application that uploads data to Universalis.

Link copied to clipboard
suspend fun getUploadCountsByWorld(): Map<World, WorldUploadCount>

Returns the world upload counts and proportions of the total uploads for each world.

getUploadCountsByWorldAsync
Link copied to clipboard
fun getUploadCountsByWorldAsync(): Promise<dynamic>

Returns the world upload counts and proportions of the total uploads for each world.

fun getUploadCountsByWorldAsync(): CompletableFuture<Map<World, WorldUploadCount>>

Returns the world upload counts and proportions of the total uploads for each world.

Link copied to clipboard
suspend fun getUploadsPerDay(): UploadCountHistory

Returns the number of uploads per day over the past 30 days.

getUploadsPerDayAsync
Link copied to clipboard
fun getUploadsPerDayAsync(): Promise<UploadCountHistory>

Returns the number of uploads per day over the past 30 days.

fun getUploadsPerDayAsync(): CompletableFuture<UploadCountHistory>

Returns the number of uploads per day over the past 30 days.