ZEPETO.Multiplay.Inventory

11 분

형식	설명
InventoryError	인벤토리 관련 요청이 실패한 원인을 나타내는 오류 코드입니다.
InventoryRecord	인벤토리 상품 정보입니다.
Inventory	Inventory는 플레이어의 World 내 상품 인벤토리와 관련된 작업을 관리합니다.

InventoryError

enum

인벤토리 관련 요청이 실패한 원인을 나타내는 오류 코드입니다.

이름	값	설명
Unknown	-1	오류: 알 수 없는 오류입니다.
NetworkError	0	오류: 연결 끊김이나 불안정한 연결 등 네트워크 문제와 관련된 오류입니다.

InventoryRecord

interface

인벤토리 상품 정보입니다.

속성

이름	형식	설명
productId	string	상품 ID입니다.
quantity	number	상품의 수량입니다.
createdAt	Date	상품이 인벤토리에 추가된 날짜와 시간입니다.
updatedAt	Date	상품 정보가 마지막으로 갱신된 날짜와 시간입니다.

Inventory

interface

Inventory는 플레이어의 World 내 상품 인벤토리와 관련된 작업을 관리합니다.

메서드

use

use(productId: string, quantity?: number, reason?: string) → Promise<boolean>

플레이어의 인벤토리에서 World 내 상품을 사용합니다. InventoryError를 발생시킵니다.

매개변수	형식	설명
productId	string	사용할 상품의 ID입니다.
quantity (선택 사항)	number	사용할 상품의 수량입니다. 기본값은 1입니다.
reason (선택 사항)	string	사용 사유를 선택적으로 기술합니다.

반환값: Promise<boolean> — 작업 완료 시 이행되는 Promise이며, 성공(true) 또는 실패(false)를 나타냅니다.

add

add(productId: string, quantity?: number, reason?: string) → Promise<boolean>

플레이어의 인벤토리에 World 내 상품을 추가합니다. InventoryError를 발생시킵니다.

매개변수	형식	설명
productId	string	추가할 상품의 ID입니다.
quantity (선택 사항)	number	추가할 상품의 수량입니다. 기본값은 1입니다.
reason (선택 사항)	string	추가 사유를 선택적으로 기술합니다.

반환값: Promise<boolean> — 작업 완료 시 이행되는 Promise이며, 성공(true) 또는 실패(false)를 나타냅니다.

madd

madd(products: { productId: string; quantity: number; reason?: string }[]) → Promise<boolean>

플레이어의 인벤토리에 여러 World 내 상품을 추가합니다. InventoryError를 발생시킵니다.

매개변수	형식	설명
products	{ productId: string; quantity: number; reason?: string }[]	추가할 상품의 배열입니다.

반환값: Promise<boolean> — 작업 완료 시 이행되는 Promise이며, 성공(true) 또는 실패(false)를 나타냅니다.

has

has(productId: string) → Promise<boolean>

플레이어의 인벤토리에 World 내 상품이 있는지 확인합니다. InventoryError를 발생시킵니다.

매개변수	형식	설명
productId	string	확인할 상품의 ID입니다.

반환값: Promise<boolean> — 작업 완료 시 이행되는 Promise이며, 존재(true) 또는 미존재(false)를 나타냅니다.

get

get(productId: string) → Promise<InventoryRecord | null>

플레이어의 인벤토리에서 World 내 상품을 가져옵니다. InventoryError를 발생시킵니다.

매개변수	형식	설명
productId	string	가져올 상품의 ID입니다.

반환값: Promise<InventoryRecord | null> — 작업 완료 시 가져온 InventoryRecord 객체와 함께 이행되는 Promise입니다.

remove

remove(productId: string) → Promise<boolean>

플레이어의 인벤토리에서 World 내 상품을 삭제합니다. InventoryError를 발생시킵니다.

매개변수	형식	설명
productId	string	삭제할 상품의 ID입니다.

반환값: Promise<boolean> — 작업 완료 시 이행되는 Promise이며, 성공(true) 또는 실패(false)를 나타냅니다.

list

list() → Promise<InventoryRecord[]>

플레이어의 인벤토리에서 모든 World 내 상품을 가져옵니다. InventoryError를 발생시킵니다.

반환값: Promise<InventoryRecord[]> — 작업 완료 시 가져온 InventoryRecord 객체의 배열과 함께 이행되는 Promise입니다.