GiftStore provides a complete set of gift management APIs, including sending gifts, refreshing gift lists, setting language, and listening to gift events. Through this class, gift interaction features can be implemented in live rooms.GiftStore instance, passing a valid live room ID.Property | Type | Description |
usableGifts | All gift categories and gift lists available in the current room. |
Function | Description |
Create gift management instance. | |
Gift event callbacks. | |
Gift event callbacks. | |
Send gift. | |
Refresh available gift list. | |
Set display language. |
abstract fun sendGift(giftID: String,count: Int,completion: CompletionHandler?)
Parameter | Type | Description |
giftID | String | Unique identifier ID of the gift to send. |
count | Int | Number of gifts to send at once. |
completion | Completion callback (success/failure status). |
abstract fun refreshUsableGifts(completion: CompletionHandler?)
Parameter | Type | Description |
completion | Completion callback (on success, the latest gift list can be obtained through state; on failure, error information is returned). |
abstract fun setLanguage(language: String)
Parameter | Type | Description |
language | String | Language code ("zh-CN" for Chinese, "en" for English). After setting, gift names, descriptions, etc. will be updated to the corresponding language when the display interface is refreshed. |
Property | Type | Description |
giftID | String | Gift ID. |
name | String | Gift name. |
desc | String | Gift description. |
iconURL | String | Network URL of the gift icon image, used to load gift thumbnails. |
resourceURL | String | Network URL of the gift animation resource file, used to load gift display animations. |
level | Long | Gift level, used to distinguish gift rarity or value tier. |
coins | Long | Gift price (coins). |
extensionInfo | Map<String, String> | Gift extension information, customizable fields (such as effect type, sending restrictions, etc.). |
Property | Type | Description |
categoryID | String | Category unique identifier ID, used to distinguish different gift categories. |
name | String | Category display name, used for UI category display (such as "Popular Gifts", "Premium Gifts"). |
desc | String | Category description information, used to explain the characteristics of this category. |
extensionInfo | Map<String, String> | Category extension information, containing custom fields (such as sorting weight, display style, etc.). |
giftList | All gifts under the current category. |
Property | Type | Description |
usableGifts | All gift categories and gift lists available in the current room. |
open fun onReceiveGift(liveID: String, gift: Gift, count: Int, sender: LiveUserInfo) {}
Parameter | Type | Description |
liveID | String | Live room ID. |
gift | Gift information. | |
count | Int | Gift count. |
sender | Gift sender information. |
フィードバック