ktuniversalis/cloud.drakon.ktuniversalis/KtUniversalis

KtUniversalis

expect object KtUniversalis

actual object KtUniversalis

Functions

getAvailableDataCenters

expect suspend fun getAvailableDataCenters(): List<DataCenter>

Returns all data centers supported by the Universalis API.

actual suspend fun getAvailableDataCenters(): List<DataCenter>

Returns all data centers supported by the Universalis API.

actual suspend fun getAvailableDataCenters(): List<DataCenter>

Returns all data centers supported by the Universalis API.

getAvailableDataCentersAsync

fun getAvailableDataCentersAsync(): Promise<Array<DataCenter>>

Returns all data centers supported by the Universalis API.

@JvmStatic

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

Returns all data centers supported by the Universalis API. For use outside of Kotlin coroutines.

getAvailableWorlds

expect suspend fun getAvailableWorlds(): List<World>

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

actual suspend fun getAvailableWorlds(): List<World>

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

actual suspend fun getAvailableWorlds(): List<World>

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

getAvailableWorldsAsync

fun getAvailableWorldsAsync(): Promise<Array<World>>

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

@JvmStatic

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

Returns the IDs and names of all worlds supported by the Universalis API. For use outside of Kotlin coroutines.

getLeastRecentlyUpdatedItems

expect suspend fun getLeastRecentlyUpdatedItems(world: String? = null, dcName: String? = null, entries: Int? = null): RecentlyUpdatedItems

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

actual suspend fun getLeastRecentlyUpdatedItems(world: String?, dcName: String?, entries: Int?): RecentlyUpdatedItems

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

actual suspend fun getLeastRecentlyUpdatedItems(world: String?, dcName: String?, entries: Int?): RecentlyUpdatedItems

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

getLeastRecentlyUpdatedItemsAsync

fun getLeastRecentlyUpdatedItemsAsync(world: String? = null, dcName: String? = null, entries: Int? = null): Promise<RecentlyUpdatedItems>

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

@JvmStatic

fun getLeastRecentlyUpdatedItemsAsync(world: String? = null, dcName: String? = null, entries: Int? = null): CompletableFuture<RecentlyUpdatedItems>

Returns the least-recently updated items on the specified world or data center, along with the upload times for each item. For use outside of Kotlin coroutines.

getMarketableItems

expect suspend fun getMarketableItems(): List<Int>

Returns a list of marketable item IDs.

actual suspend fun getMarketableItems(): List<Int>

Returns a list of marketable item IDs.

actual suspend fun getMarketableItems(): List<Int>

Returns a list of marketable item IDs.

getMarketableItemsAsync

fun getMarketableItemsAsync(): Promise<IntArray>

Returns an array of marketable item IDs.

@JvmStatic

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

Returns a list of marketable item IDs. For use outside of Kotlin coroutines.

getMarketBoardCurrentData

expect suspend fun getMarketBoardCurrentData(worldDcRegion: String, itemIds: List<Int>, listings: Int? = null, entries: Int? = null, noGst: Boolean? = null, hq: Boolean? = null, statsWithin: Int? = null, entriesWithin: Int? = null, fields: List<String>? = null): CurrentlyShown

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

actual suspend fun getMarketBoardCurrentData(worldDcRegion: String, itemIds: List<Int>, listings: Int?, entries: Int?, noGst: Boolean?, hq: Boolean?, statsWithin: Int?, entriesWithin: Int?, fields: List<String>?): CurrentlyShown

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

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

getMarketBoardCurrentDataAsync

fun getMarketBoardCurrentDataAsync(worldDcRegion: String, itemIds: IntArray, listings: Int? = null, entries: Int? = null, noGst: Boolean? = null, hq: Boolean? = null, statsWithin: Int? = null, entriesWithin: Int? = null, fields: Array<String>? = null): Promise<CurrentlyShown>

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

@JvmStatic

fun getMarketBoardCurrentDataAsync(worldDcRegion: String, itemIds: List<Int>, listings: Int? = null, entries: Int? = null, noGst: Boolean? = null, hq: Boolean? = null, statsWithin: Int? = null, entriesWithin: Int? = null, fields: List<String>? = null): CompletableFuture<CurrentlyShown>

Returns the data currently shown on the market board for the requested array of item IDs and world or data center. For use outside of Kotlin coroutines.

getMarketBoardSaleHistory

expect suspend fun getMarketBoardSaleHistory(worldDcRegion: String, itemIds: List<Int>, entriesToReturn: Int? = null, statsWithin: Int? = null, entriesWithin: Int? = null): History

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

actual suspend fun getMarketBoardSaleHistory(worldDcRegion: String, itemIds: List<Int>, entriesToReturn: Int?, statsWithin: Int?, entriesWithin: Int?): History

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

actual suspend fun getMarketBoardSaleHistory(worldDcRegion: String, itemIds: List<Int>, entriesToReturn: Int?, statsWithin: Int?, entriesWithin: Int?): History

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

getMarketBoardSaleHistoryAsync

fun getMarketBoardSaleHistoryAsync(worldDcRegion: String, itemIds: IntArray, entriesToReturn: Int? = null, statsWithin: Int? = null, entriesWithin: Int? = null): Promise<History>

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

@JvmStatic

fun getMarketBoardSaleHistoryAsync(worldDcRegion: String, itemIds: List<Int>, entriesToReturn: Int? = null, statsWithin: Int? = null, entriesWithin: Int? = null): CompletableFuture<History>

Returns the history data for the requested array of item IDs and world or data center. For use outside of Kotlin coroutines.

getMarketTaxRates

expect suspend fun getMarketTaxRates(world: String): TaxRates

Returns the current tax rate data for the specified world.

actual suspend fun getMarketTaxRates(world: String): TaxRates

Returns the current tax rate data for the specified world.

actual suspend fun getMarketTaxRates(world: String): TaxRates

Returns the current tax rate data for the specified world.

getMarketTaxRatesAsync

fun getMarketTaxRatesAsync(world: String): Promise<TaxRates>

Returns the current tax rate data for the specified world.

@JvmStatic

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

Returns the current tax rate data for the specified world. For use outside of Kotlin coroutines.

getMostRecentlyUpdatedItems

expect suspend fun getMostRecentlyUpdatedItems(world: String? = null, dcName: String? = null, entries: Int? = null): RecentlyUpdatedItems

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

actual suspend fun getMostRecentlyUpdatedItems(world: String?, dcName: String?, entries: Int?): RecentlyUpdatedItems

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

actual suspend fun getMostRecentlyUpdatedItems(world: String?, dcName: String?, entries: Int?): RecentlyUpdatedItems

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

getMostRecentlyUpdatedItemsAsync

fun getMostRecentlyUpdatedItemsAsync(world: String? = null, dcName: String? = null, entries: Int? = null): Promise<RecentlyUpdatedItems>

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

@JvmStatic

fun getMostRecentlyUpdatedItemsAsync(world: String? = null, dcName: String? = null, entries: Int? = null): CompletableFuture<RecentlyUpdatedItems>

Returns the most-recently updated items on the specified world or data center, along with the upload times for each item. For use outside of Kotlin coroutines.

getUploadCountsByUploadApplication

expect suspend fun getUploadCountsByUploadApplication(): List<SourceUploadCount>

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

actual suspend fun getUploadCountsByUploadApplication(): List<SourceUploadCount>

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

actual suspend fun getUploadCountsByUploadApplication(): List<SourceUploadCount>

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

getUploadCountsByUploadApplicationAsync

fun getUploadCountsByUploadApplicationAsync(): Promise<Array<SourceUploadCount>>

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

@JvmStatic

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

Returns the total upload counts for each client application that uploads data to Universalis. For use outside of Kotlin coroutines.

getUploadCountsByWorld

expect suspend fun getUploadCountsByWorld(): Map<String, WorldUploadCount>

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

actual suspend fun getUploadCountsByWorld(): Map<String, WorldUploadCount>

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

actual suspend fun getUploadCountsByWorld(): Map<String, WorldUploadCount>

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

getUploadCountsByWorldAsync

fun getUploadCountsByWorldAsync(): Promise<Map<String, WorldUploadCount>>

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

@JvmStatic

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

Returns the world upload counts and proportions of the total uploads for each world. For use outside of Kotlin coroutines.

getUploadsPerDay

expect suspend fun getUploadsPerDay(): UploadCountHistory

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

actual suspend fun getUploadsPerDay(): UploadCountHistory

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

actual suspend fun getUploadsPerDay(): UploadCountHistory

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

getUploadsPerDayAsync

fun getUploadsPerDayAsync(): Promise<UploadCountHistory>

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

@JvmStatic

fun getUploadsPerDayAsync(): CompletableFuture<UploadCountHistory>

Returns the number of uploads per day over the past 30 days. For use outside of Kotlin coroutines.