ZEPETO.Multiplay.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 ที่ resolve เมื่อดำเนินการเสร็จสิ้น โดยระบุความสำเร็จ (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 ที่ resolve เมื่อดำเนินการเสร็จสิ้น โดยระบุความสำเร็จ (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 ที่ resolve เมื่อดำเนินการเสร็จสิ้น โดยระบุความสำเร็จ (true) หรือความล้มเหลว (false)
has
has(productId: string) → Promise<boolean>
ตรวจสอบว่ามีสินค้าภายใน World อยู่ในอินเวนทอรีของผู้เล่นหรือไม่ โดยจะโยน InventoryError
พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
productId | string | ID ของสินค้าที่จะตรวจสอบ |
ค่าที่คืนกลับ: Promise<boolean> — Promise ที่ resolve เมื่อดำเนินการเสร็จสิ้น โดยระบุว่ามีอยู่ (true) หรือไม่มีอยู่ (false)
get
get(productId: string) → Promise<InventoryRecord | null>
ดึงสินค้าภายใน World จากอินเวนทอรีของผู้เล่น โดยจะโยน InventoryError
พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
productId | string | ID ของสินค้าที่จะดึง |
ค่าที่คืนกลับ: Promise<InventoryRecord | null> — Promise ที่ resolve เมื่อดำเนินการเสร็จสิ้น พร้อมอ็อบเจกต์ InventoryRecord ที่ดึงมา
remove
remove(productId: string) → Promise<boolean>
ลบสินค้าภายใน World ออกจากอินเวนทอรีของผู้เล่น โดยจะโยน InventoryError
พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
productId | string | ID ของสินค้าที่จะลบ |
ค่าที่คืนกลับ: Promise<boolean> — Promise ที่ resolve เมื่อดำเนินการเสร็จสิ้น โดยระบุความสำเร็จ (true) หรือความล้มเหลว (false)
list
list() → Promise<InventoryRecord[]>
ดึงสินค้าภายใน World ทั้งหมดจากอินเวนทอรีของผู้เล่น โดยจะโยน InventoryError
ค่าที่คืนกลับ: Promise<InventoryRecord[]> — Promise ที่ resolve เมื่อดำเนินการเสร็จสิ้น พร้อมอาร์เรย์ของอ็อบเจกต์ InventoryRecord ที่ดึงมา