Xsolla Store SDK for Android/com.xsolla.android.store/XStore/Companion

Companion

object Companion

Functions

clearCartById

@JvmStatic

fun clearCartById(callback: ClearCartByIdCallback, cartId: String)

Removes all items from the cart with the specified ID.

clearCurrentCart

@JvmStatic

fun clearCurrentCart(callback: ClearCurrentCartCallback)

Updates the quantity of a previously added item in the cart with the specified ID. If there is no item with the specified SKU in the cart, it will be added.

createOrderByItemSku

@JvmStatic

@JvmOverloads

fun createOrderByItemSku( callback: CreateOrderCallback, itemSku: String, options: PaymentOptions? = PaymentOptions(), quantity: Long = 1, externalTransactionToken: String? = null)

Create an order with a specified item

createOrderByVirtualCurrency

@JvmStatic

@JvmOverloads

fun createOrderByVirtualCurrency( callback: CreateOrderByVirtualCurrencyCallback, itemSku: String, virtualCurrencySku: String, customParameters: JSONObject? = null)

Creates an order with a specified item. The created order will get a new order status.

createOrderFromCartById

@JvmStatic

@JvmOverloads

fun createOrderFromCartById( callback: CreateOrderCallback, cartId: String, options: PaymentOptions? = PaymentOptions(), externalTransactionToken: String? = null)

Creates an order with items from the cart with the specified ID. Returns the payment token and order ID.

createOrderFromCurrentCart

@JvmStatic

@JvmOverloads

fun createOrderFromCurrentCart( callback: CreateOrderCallback, options: PaymentOptions? = PaymentOptions(), externalTransactionToken: String? = null)

Creates an order with items from the cart of the current user. Returns the payment token and order ID.

createOrderWithFreeCart

@JvmStatic

@JvmOverloads

fun createOrderWithFreeCart(callback: CreateFreeOrderCallback, cartId: String? = null)

Create order with free cart

createOrderWithSpecifiedFreeItem

@JvmStatic

@JvmOverloads

fun createOrderWithSpecifiedFreeItem( callback: CreateFreeOrderCallback, itemSku: String, quantity: Long = 1)

Create an order with a specified free item

createPaymentToken

@JvmStatic

@JvmOverloads

fun createPaymentToken( callback: CreatePaymentTokenCallback, purchase: PurchaseObject, settings: PaymentTokenBodySettings? = null, customParameters: JSONObject? = null)

Creates a new payment token.

deleteItemFromCartByCartId

@JvmStatic

fun deleteItemFromCartByCartId( callback: DeleteItemFromCartByIdCallback, cartId: String, itemSku: String)

Removes the item from the cart with the specified ID.

deleteItemFromCurrentCart

@JvmStatic

fun deleteItemFromCurrentCart(callback: DeleteItemFromCurrentCartCallback, itemSku: String)

Removes the item from the current user cart.

fillCartByIdWithItems

@JvmStatic

fun fillCartByIdWithItems( callback: FillSpecificCartWithItemsCallback, cartId: String, items: List<FillCartItem>)

Fills the current user cart with items. If there is already an item with the same SKU in the cart, the existing item position will be replaced by the passed value.

fillCurrentCartWithItems

@JvmStatic

fun fillCurrentCartWithItems(callback: FillCartWithItemsCallback, items: List<FillCartItem>)

Fills the cart with the specified ID with items. If there is already an item with the same SKU in the cart, the existing item position will be replaced by the passed value.

getBundle

@JvmStatic

fun getBundle(callback: GetBundleCallback, bundleSku: String)

Returns information about the contents of the specified bundle. In the bundle settings, display in the store must be enabled.

getBundleList

@JvmStatic

@JvmOverloads

fun getBundleList( callback: GetBundleListCallback, limit: Int = 50, offset: Int = 0, locale: String? = null, additionalFields: List<String>? = emptyList(), country: String? = null)

Returns a list of bundles according to pagination settings. The list includes bundles for which display in the store is enabled in the settings.

getCartById

@JvmStatic

@JvmOverloads

fun getCartById( callback: GetCartByIdCallback, cartId: String, currency: String? = null, locale: String? = null)

Returns a list of items from the cart with the specified ID. For each item, complete data is returned.

getCouponRewardsByCode

@JvmStatic

fun getCouponRewardsByCode(callback: GetCouponRewardsByCodeCallback, couponCode: String)

Returns a list of items that can be credited to the user when the coupon is redeemed. Can be used to let users choose one of many items as a bonus. The usual case is choosing a DRM if the coupon contains a game as a bonus. The usual case is choosing a DRM if the coupon contains a game as a bonus (type=unit).

getCurrentCart

@JvmStatic

@JvmOverloads

fun getCurrentCart( callback: GetCurrentUserCartCallback, currency: String? = null, locale: String? = null)

Returns a list of items from the cart of the current user. For each item, complete data is returned.

getDrmList

@JvmStatic

fun getDrmList(callback: GetDrmListCallback)

Gets the list of available DRMs.

getGameForCatalog

@JvmStatic

fun getGameForCatalog( callback: GetGameForCatalogCallback, itemSku: String, locale: String? = null, additionalFields: List<String>? = null, country: String? = null)

Gets a game for the catalog.

getGameKeyForCatalog

@JvmStatic

fun getGameKeyForCatalog( callback: GetGameKeyForCatalogCallback, itemSku: String, locale: String? = null, additionalFields: List<String>? = null, country: String? = null)

Gets a game key for the catalog.

getGameKeysListByGroup

@JvmStatic

fun getGameKeysListByGroup( callback: GetGameKeysListByGroupCallback, externalId: String, limit: Int = 50, offset: Int = 0, locale: String? = null, additionalFields: List<String>? = null, country: String? = null)

Gets a game key list from the specified group for building a catalog.

getGamesList

@JvmStatic

fun getGamesList( callback: GetGamesListCallback, limit: Int = 50, offset: Int = 0, locale: String? = null, additionalFields: List<String>? = null, country: String? = null)

Gets a games list for building a catalog.

getGamesListByGroup

@JvmStatic

fun getGamesListByGroup( callback: GetGamesListByGroupCallback, externalId: String, limit: Int = 50, offset: Int = 0, locale: String? = null, additionalFields: List<String>? = null, country: String? = null)

Gets a games list from the specified group for building a catalog.

getItemsBySpecifiedGroup

@JvmStatic

@JvmOverloads

fun getItemsBySpecifiedGroup( callback: GetVirtualItemsByGroupCallback, externalId: String = "all", limit: Int = 50, offset: Int = 0, locale: String? = null, additionalFields: List<String> = listOf(), country: String? = null)

Returns a list of items for the specified group according to pagination settings. The list includes items for which display in the store is enabled in the settings. In the settings of the group, the display in the store must be enabled.

getItemsGroups

@JvmStatic

fun getItemsGroups(callback: GetItemsGroupsCallback)

Returns a full list of virtual item groups. The list includes groups for which display in the store is enabled in the settings.

getListOfOwnedGames

@JvmStatic

fun getListOfOwnedGames( callback: GetListOfOwnedGamesCallback, limit: Int = 50, offset: Int = 0, isSandbox: Int = 1, additionalFields: List<String>? = null)

Get the list of games owned by the user. The response will contain an array of games owned by a particular user.

getOrder

@JvmStatic

fun getOrder(callback: GetOrderCallback, orderId: String)

Get a specified order

getOrderStatus

@JvmStatic

fun getOrderStatus(listener: OrderStatusListener, orderId: String)

Subscribes to order status updates.

getPromocodeRewardsByCode

fun getPromocodeRewardsByCode(callback: GetPromocodeRewardByCodeCallback, promocode: String)

Returns a list of items that can be credited to the user when the promo code is activated. Allows users to choose from several available items. The usual case is choosing a DRM if the promo code contains a game as a bonus (type=unit).

getVirtualCurrency

@JvmStatic

@JvmOverloads

fun getVirtualCurrency( callback: GetVirtualCurrencyCallback, limit: Int = 50, offset: Int = 0, locale: String? = null, additionalFields: List<String> = listOf(), country: String? = null)

Returns a list of virtual currencies according to pagination settings.

getVirtualCurrencyPackage

@JvmStatic

@JvmOverloads

fun getVirtualCurrencyPackage( callback: GetVirtualCurrencyPackageCallback, limit: Int = 50, offset: Int = 0, locale: String? = null, additionalFields: List<String>? = listOf(), country: String? = null)

Returns a list of virtual currency packages according to pagination settings. The list includes packages for which display in the store is enabled in the settings.

getVirtualItems

@JvmStatic

@JvmOverloads

fun getVirtualItems( callback: GetVirtualItemsCallback, limit: Int = 50, offset: Int = 0, locale: String? = null, additionalFields: List<String>? = listOf(), country: String? = null, requestGeoLocale: Boolean? = null)

Returns a list of virtual items according to pagination settings. The list includes items for which display in the store is enabled in the settings. For each virtual item, complete data is returned.

getVirtualItemsShort

@JvmStatic

@JvmOverloads

fun getVirtualItemsShort(callback: GetVirtualItemsShortCallback, locale: String? = null)

Returns a full list of virtual items. The list includes items for which display in the store is enabled in the settings. For each virtual item, the SKU, name, description, and data about the groups it belongs to are returned.

init

@JvmStatic

@JvmOverloads

fun init(projectId: Int, token: String? = null)

Initialize SDK

redeemCoupon

@JvmStatic

@JvmOverloads

fun redeemCoupon( callback: RedeemCouponCallback, couponCode: String, selectedUnitItems: Pair<String, String>? = null)

Redeems the coupon code and delivers a reward to the user in one of the following ways:

redeemGameCode

@JvmStatic

fun redeemGameCode( callback: RedeemGameCodeCallback, code: String, isSandbox: Boolean)

Grants entitlement by a provided game code.

redeemPromocode

@JvmStatic

@JvmOverloads

fun redeemPromocode( callback: RedeemPromocodeCallback, promocode: String, selectedUnitItems: Pair<String, String>? = null, cartId: String = "current")

Redeems a promo code. After activating the promo code, the user gets free items and/or the price of the cart is reduced.

removePromocode

@JvmStatic

@JvmOverloads

fun removePromocode(callback: RemovePromocodeCallback, cartId: String = "current")

Removes a promo code from a cart. After the promo code is removed, the total price of all items in the cart will be recalculated without bonuses and discounts provided by a promo code.

setAuthToken

@JvmStatic

fun setAuthToken(token: String)

Set authentication token

updateItemFromCartByCartId

@JvmStatic

fun updateItemFromCartByCartId( callback: UpdateItemFromCartByCartIdCallback, cartId: String, itemSku: String, quantity: Long)

Updates the quantity of a previously added item in the cart with the specified ID. If there is no item with the specified SKU in the cart, it will be added.

updateItemFromCurrentCart

@JvmStatic

fun updateItemFromCurrentCart( callback: UpdateItemFromCurrentCartCallback, itemSku: String, quantity: Long)

Updates the quantity of a previously added item in the current user cart. If there is no item with the specified SKU in the cart, it will be added.

Sources

Store SDK source

Contents