ShopService
ZEPETO.Module.Shop.ShopService
ShopService enables operations connected to the ZEPETO shop within the World.
This service lets players access shop information, such as thumbnail images of owned or wish-listed items, and send gifts to other players.
Hierarchy
↳
ShopService
Constructors
constructor
• new ShopService()
Inherited from
System.Object.constructor
Methods
DownloadItemThumbnail
▸ Static DownloadItemThumbnail($itemCode): BaseRequest$1<TextureResponse>
This asynchronous method retrieves the thumbnail of an item.
Parameters
| Name | Type | Description |
|---|---|---|
$itemCode | string | Item Code |
Returns
BaseRequest$1<TextureResponse>
A BaseRequest object. When the asynchronous process is complete, you can access the TextureResponse object by the responseData property.
GetContentItemAsync
▸ Static GetContentItemAsync($itemId): BaseRequest$1<ContentItemResponse>
This asynchronous method retrieves the item information.
Parameters
| Name | Type | Description |
|---|---|---|
$itemId | string | Item Code. |
Returns
BaseRequest$1<ContentItemResponse>
A BaseRequest object. When the asynchronous process is complete, you can access the ContentItemResponse object by the responseData property.
GetMyCategoryAsync
▸ Static GetMyCategoryAsync(): BaseRequest$1<CategoryResponse>
This method retrieves the item category information from the ZEPETO shop inventory of the local player's user account.
Returns
BaseRequest$1<CategoryResponse>
A BaseRequest object. When the asynchronous process is complete, you can access the CategoryResponse object by the responseData property.
GetMyContentItemListAsync
▸ Static GetMyContentItemListAsync($itemKeyword, $pageToken?): BaseRequest$1<ContentItemListResponse>
This asynchronous method retrieves the item list for each item category.
Parameters
| Name | Type | Description |
|---|---|---|
$itemKeyword | ItemKeyword | Item category. |
$pageToken? | string | Optional Page token. When calling this method for the first time, set this parameter to null. |
Returns
BaseRequest$1<ContentItemListResponse>
A BaseRequest object. When the asynchronous process is complete, you can access the ContentItemListResponse object by the responseData property.
GetMyWishContentItemListAsync
▸ Static GetMyWishContentItemListAsync(): BaseRequest$1<ContentItemListResponse>
This asynchronous method retrieves the item list from the ZEPETO shop wish list of the local player's user account.
Returns
BaseRequest$1<ContentItemListResponse>
A BaseRequest object. When the asynchronous process is complete, you can access the ContentItemListResponse object by the responseData property.
ShowGiftPopup
▸ Static ShowGiftPopup($itemCode, $targetUserId, $backgroundType, $giftMessage?, $onComplete?, $onFailure?): void
This method opens a gifting popup.
Parameters
| Name | Type | Description |
|---|---|---|
$itemCode | string | Item code. |
$targetUserId | string | User ID of the gift recipient. Please note that this is not a ZEPETO ID. |
$backgroundType | GiftBackgroundType | Background type to be used for gift notification popup. |
$giftMessage? | string | Optional Message to be sent along with the gift. An empty string is allowed. |
$onComplete? | Action$1<ItemGiftResponse> | Optional Callback function to handle the ItemGiftResponse upon completion of gifting. |
$onFailure? | Action$1<ErrorCode> | Optional Callback function for error handling. |
Returns
void