init(options)
واپسی Promise<SpreeAISDK | null>. کامیابی پر، اعتراض بے نقاب renderTryOnButton(options): Promise<void>. رینڈرنگ سے پہلے null کی جانچ کریں۔
| آپشن | قسم | طے شدہ | مقصد |
|---|---|---|---|
clientId | string | درکار ہے۔ | جاری کردہ براؤزر کلائنٹ شناخت کنندہ۔ |
baseApiURL | string | https://api.spreeai.com | منظور شدہ API اصل۔ صرف جاری کردہ ماحول کے لیے تبدیل کریں۔ |
baseURL | string | https://vton.spreeai.com | منظور شدہ ہوسٹڈ فٹنگ روم کی اصل۔ |
partnerId v3 میں init آپشن نہیں ہے۔ پارٹنر کو تصدیق شدہ کلائنٹ سے حل کیا جاتا ہے۔ کوئی اسٹینڈ لون سائز رینڈر کا طریقہ واپس نہیں کیا گیا ہے۔
renderTryOnButton(options)
| آپشن | قسم | پہلے سے طے شدہ / ضرورت | مقصد |
|---|---|---|---|
elementId | string | درکار ہے۔ | موجودہ میزبان عنصر کی ID۔ |
garments | GarmentInput[] | مطلوبہ انتخاب | تجویز کردہ لباس ان پٹ۔ غیر خالی صف کا استعمال کریں۔ |
garmentId | string | فرسودہ متبادل | میراثی سنگل گارمنٹ ان پٹ۔ لباس کو ترجیح دیں۔ |
variant | VariantOptions | فرسودہ | garmentId کے ساتھ میراثی فلٹر؛ فی آئٹم مختلف قسم کو ترجیح دیں۔ |
className | string | اختیاری | اضافی بٹن کلاس۔ |
button | { text?: string } | اختیاری | بٹن لیبل؛ features.tryOnButton.text کے ذریعے اوور رائیڈ کیا گیا۔ |
features | TryOnFeatures | اختیاری | بٹن اسٹائل کنفیگریشن۔ |
events | TryOnButtonEvents | اختیاری | کلک کریں اور کارٹ ہینڈلرز کو شامل کریں۔ |
enableAddToCart | boolean | false | کارٹ میں شامل کرنے کی فعالیت دکھائیں۔ ہینڈلر کو نافذ کریں۔ |
enableSizingRecommendation | boolean | false | ٹرائی آن کے اندر سائز سازی کی سفارشات کی درخواست کریں۔ |
showSizes | boolean | false | فراہم کردہ availableSizes دکھائیں۔ |
showPrices | boolean | false | فراہم کردہ قیمت دکھائیں۔ |
defaultUnits | "metric" | "imperial" | اختیاری | پروفائل کی پیمائش کے لیے یونٹ کا نظام شروع کرنا۔ |
GarmentInput
| میدان | قسم | مقصد |
|---|---|---|
garmentId | string | SPREEAI لباس کا شناخت کنندہ درکار ہے۔ |
variant | VariantOptions | اختیاری رنگ، فٹ، جنس یا سٹائل فلٹر۔ |
availableSizes | string[] | اختیاری موجودہ ڈسپلے سائز لیبلز۔ |
price | string | اختیاری ڈسپلے قیمت، جیسا کہ سپلائی کیا گیا ہے۔ |
توثیق اور فال بیک
ایک ہی لباس کے لیے، رینڈرنگ سے پہلے اہلیت اور کسی بھی پن شدہ قسم کی جانچ کی جاتی ہے۔ ملٹی گارمنٹ کی درخواستیں دستیاب مماثل لباس تلاش کرتی ہیں۔ اگر کوئی نہیں ملتا ہے تو، SDK اس کی بجائے پہلے لباس کی توثیق کرتا ہے اور اسے پیش کرتا ہے۔ اگر توثیق ناکام ہو جاتی ہے، کوئی بٹن پیش نہیں کیا جاتا ہے اور وجہ کنسول میں لاگ ان ہوتی ہے۔
کال بیکس
| کال بیک | پے لوڈ |
|---|---|
onTryOnButtonClick | name: "spreeai-try-on-button-clicked" |
onAddToCartClicked | name: "spreeai-add-to-cart-clicked", گارمنٹس, setIsLoading, closePopUp, onError |
کارٹ گارمنٹس پر مشتمل ہے۔ id, partner_id, available اور name, علاوہ اختیاری description اور دیگر ڈیٹا۔ اپنی کارٹ میں نقشہ لگانے سے پہلے تصدیق کریں۔ دیکھیں ٹوکری کا نفاذ اور بٹن اسٹائل مثالوں کے لیے
اس سطح کا حصہ نہیں۔
واپس کیے گئے v3.0.0 SDK پر کوئی دستاویزی فی ویو سوئچ، اسٹینڈ اسٹون کمپیئر لانچر یا اسٹینڈ اسٹون سائزنگ کا طریقہ ظاہر نہیں کیا گیا ہے۔ features.loadingScreen ہٹا دیا گیا ہے. بقایا برآمد شدہ اقسام یا باسی تبصروں سے قابل کال طریقوں کا اندازہ نہ لگائیں۔