متن پر جائیں

نو زبانوں کے SDK فنکشن اور نتائج کا حوالہ

زبان کے لحاظ سے Launch کے عوامی فنکشن، پیرامیٹر، نتائج اور ناکامیاں دیکھیں۔ اختیاری پیرامیٹر اور طے شدہ اقدار متعلقہ سورس ورژن کے مطابق ہیں۔

یہ صفحہ Launch اکاؤنٹ اڈاپٹر بیان کرتا ہے۔ Licentivo کی اجازت، پیمائش اور آف لائن API کے لیے سرکاری SDK حوالہ دیکھیں۔

Licentivo SDK · فنکشن حوالہ

سیشن حالت صرف اکاؤنٹ کی وضاحت ہے؛ ہر محفوظ کاروباری عمل پر فنکشن گارڈ لگائیں۔

طے شدہ اسٹوریج میموری ہے۔ لاگ ان یاد رکھنے کے لیے محفوظ مستقل اسٹوریج درکار ہے، جو SDK کیش سے الگ ہے۔

بحالی کو آن لائن اکاؤنٹ تصدیق درکار ہے۔ Launch نیٹ ورک ناکامی پر آف لائن اجازت نہیں چنتا؛ سرکاری SDK جانچتا ہے۔

Go

متعلقہ سورس · v0.1.6 · application.go · runtime.go · client.go · store.go

خطائیں اور ناکامیاں: error != nil; errors.Is(err, launchclient.ErrNoSession); errors.As(err, &apiError)

Connect
Connect(merchantOrigin, productID, licentivoProductID string, trustedKeys map[string]string, options Config) → (*Application, error)
مقصد
عوامی ترتیبات جانچ کر ایپ بناتا ہے؛ ابھی لاگ ان یا محفوظ فنکشن کی اجازت نہیں ملتی۔
پیرامیٹر
  • merchantOrigin / origin: موجودہ اسٹور کا مکمل اصل پتہ، پروٹوکول اور ضروری پورٹ سمیت؛ پیداوار میں HTTPS۔
  • productID / product_id: Launch اسٹور پروڈکٹ ID، انتظامی انضمامی کوڈ خود بھرتا ہے۔
  • licentivoProductID / licentivo_product_id: Licentivo لائسنس پروڈکٹ ID، عوامی دستخطی ترتیب سے ملنا ضروری۔
  • trustedKeys / trusted_keys: دستخطی کلید ID اور عوامی کلید کا نقشہ، سرکاری SDK کے دستخط شدہ حقوق جانچنے کے لیے۔
  • environment: sandbox یا live؛ اکاؤنٹ، پروڈکٹ اور کیش ایک ماحول میں رکھیں۔
  • options / config: سیشن اسٹوریج، نجی کیش، منسوخی، دوبارہ کوشش یا اعلیٰ اجزا کے اختیار۔
واپسی قدر
(*Application, error)

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

Application.Login
Login(ctx context.Context, email, password string) → (State, error)
مقصد
اسٹور اکاؤنٹ سے لاگ ان، مختصر شناختی تصدیق حاصل اور سرکاری اجازت SDK شروع کرتا ہے۔
پیرامیٹر
  • ctx / ct / signal / cancellation: درخواست سیاق یا منسوخی سگنل؛ Go لائف سائیکل سیاق پس منظر کام بھی چلاتا ہے۔
  • email, password: اس اسٹور کے صارف کی ای میل اور پاس ورڈ؛ صرف اس لاگ ان کے لیے استعمال کریں۔
واپسی قدر
(State, error)

اکاؤنٹ حالت لوٹاتا ہے؛ نیچے فیلڈ جدول دیکھیں۔

Application.Restore
Restore(ctx context.Context) → (State, error)
مقصد
محفوظ سیشن پڑھ کر اکاؤنٹ کی آن لائن تصدیق، نیا شناختی ثبوت حاصل اور سرکاری SDK شروع کرتا ہے۔
پیرامیٹر
  • ctx / ct / signal / cancellation: درخواست سیاق یا منسوخی سگنل؛ Go لائف سائیکل سیاق پس منظر کام بھی چلاتا ہے۔
واپسی قدر
(State, error)

اکاؤنٹ حالت لوٹاتا ہے؛ ErrNoSession یا NO_SESSION محفوظ سیشن نہ ہونا ہے۔ دوسری خطائیں الگ سنبھالیں۔

Application.RunFeature
RunFeature(feature string, action func() error) → error
مقصد
سرکاری SDK ہر عمل پر اجازت جانچتا ہے؛ کال بیک صرف اجازت ملنے پر چلتا ہے۔
پیرامیٹر
  • feature / name, action / block: فنکشن نام پالیسی سے ملے؛ کال بیک میں اصل محفوظ کاروباری کوڈ ہو۔
واپسی قدر
error

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Application.Logout
Logout(ctx context.Context) → error
مقصد
مقامی اجازت روکتا، سرکاری SDK سے نکلتا، پھر Launch سیشن منسوخ کرتا ہے۔ نامکمل دور کی کارروائیاں دوبارہ کوشش کے لیے محفوظ رہتی ہیں۔
پیرامیٹر
  • ctx / ct / signal / cancellation: درخواست سیاق یا منسوخی سگنل؛ Go لائف سائیکل سیاق پس منظر کام بھی چلاتا ہے۔
واپسی قدر
error

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Application.ReleaseDevice
ReleaseDevice(ctx context.Context) → error
مقصد
واضح لاگ آؤٹ کا مطابقتی راستہ؛ Logout جیسا اکاؤنٹ اور ڈیوائس اخراج انجام دیتا ہے۔
پیرامیٹر
  • ctx / ct / signal / cancellation: درخواست سیاق یا منسوخی سگنل؛ Go لائف سائیکل سیاق پس منظر کام بھی چلاتا ہے۔
واپسی قدر
error

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Application.Close
Close() → void
مقصد
یہ انسٹینس اور پس منظر کام روکتا ہے، محفوظ لاگ ان اور ڈیوائس ربط برقرار رہتے ہیں۔
واپسی قدر
void

کاروباری قدر نہیں؛ معمول کا بند ہونا اکاؤنٹ اخراج یا ڈیوائس رہائی کی تصدیق نہیں۔

اعلیٰ اور مطابقتی API

NewApplication
NewApplication(config Config) → (*Application, error)
مقصد
عوامی ترتیبات جانچ کر ایپ بناتا ہے؛ ابھی لاگ ان یا محفوظ فنکشن کی اجازت نہیں ملتی۔
پیرامیٹر
  • options / config: سیشن اسٹوریج، نجی کیش، منسوخی، دوبارہ کوشش یا اعلیٰ اجزا کے اختیار۔
واپسی قدر
(*Application, error)

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

NewApplicationFromFiles
NewApplicationFromFiles(launchPath, productPath string, options Config) → (*Application, error)
مقصد
دو موجودہ عوامی ترتیب فائلیں پڑھ کر پروڈکٹ مطابقت جانچتا اور ایپ بناتا ہے۔ براہ راست کنکشن کو فائل درکار نہیں۔
پیرامیٹر
  • launchPath, productPath: منتخب ترتیب راستے یا موجودہ صارف کا نجی کیش اور اسٹوریج فولڈر۔
  • options / config: سیشن اسٹوریج، نجی کیش، منسوخی، دوبارہ کوشش یا اعلیٰ اجزا کے اختیار۔
واپسی قدر
(*Application, error)

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

LoadPublicConfig
LoadPublicConfig(path string) → (PublicConfig, error)
مقصد
عوامی ترتیبات پڑھتا یا جانچتا ہے؛ پروڈکٹ، ماحول اور دستخطی کلیدیں ملنی چاہییں۔
پیرامیٹر
  • path: منتخب ترتیب راستے یا موجودہ صارف کا نجی کیش اور اسٹوریج فولڈر۔
واپسی قدر
(PublicConfig, error)

دستخط میں بیان کردہ قسم کی قدر لوٹاتا ہے؛ اس سے فنکشن اجازت نہیں ملتی۔

NewRuntime
NewRuntime(product ProductConfig, runtime RuntimeConfig) → (Runtime, error)
مقصد
اعلیٰ انضمام کے لیے سرکاری SDK اڈاپٹر بناتا ہے؛ شناختی ثبوت صرف میموری میں دیا جاتا ہے۔
پیرامیٹر
  • product, runtime: ترتیب، رن ٹائم اڈاپٹر، ٹرانسپورٹ یا درخواست آبجیکٹ، صرف اعلیٰ انضمام کے لیے۔
واپسی قدر
(Runtime, error)

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

New
New(origin string, allowLocalHTTP bool) → (*Client, error)
مقصد
عوامی ترتیبات جانچ کر ایپ بناتا ہے؛ ابھی لاگ ان یا محفوظ فنکشن کی اجازت نہیں ملتی۔
پیرامیٹر
  • origin: موجودہ اسٹور کا مکمل اصل پتہ، پروٹوکول اور ضروری پورٹ سمیت؛ پیداوار میں HTTPS۔
  • allowLocalHTTP: سیشن اسٹوریج، نجی کیش، منسوخی، دوبارہ کوشش یا اعلیٰ اجزا کے اختیار۔
واپسی قدر
(*Client, error)

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

Client.WithToken
WithToken(token string) → *Client
مقصد
دیے گئے اکاؤنٹ ٹوکن والا کلائنٹ کاپی لوٹاتا ہے، صرف قابل اعتماد بیک اینڈ کے لیے۔
پیرامیٹر
  • token: Launch سیشن ٹوکن؛ صرف نچلی سیشن یا خفیہ اسٹوریج انٹرفیس سے ملتا ہے۔
واپسی قدر
*Client

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

Client.Login
Login(ctx context.Context, email, password string) → (User, error)
مقصد
اکاؤنٹ کی تصدیق کرکے معلومات یا سیشن لوٹاتا ہے؛ اجازت رن ٹائم شروع نہیں کرتا۔
پیرامیٹر
  • ctx / ct / signal / cancellation: درخواست سیاق یا منسوخی سگنل؛ Go لائف سائیکل سیاق پس منظر کام بھی چلاتا ہے۔
  • email, password: اس اسٹور کے صارف کی ای میل اور پاس ورڈ؛ صرف اس لاگ ان کے لیے استعمال کریں۔
واپسی قدر
(User, error)

اکاؤنٹ حالت لوٹاتا ہے؛ نیچے فیلڈ جدول دیکھیں۔

Client.LoginSession
LoginSession(ctx context.Context, email, password string) → (Session, error)
مقصد
اکاؤنٹ کی تصدیق کرکے معلومات یا سیشن لوٹاتا ہے؛ اجازت رن ٹائم شروع نہیں کرتا۔
پیرامیٹر
  • ctx / ct / signal / cancellation: درخواست سیاق یا منسوخی سگنل؛ Go لائف سائیکل سیاق پس منظر کام بھی چلاتا ہے۔
  • email, password: اس اسٹور کے صارف کی ای میل اور پاس ورڈ؛ صرف اس لاگ ان کے لیے استعمال کریں۔
واپسی قدر
(Session, error)

اکاؤنٹ حالت لوٹاتا ہے؛ نیچے فیلڈ جدول دیکھیں۔

Client.CurrentUser
CurrentUser(ctx context.Context) → (User, error)
مقصد
موجودہ اکاؤنٹ کی معلومات لیتا ہے؛ کامیابی محفوظ کام کی اجازت نہیں۔
پیرامیٹر
  • ctx / ct / signal / cancellation: درخواست سیاق یا منسوخی سگنل؛ Go لائف سائیکل سیاق پس منظر کام بھی چلاتا ہے۔
واپسی قدر
(User, error)

اکاؤنٹ حالت لوٹاتا ہے؛ نیچے فیلڈ جدول دیکھیں۔

Client.Identity
Identity(ctx context.Context, product, environment string) → (Identity, error)
مقصد
ایک بار استعمال کا شناختی ثبوت اور عوامی راستہ حاصل کرتا ہے؛ یہ لائسنس یا فنکشن اجازت نہیں۔
پیرامیٹر
  • ctx / ct / signal / cancellation: درخواست سیاق یا منسوخی سگنل؛ Go لائف سائیکل سیاق پس منظر کام بھی چلاتا ہے۔
  • product: Launch اسٹور پروڈکٹ ID، انتظامی انضمامی کوڈ خود بھرتا ہے۔
  • environment: sandbox یا live؛ اکاؤنٹ، پروڈکٹ اور کیش ایک ماحول میں رکھیں۔
واپسی قدر
(Identity, error)

اکاؤنٹ حالت لوٹاتا ہے؛ نیچے فیلڈ جدول دیکھیں۔

Client.SignOut
SignOut(ctx context.Context) → error
مقصد
Launch سیشن منسوخ کرکے کلائنٹ ٹوکن مٹاتا ہے؛ سرکاری SDK کے ڈیوائس لاگ آؤٹ کا بدل نہیں۔
پیرامیٹر
  • ctx / ct / signal / cancellation: درخواست سیاق یا منسوخی سگنل؛ Go لائف سائیکل سیاق پس منظر کام بھی چلاتا ہے۔
واپسی قدر
error

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Client.Credential
Credential(ctx context.Context, product, environment string) → (Credential, error)
مقصد
پرانی API برقرار ہے؛ طویل لائسنس اسناد کا پروٹوکول ہٹ چکا، اس لیے کال ناکام ہوتی ہے۔ Application استعمال کریں۔
پیرامیٹر
  • ctx / ct / signal / cancellation: درخواست سیاق یا منسوخی سگنل؛ Go لائف سائیکل سیاق پس منظر کام بھی چلاتا ہے۔
  • product: Launch اسٹور پروڈکٹ ID، انتظامی انضمامی کوڈ خود بھرتا ہے۔
  • environment: sandbox یا live؛ اکاؤنٹ، پروڈکٹ اور کیش ایک ماحول میں رکھیں۔
واپسی قدر
(Credential, error)

ہمیشہ ناکام؛ اکاؤنٹ شناخت کے تبادلے پر منتقل ہوں۔

Client.CredentialWithRetry
CredentialWithRetry(ctx context.Context, product, environment string, policy RetryPolicy) → (Credential, error)
مقصد
پرانی API برقرار ہے؛ طویل لائسنس اسناد کا پروٹوکول ہٹ چکا، اس لیے کال ناکام ہوتی ہے۔ Application استعمال کریں۔
پیرامیٹر
  • ctx / ct / signal / cancellation: درخواست سیاق یا منسوخی سگنل؛ Go لائف سائیکل سیاق پس منظر کام بھی چلاتا ہے۔
  • product: Launch اسٹور پروڈکٹ ID، انتظامی انضمامی کوڈ خود بھرتا ہے۔
  • environment: sandbox یا live؛ اکاؤنٹ، پروڈکٹ اور کیش ایک ماحول میں رکھیں۔
  • policy: سیشن اسٹوریج، نجی کیش، منسوخی، دوبارہ کوشش یا اعلیٰ اجزا کے اختیار۔
واپسی قدر
(Credential, error)

ہمیشہ ناکام؛ اکاؤنٹ شناخت کے تبادلے پر منتقل ہوں۔

NewSystemSessionStore
NewSystemSessionStore(directory string) → (SessionStore, error)
مقصد
محفوظ مستقل سیشن اسٹوریج بناتا ہے؛ خفیہ کاری کی کلید نظام کے اسناد والٹ سے لیں۔
پیرامیٹر
  • directory: منتخب ترتیب راستے یا موجودہ صارف کا نجی کیش اور اسٹوریج فولڈر۔
واپسی قدر
(SessionStore, error)

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

ProtectDirectory
ProtectDirectory(directory string) → error
مقصد
فولڈر کی رسائی موجودہ Windows صارف یا دوسرے پلیٹ فارم کی نجی اجازتوں تک محدود کرتا ہے۔
پیرامیٹر
  • directory: منتخب ترتیب راستے یا موجودہ صارف کا نجی کیش اور اسٹوریج فولڈر۔
واپسی قدر
error

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

ServiceUnavailable
ServiceUnavailable(err error) → bool
مقصد
عارضی سروس عدم دستیابی پہچانتا ہے؛ یہ آف لائن اجازت نہیں دیتا۔
پیرامیٹر
  • err: درجہ بندی، انتظار اور تشخیصی ربط کے لیے منظم خطا بناتا یا پڑھتا ہے۔
واپسی قدر
bool

بولین درجہ بندی لوٹاتا ہے، اجازت نہیں۔

APIError.Error / TransportError.Error
Error() → string
مقصد
درجہ بندی، انتظار اور تشخیصی ربط کے لیے منظم خطا بناتا یا پڑھتا ہے۔
واپسی قدر
string

دستخط میں بیان کردہ قسم کی قدر لوٹاتا ہے؛ اس سے فنکشن اجازت نہیں ملتی۔

TransportError.Unwrap
Unwrap() → error
مقصد
درجہ بندی، انتظار اور تشخیصی ربط کے لیے منظم خطا بناتا یا پڑھتا ہے۔
واپسی قدر
error

دستخط میں بیان کردہ قسم کی قدر لوٹاتا ہے؛ اس سے فنکشن اجازت نہیں ملتی۔

MemoryStore.Load / SessionStore.Load
Load(ctx context.Context, key string) → ([]byte, error)
مقصد
الگ کلید سے اکاؤنٹ ریکارڈ پڑھتا ہے؛ اس میں راز ہیں، صرف SDK کو دیں۔
پیرامیٹر
  • scope / key, value / record: SDK کی الگ کلیدیں اور خفیہ ریکارڈ؛ حسب ضرورت اسٹوریج متعدد کلیدیں اور ایٹمی تبدیلی سنبھالے۔
واپسی قدر
([]byte, error)

خفیہ ریکارڈ لوٹاتا ہے؛ غیر موجود ہو تو زبان کے مطابق خالی قدر یا ErrNoSession۔

MemoryStore.Save / SessionStore.Save
Save(ctx context.Context, key string, value []byte) → error
مقصد
الگ کلید کے تحت اکاؤنٹ ریکارڈ ایٹمی طور پر محفوظ کرتا ہے۔
پیرامیٹر
  • scope / key, value / record: SDK کی الگ کلیدیں اور خفیہ ریکارڈ؛ حسب ضرورت اسٹوریج متعدد کلیدیں اور ایٹمی تبدیلی سنبھالے۔
واپسی قدر
error

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

MemoryStore.Delete / SessionStore.Delete
Delete(ctx context.Context, key string) → error
مقصد
اکاؤنٹ ریکارڈ حذف کرتا ہے، سرکاری SDK کی اجازت کیش یا اخراج جرنل نہیں۔
پیرامیٹر
  • scope / key, value / record: SDK کی الگ کلیدیں اور خفیہ ریکارڈ؛ حسب ضرورت اسٹوریج متعدد کلیدیں اور ایٹمی تبدیلی سنبھالے۔
واپسی قدر
error

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Runtime.Start
Start(ctx context.Context, onError func(error)) → error
مقصد
سرکاری SDK کی جانچ اور پس منظر دیکھ بھال شروع کرتا ہے؛ لاگ ان اور فنکشن حفاظت الگ API ہیں۔
پیرامیٹر
  • ctx / ct / signal / cancellation: درخواست سیاق یا منسوخی سگنل؛ Go لائف سائیکل سیاق پس منظر کام بھی چلاتا ہے۔
  • onError: درجہ بندی، انتظار اور تشخیصی ربط کے لیے منظم خطا بناتا یا پڑھتا ہے۔
واپسی قدر
error

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Runtime.RunFeature
RunFeature(feature string, action func() error) → error
مقصد
سرکاری SDK ہر عمل پر اجازت جانچتا ہے؛ کال بیک صرف اجازت ملنے پر چلتا ہے۔
پیرامیٹر
  • feature / name, action / block: فنکشن نام پالیسی سے ملے؛ کال بیک میں اصل محفوظ کاروباری کوڈ ہو۔
واپسی قدر
error

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Runtime.Deactivate
Deactivate(ctx context.Context) → error
مقصد
سرکاری SDK کا ڈیوائس اخراج کرتا ہے؛ ایپ Launch اکاؤنٹ سیشن الگ منسوخ کرتی ہے۔
پیرامیٹر
  • ctx / ct / signal / cancellation: درخواست سیاق یا منسوخی سگنل؛ Go لائف سائیکل سیاق پس منظر کام بھی چلاتا ہے۔
واپسی قدر
error

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Runtime.Close
Close() → void
مقصد
یہ انسٹینس اور پس منظر کام روکتا ہے، محفوظ لاگ ان اور ڈیوائس ربط برقرار رہتے ہیں۔
واپسی قدر
void

کاروباری قدر نہیں؛ معمول کا بند ہونا اکاؤنٹ اخراج یا ڈیوائس رہائی کی تصدیق نہیں۔

Python

متعلقہ سورس · v0.1.6 · client.py

خطائیں اور ناکامیاں: APIError.code / .status / .retry_after / .retryable; ValueError; SDK exceptions

Application.connect
Application.connect(merchant_origin, product_id, licentivo_product_id, trusted_keys, environment="live", **kwargs) → Application
مقصد
عوامی ترتیبات جانچ کر ایپ بناتا ہے؛ ابھی لاگ ان یا محفوظ فنکشن کی اجازت نہیں ملتی۔
پیرامیٹر
  • merchantOrigin / origin: موجودہ اسٹور کا مکمل اصل پتہ، پروٹوکول اور ضروری پورٹ سمیت؛ پیداوار میں HTTPS۔
  • productID / product_id: Launch اسٹور پروڈکٹ ID، انتظامی انضمامی کوڈ خود بھرتا ہے۔
  • licentivoProductID / licentivo_product_id: Licentivo لائسنس پروڈکٹ ID، عوامی دستخطی ترتیب سے ملنا ضروری۔
  • trustedKeys / trusted_keys: دستخطی کلید ID اور عوامی کلید کا نقشہ، سرکاری SDK کے دستخط شدہ حقوق جانچنے کے لیے۔
  • environment: sandbox یا live؛ اکاؤنٹ، پروڈکٹ اور کیش ایک ماحول میں رکھیں۔
  • options / config: سیشن اسٹوریج، نجی کیش، منسوخی، دوبارہ کوشش یا اعلیٰ اجزا کے اختیار۔
واپسی قدر
Application

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

Application.login
login(email, password, *, pending_attempts=3) → Application (self)
مقصد
اسٹور اکاؤنٹ سے لاگ ان، مختصر شناختی تصدیق حاصل اور سرکاری اجازت SDK شروع کرتا ہے۔
پیرامیٹر
  • email, password: اس اسٹور کے صارف کی ای میل اور پاس ورڈ؛ صرف اس لاگ ان کے لیے استعمال کریں۔
  • pending_attempts: سیشن اسٹوریج، نجی کیش، منسوخی، دوبارہ کوشش یا اعلیٰ اجزا کے اختیار۔
واپسی قدر
Application (self)

یہی ایپ انسٹینس لوٹاتا ہے، اکاؤنٹ معلومات یا اجازت نتیجہ نہیں۔

Application.restore
restore() → bool
مقصد
محفوظ سیشن پڑھ کر اکاؤنٹ کی آن لائن تصدیق، نیا شناختی ثبوت حاصل اور سرکاری SDK شروع کرتا ہے۔
واپسی قدر
bool

true بحالی کی کامیابی اور false قابل بحالی سیشن نہ ہونا ہے۔ انکار، میعاد یا نیٹ ورک کی ناکامی خطا ہے۔

Application.run_feature
run_feature(name, action) → T
مقصد
سرکاری SDK ہر عمل پر اجازت جانچتا ہے؛ کال بیک صرف اجازت ملنے پر چلتا ہے۔
پیرامیٹر
  • feature / name, action / block: فنکشن نام پالیسی سے ملے؛ کال بیک میں اصل محفوظ کاروباری کوڈ ہو۔
واپسی قدر
T

کاروباری کال بیک کا نتیجہ لوٹاتا ہے؛ اجازت ناکامی یا کاروباری استثنا خطا ہے۔

Application.logout
logout() → bool
مقصد
مقامی اجازت روکتا، سرکاری SDK سے نکلتا، پھر Launch سیشن منسوخ کرتا ہے۔ نامکمل دور کی کارروائیاں دوبارہ کوشش کے لیے محفوظ رہتی ہیں۔
واپسی قدر
bool

true لاگ آؤٹ کی تصدیق ہے؛ false دور کے اکاؤنٹ اخراج یا ڈیوائس منسوخی کا زیر التوا ہونا ہے۔ اسٹوریج بھی خطا دے سکتا ہے۔

Application.release_device
release_device() → bool
مقصد
واضح لاگ آؤٹ کا مطابقتی راستہ؛ Logout جیسا اکاؤنٹ اور ڈیوائس اخراج انجام دیتا ہے۔
واپسی قدر
bool

true لاگ آؤٹ کی تصدیق ہے؛ false دور کے اکاؤنٹ اخراج یا ڈیوائس منسوخی کا زیر التوا ہونا ہے۔ اسٹوریج بھی خطا دے سکتا ہے۔

Application.close
close() → None
مقصد
یہ انسٹینس اور پس منظر کام روکتا ہے، محفوظ لاگ ان اور ڈیوائس ربط برقرار رہتے ہیں۔
واپسی قدر
None

کاروباری قدر نہیں؛ معمول کا بند ہونا اکاؤنٹ اخراج یا ڈیوائس رہائی کی تصدیق نہیں۔

Application.__enter__ / __exit__
with Application.connect(...) as app: ... → Application / None
مقصد
یہ انسٹینس اور پس منظر کام روکتا ہے، محفوظ لاگ ان اور ڈیوائس ربط برقرار رہتے ہیں۔
واپسی قدر
Application / None

کاروباری قدر نہیں؛ معمول کا بند ہونا اکاؤنٹ اخراج یا ڈیوائس رہائی کی تصدیق نہیں۔

اعلیٰ اور مطابقتی API

Application.__init__
Application(origin, product_id, product_config, environment="live", store=None, runtime_factory=None, cache_dir=None, sleep=time.sleep, opener=None) → Application
مقصد
عوامی ترتیبات جانچ کر ایپ بناتا ہے؛ ابھی لاگ ان یا محفوظ فنکشن کی اجازت نہیں ملتی۔
پیرامیٹر
  • origin: موجودہ اسٹور کا مکمل اصل پتہ، پروٹوکول اور ضروری پورٹ سمیت؛ پیداوار میں HTTPS۔
  • product_id: Launch اسٹور پروڈکٹ ID، انتظامی انضمامی کوڈ خود بھرتا ہے۔
  • product_config: ترتیب، رن ٹائم اڈاپٹر، ٹرانسپورٹ یا درخواست آبجیکٹ، صرف اعلیٰ انضمام کے لیے۔
  • environment: sandbox یا live؛ اکاؤنٹ، پروڈکٹ اور کیش ایک ماحول میں رکھیں۔
  • options / config: سیشن اسٹوریج، نجی کیش، منسوخی، دوبارہ کوشش یا اعلیٰ اجزا کے اختیار۔
واپسی قدر
Application

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

Application.from_files
Application.from_files(launch_config, product_config, **kwargs) → Application
مقصد
دو موجودہ عوامی ترتیب فائلیں پڑھ کر پروڈکٹ مطابقت جانچتا اور ایپ بناتا ہے۔ براہ راست کنکشن کو فائل درکار نہیں۔
پیرامیٹر
  • launch_config, product_config: منتخب ترتیب راستے یا موجودہ صارف کا نجی کیش اور اسٹوریج فولڈر۔
  • options / config: سیشن اسٹوریج، نجی کیش، منسوخی، دوبارہ کوشش یا اعلیٰ اجزا کے اختیار۔
واپسی قدر
Application

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

MemoryStore
MemoryStore() → MemoryStore
مقصد
صرف موجودہ عمل تک مؤثر سیشن اسٹوریج بناتا ہے۔
واپسی قدر
MemoryStore

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

WindowsDPAPIStore
WindowsDPAPIStore(directory=None) → WindowsDPAPIStore
مقصد
محفوظ مستقل سیشن اسٹوریج بناتا ہے؛ خفیہ کاری کی کلید نظام کے اسناد والٹ سے لیں۔
پیرامیٹر
  • directory: منتخب ترتیب راستے یا موجودہ صارف کا نجی کیش اور اسٹوریج فولڈر۔
واپسی قدر
WindowsDPAPIStore

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

APIError
APIError(code, status=0, retry_after=0) → APIError
مقصد
درجہ بندی، انتظار اور تشخیصی ربط کے لیے منظم خطا بناتا یا پڑھتا ہے۔
پیرامیٹر
  • code, status, retry_after: درجہ بندی، انتظار اور تشخیصی ربط کے لیے منظم خطا بناتا یا پڑھتا ہے۔
واپسی قدر
APIError

دستخط میں بیان کردہ قسم کی قدر لوٹاتا ہے؛ اس سے فنکشن اجازت نہیں ملتی۔

MemoryStore.load / WindowsDPAPIStore.load
load(key) → bytes | None
مقصد
الگ کلید سے اکاؤنٹ ریکارڈ پڑھتا ہے؛ اس میں راز ہیں، صرف SDK کو دیں۔
پیرامیٹر
  • scope / key, value / record: SDK کی الگ کلیدیں اور خفیہ ریکارڈ؛ حسب ضرورت اسٹوریج متعدد کلیدیں اور ایٹمی تبدیلی سنبھالے۔
واپسی قدر
bytes | None

خفیہ ریکارڈ لوٹاتا ہے؛ غیر موجود ہو تو زبان کے مطابق خالی قدر یا ErrNoSession۔

MemoryStore.save / WindowsDPAPIStore.save
save(key, value) → None
مقصد
الگ کلید کے تحت اکاؤنٹ ریکارڈ ایٹمی طور پر محفوظ کرتا ہے۔
پیرامیٹر
  • scope / key, value / record: SDK کی الگ کلیدیں اور خفیہ ریکارڈ؛ حسب ضرورت اسٹوریج متعدد کلیدیں اور ایٹمی تبدیلی سنبھالے۔
واپسی قدر
None

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

MemoryStore.delete / WindowsDPAPIStore.delete
delete(key) → None
مقصد
اکاؤنٹ ریکارڈ حذف کرتا ہے، سرکاری SDK کی اجازت کیش یا اخراج جرنل نہیں۔
پیرامیٹر
  • scope / key, value / record: SDK کی الگ کلیدیں اور خفیہ ریکارڈ؛ حسب ضرورت اسٹوریج متعدد کلیدیں اور ایٹمی تبدیلی سنبھالے۔
واپسی قدر
None

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

C#

متعلقہ سورس · v0.1.6 · Application.cs · SessionStore.cs

خطائیں اور ناکامیاں: await Task / ValueTask; LaunchException.Code / .Status / .RetryAfterSeconds / .Retryable

Application.Connect
Application.Connect(string merchantOrigin, string productId, string licentivoProductId, Dictionary<string,string> trustedKeys, string environment="live", ISessionStore? store=null, string? cacheDirectory=null) → Application
مقصد
عوامی ترتیبات جانچ کر ایپ بناتا ہے؛ ابھی لاگ ان یا محفوظ فنکشن کی اجازت نہیں ملتی۔
پیرامیٹر
  • merchantOrigin / origin: موجودہ اسٹور کا مکمل اصل پتہ، پروٹوکول اور ضروری پورٹ سمیت؛ پیداوار میں HTTPS۔
  • productID / product_id: Launch اسٹور پروڈکٹ ID، انتظامی انضمامی کوڈ خود بھرتا ہے۔
  • licentivoProductID / licentivo_product_id: Licentivo لائسنس پروڈکٹ ID، عوامی دستخطی ترتیب سے ملنا ضروری۔
  • trustedKeys / trusted_keys: دستخطی کلید ID اور عوامی کلید کا نقشہ، سرکاری SDK کے دستخط شدہ حقوق جانچنے کے لیے۔
  • environment: sandbox یا live؛ اکاؤنٹ، پروڈکٹ اور کیش ایک ماحول میں رکھیں۔
  • store, cacheDirectory: سیشن اسٹوریج، نجی کیش، منسوخی، دوبارہ کوشش یا اعلیٰ اجزا کے اختیار۔
واپسی قدر
Application

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

Application.Login
Login(string email, string password, int pendingAttempts=3, CancellationToken ct=default) → Task
مقصد
اسٹور اکاؤنٹ سے لاگ ان، مختصر شناختی تصدیق حاصل اور سرکاری اجازت SDK شروع کرتا ہے۔
پیرامیٹر
  • email, password: اس اسٹور کے صارف کی ای میل اور پاس ورڈ؛ صرف اس لاگ ان کے لیے استعمال کریں۔
  • pendingAttempts: سیشن اسٹوریج، نجی کیش، منسوخی، دوبارہ کوشش یا اعلیٰ اجزا کے اختیار۔
  • ctx / ct / signal / cancellation: درخواست سیاق یا منسوخی سگنل؛ Go لائف سائیکل سیاق پس منظر کام بھی چلاتا ہے۔
واپسی قدر
Task

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Application.Restore
Restore(CancellationToken ct=default) → Task<bool>
مقصد
محفوظ سیشن پڑھ کر اکاؤنٹ کی آن لائن تصدیق، نیا شناختی ثبوت حاصل اور سرکاری SDK شروع کرتا ہے۔
پیرامیٹر
  • ctx / ct / signal / cancellation: درخواست سیاق یا منسوخی سگنل؛ Go لائف سائیکل سیاق پس منظر کام بھی چلاتا ہے۔
واپسی قدر
Task<bool>

true بحالی کی کامیابی اور false قابل بحالی سیشن نہ ہونا ہے۔ انکار، میعاد یا نیٹ ورک کی ناکامی خطا ہے۔

Application.RunFeature
RunFeature(string feature, Func<Task> action) → Task
مقصد
سرکاری SDK ہر عمل پر اجازت جانچتا ہے؛ کال بیک صرف اجازت ملنے پر چلتا ہے۔
پیرامیٹر
  • feature / name, action / block: فنکشن نام پالیسی سے ملے؛ کال بیک میں اصل محفوظ کاروباری کوڈ ہو۔
واپسی قدر
Task

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Application.Status
Status() → AuthorizationStatus? (null: runtime absent)
مقصد
سرکاری SDK کی موجودہ اجازت حالت پڑھتا ہے؛ لاگ ان یا فی فنکشن جانچ کا بدل نہیں۔
واپسی قدر
AuthorizationStatus? (null: runtime absent)

سرکاری SDK کی موجودہ اجازت حالت پڑھتا ہے؛ لاگ ان یا فی فنکشن جانچ کا بدل نہیں۔

Application.Logout
Logout(CancellationToken ct=default) → Task
مقصد
مقامی اجازت روکتا، سرکاری SDK سے نکلتا، پھر Launch سیشن منسوخ کرتا ہے۔ نامکمل دور کی کارروائیاں دوبارہ کوشش کے لیے محفوظ رہتی ہیں۔
پیرامیٹر
  • ctx / ct / signal / cancellation: درخواست سیاق یا منسوخی سگنل؛ Go لائف سائیکل سیاق پس منظر کام بھی چلاتا ہے۔
واپسی قدر
Task

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Application.ReleaseDevice
ReleaseDevice(CancellationToken ct=default) → Task
مقصد
واضح لاگ آؤٹ کا مطابقتی راستہ؛ Logout جیسا اکاؤنٹ اور ڈیوائس اخراج انجام دیتا ہے۔
پیرامیٹر
  • ctx / ct / signal / cancellation: درخواست سیاق یا منسوخی سگنل؛ Go لائف سائیکل سیاق پس منظر کام بھی چلاتا ہے۔
واپسی قدر
Task

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Application.DisposeAsync
DisposeAsync() → ValueTask
مقصد
یہ انسٹینس اور پس منظر کام روکتا ہے، محفوظ لاگ ان اور ڈیوائس ربط برقرار رہتے ہیں۔
واپسی قدر
ValueTask

کاروباری قدر نہیں؛ معمول کا بند ہونا اکاؤنٹ اخراج یا ڈیوائس رہائی کی تصدیق نہیں۔

اعلیٰ اور مطابقتی API

Application
Application(string origin, string productId, Config productConfig, string environment="live", ISessionStore? store=null, string? cacheDirectory=null, HttpMessageHandler? handler=null, Func<Config,IRuntime>? runtimeFactory=null) → Application
مقصد
عوامی ترتیبات جانچ کر ایپ بناتا ہے؛ ابھی لاگ ان یا محفوظ فنکشن کی اجازت نہیں ملتی۔
پیرامیٹر
  • origin: موجودہ اسٹور کا مکمل اصل پتہ، پروٹوکول اور ضروری پورٹ سمیت؛ پیداوار میں HTTPS۔
  • productId: Launch اسٹور پروڈکٹ ID، انتظامی انضمامی کوڈ خود بھرتا ہے۔
  • productConfig: ترتیب، رن ٹائم اڈاپٹر، ٹرانسپورٹ یا درخواست آبجیکٹ، صرف اعلیٰ انضمام کے لیے۔
  • environment: sandbox یا live؛ اکاؤنٹ، پروڈکٹ اور کیش ایک ماحول میں رکھیں۔
  • options / config: سیشن اسٹوریج، نجی کیش، منسوخی، دوبارہ کوشش یا اعلیٰ اجزا کے اختیار۔
واپسی قدر
Application

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

Application.FromFiles
Application.FromFiles(string launchPath, string productPath, ISessionStore? store=null) → Application
مقصد
دو موجودہ عوامی ترتیب فائلیں پڑھ کر پروڈکٹ مطابقت جانچتا اور ایپ بناتا ہے۔ براہ راست کنکشن کو فائل درکار نہیں۔
پیرامیٹر
  • launchPath, productPath: منتخب ترتیب راستے یا موجودہ صارف کا نجی کیش اور اسٹوریج فولڈر۔
  • store: سیشن اسٹوریج، نجی کیش، منسوخی، دوبارہ کوشش یا اعلیٰ اجزا کے اختیار۔
واپسی قدر
Application

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

MemoryStore
new MemoryStore() → MemoryStore
مقصد
صرف موجودہ عمل تک مؤثر سیشن اسٹوریج بناتا ہے۔
واپسی قدر
MemoryStore

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

WindowsDPAPIStore
new WindowsDPAPIStore(string? directory=null) → WindowsDPAPIStore
مقصد
محفوظ مستقل سیشن اسٹوریج بناتا ہے؛ خفیہ کاری کی کلید نظام کے اسناد والٹ سے لیں۔
پیرامیٹر
  • directory: منتخب ترتیب راستے یا موجودہ صارف کا نجی کیش اور اسٹوریج فولڈر۔
واپسی قدر
WindowsDPAPIStore

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

LaunchException
new LaunchException(string code, int status=0, int retryAfterSeconds=0) → LaunchException
مقصد
درجہ بندی، انتظار اور تشخیصی ربط کے لیے منظم خطا بناتا یا پڑھتا ہے۔
پیرامیٹر
  • code, status, retryAfterSeconds: درجہ بندی، انتظار اور تشخیصی ربط کے لیے منظم خطا بناتا یا پڑھتا ہے۔
واپسی قدر
LaunchException

دستخط میں بیان کردہ قسم کی قدر لوٹاتا ہے؛ اس سے فنکشن اجازت نہیں ملتی۔

ISessionStore.Load / MemoryStore.Load / WindowsDPAPIStore.Load
Load(string key) → byte[]?
مقصد
الگ کلید سے اکاؤنٹ ریکارڈ پڑھتا ہے؛ اس میں راز ہیں، صرف SDK کو دیں۔
پیرامیٹر
  • scope / key, value / record: SDK کی الگ کلیدیں اور خفیہ ریکارڈ؛ حسب ضرورت اسٹوریج متعدد کلیدیں اور ایٹمی تبدیلی سنبھالے۔
واپسی قدر
byte[]?

خفیہ ریکارڈ لوٹاتا ہے؛ غیر موجود ہو تو زبان کے مطابق خالی قدر یا ErrNoSession۔

ISessionStore.Save / MemoryStore.Save / WindowsDPAPIStore.Save
Save(string key, byte[] value) → void
مقصد
الگ کلید کے تحت اکاؤنٹ ریکارڈ ایٹمی طور پر محفوظ کرتا ہے۔
پیرامیٹر
  • scope / key, value / record: SDK کی الگ کلیدیں اور خفیہ ریکارڈ؛ حسب ضرورت اسٹوریج متعدد کلیدیں اور ایٹمی تبدیلی سنبھالے۔
واپسی قدر
void

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

ISessionStore.Delete / MemoryStore.Delete / WindowsDPAPIStore.Delete
Delete(string key) → void
مقصد
اکاؤنٹ ریکارڈ حذف کرتا ہے، سرکاری SDK کی اجازت کیش یا اخراج جرنل نہیں۔
پیرامیٹر
  • scope / key, value / record: SDK کی الگ کلیدیں اور خفیہ ریکارڈ؛ حسب ضرورت اسٹوریج متعدد کلیدیں اور ایٹمی تبدیلی سنبھالے۔
واپسی قدر
void

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

IRuntime.Start
Start(CancellationToken ct) → Task
مقصد
سرکاری SDK کی جانچ اور پس منظر دیکھ بھال شروع کرتا ہے؛ لاگ ان اور فنکشن حفاظت الگ API ہیں۔
پیرامیٹر
  • ctx / ct / signal / cancellation: درخواست سیاق یا منسوخی سگنل؛ Go لائف سائیکل سیاق پس منظر کام بھی چلاتا ہے۔
واپسی قدر
Task

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

IRuntime.Status
Status() → AuthorizationStatus
مقصد
سرکاری SDK کی موجودہ اجازت حالت پڑھتا ہے؛ لاگ ان یا فی فنکشن جانچ کا بدل نہیں۔
واپسی قدر
AuthorizationStatus

سرکاری SDK کی موجودہ اجازت حالت پڑھتا ہے؛ لاگ ان یا فی فنکشن جانچ کا بدل نہیں۔

IRuntime.RunFeature
RunFeature(string feature, Func<Task> action) → Task
مقصد
سرکاری SDK ہر عمل پر اجازت جانچتا ہے؛ کال بیک صرف اجازت ملنے پر چلتا ہے۔
پیرامیٹر
  • feature / name, action / block: فنکشن نام پالیسی سے ملے؛ کال بیک میں اصل محفوظ کاروباری کوڈ ہو۔
واپسی قدر
Task

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

IRuntime.Deactivate
Deactivate(CancellationToken ct) → Task
مقصد
سرکاری SDK کا ڈیوائس اخراج کرتا ہے؛ ایپ Launch اکاؤنٹ سیشن الگ منسوخ کرتی ہے۔
پیرامیٹر
  • ctx / ct / signal / cancellation: درخواست سیاق یا منسوخی سگنل؛ Go لائف سائیکل سیاق پس منظر کام بھی چلاتا ہے۔
واپسی قدر
Task

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

IRuntime.DisposeAsync
DisposeAsync() → ValueTask
مقصد
یہ انسٹینس اور پس منظر کام روکتا ہے، محفوظ لاگ ان اور ڈیوائس ربط برقرار رہتے ہیں۔
واپسی قدر
ValueTask

کاروباری قدر نہیں؛ معمول کا بند ہونا اکاؤنٹ اخراج یا ڈیوائس رہائی کی تصدیق نہیں۔

Java

متعلقہ سورس · v0.1.6 · Launch.java · EncryptedFileStore.java

خطائیں اور ناکامیاں: throws Exception; Launch.Failure.code / .status / .requestID / .retryAfterMillis / .transport; char[] password

Launch.connect
Launch.connect(String merchantOrigin, String productId, String licentivoProductId, Map<String,String> trustedKeys, String environment) → Launch
مقصد
عوامی ترتیبات جانچ کر ایپ بناتا ہے؛ ابھی لاگ ان یا محفوظ فنکشن کی اجازت نہیں ملتی۔
پیرامیٹر
  • merchantOrigin / origin: موجودہ اسٹور کا مکمل اصل پتہ، پروٹوکول اور ضروری پورٹ سمیت؛ پیداوار میں HTTPS۔
  • productID / product_id: Launch اسٹور پروڈکٹ ID، انتظامی انضمامی کوڈ خود بھرتا ہے۔
  • licentivoProductID / licentivo_product_id: Licentivo لائسنس پروڈکٹ ID، عوامی دستخطی ترتیب سے ملنا ضروری۔
  • trustedKeys / trusted_keys: دستخطی کلید ID اور عوامی کلید کا نقشہ، سرکاری SDK کے دستخط شدہ حقوق جانچنے کے لیے۔
  • environment: sandbox یا live؛ اکاؤنٹ، پروڈکٹ اور کیش ایک ماحول میں رکھیں۔
واپسی قدر
Launch

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

Launch.login
login(String email, char[] password) → State
مقصد
اسٹور اکاؤنٹ سے لاگ ان، مختصر شناختی تصدیق حاصل اور سرکاری اجازت SDK شروع کرتا ہے۔
پیرامیٹر
  • email, password: اس اسٹور کے صارف کی ای میل اور پاس ورڈ؛ صرف اس لاگ ان کے لیے استعمال کریں۔
واپسی قدر
State

اکاؤنٹ حالت لوٹاتا ہے؛ نیچے فیلڈ جدول دیکھیں۔

Launch.restore
restore() → State
مقصد
محفوظ سیشن پڑھ کر اکاؤنٹ کی آن لائن تصدیق، نیا شناختی ثبوت حاصل اور سرکاری SDK شروع کرتا ہے۔
واپسی قدر
State

اکاؤنٹ حالت لوٹاتا ہے؛ ErrNoSession یا NO_SESSION محفوظ سیشن نہ ہونا ہے۔ دوسری خطائیں الگ سنبھالیں۔

Launch.runFeature
runFeature(String feature, Client.FeatureAction action) → void
مقصد
سرکاری SDK ہر عمل پر اجازت جانچتا ہے؛ کال بیک صرف اجازت ملنے پر چلتا ہے۔
پیرامیٹر
  • feature / name, action / block: فنکشن نام پالیسی سے ملے؛ کال بیک میں اصل محفوظ کاروباری کوڈ ہو۔
واپسی قدر
void

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Launch.logout
logout() → void
مقصد
مقامی اجازت روکتا، سرکاری SDK سے نکلتا، پھر Launch سیشن منسوخ کرتا ہے۔ نامکمل دور کی کارروائیاں دوبارہ کوشش کے لیے محفوظ رہتی ہیں۔
واپسی قدر
void

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Launch.releaseDevice
releaseDevice() → void
مقصد
واضح لاگ آؤٹ کا مطابقتی راستہ؛ Logout جیسا اکاؤنٹ اور ڈیوائس اخراج انجام دیتا ہے۔
واپسی قدر
void

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Launch.close
close() → void
مقصد
یہ انسٹینس اور پس منظر کام روکتا ہے، محفوظ لاگ ان اور ڈیوائس ربط برقرار رہتے ہیں۔
واپسی قدر
void

کاروباری قدر نہیں؛ معمول کا بند ہونا اکاؤنٹ اخراج یا ڈیوائس رہائی کی تصدیق نہیں۔

اعلیٰ اور مطابقتی API

Launch
new Launch(Config config, Map<String,Object> product, Path cacheRoot [, Store store, Transport transport, RuntimeFactory factory, Sleeper sleeper]) → Launch
مقصد
عوامی ترتیبات جانچ کر ایپ بناتا ہے؛ ابھی لاگ ان یا محفوظ فنکشن کی اجازت نہیں ملتی۔
پیرامیٹر
  • config, product: ترتیب، رن ٹائم اڈاپٹر، ٹرانسپورٹ یا درخواست آبجیکٹ، صرف اعلیٰ انضمام کے لیے۔
  • cacheRoot: منتخب ترتیب راستے یا موجودہ صارف کا نجی کیش اور اسٹوریج فولڈر۔
  • store, transport, factory, sleeper: سیشن اسٹوریج، نجی کیش، منسوخی، دوبارہ کوشش یا اعلیٰ اجزا کے اختیار۔
واپسی قدر
Launch

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

Launch.Config
new Launch.Config(String merchantOrigin, String launchProductID, String licentivoProductID, String environment) → Config
مقصد
عوامی ترتیبات پڑھتا یا جانچتا ہے؛ پروڈکٹ، ماحول اور دستخطی کلیدیں ملنی چاہییں۔
پیرامیٹر
  • merchantOrigin / origin: موجودہ اسٹور کا مکمل اصل پتہ، پروٹوکول اور ضروری پورٹ سمیت؛ پیداوار میں HTTPS۔
  • productID / product_id: Launch اسٹور پروڈکٹ ID، انتظامی انضمامی کوڈ خود بھرتا ہے۔
  • licentivoProductID / licentivo_product_id: Licentivo لائسنس پروڈکٹ ID، عوامی دستخطی ترتیب سے ملنا ضروری۔
  • environment: sandbox یا live؛ اکاؤنٹ، پروڈکٹ اور کیش ایک ماحول میں رکھیں۔
واپسی قدر
Config

دستخط میں بیان کردہ قسم کی قدر لوٹاتا ہے؛ اس سے فنکشن اجازت نہیں ملتی۔

Launch.Config.load
Launch.Config.load(Path path) → Config
مقصد
عوامی ترتیبات پڑھتا یا جانچتا ہے؛ پروڈکٹ، ماحول اور دستخطی کلیدیں ملنی چاہییں۔
پیرامیٹر
  • path: منتخب ترتیب راستے یا موجودہ صارف کا نجی کیش اور اسٹوریج فولڈر۔
واپسی قدر
Config

دستخط میں بیان کردہ قسم کی قدر لوٹاتا ہے؛ اس سے فنکشن اجازت نہیں ملتی۔

Launch.readPublic
Launch.readPublic(Path path) → Map<String,Object>
مقصد
عوامی ترتیبات پڑھتا یا جانچتا ہے؛ پروڈکٹ، ماحول اور دستخطی کلیدیں ملنی چاہییں۔
پیرامیٹر
  • path: منتخب ترتیب راستے یا موجودہ صارف کا نجی کیش اور اسٹوریج فولڈر۔
واپسی قدر
Map<String,Object>

دستخط میں بیان کردہ قسم کی قدر لوٹاتا ہے؛ اس سے فنکشن اجازت نہیں ملتی۔

Launch.MemoryStore
new Launch.MemoryStore() → MemoryStore
مقصد
صرف موجودہ عمل تک مؤثر سیشن اسٹوریج بناتا ہے۔
واپسی قدر
MemoryStore

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

EncryptedFileStore
new EncryptedFileStore(Path directory, SecretKey vaultKey) → EncryptedFileStore
مقصد
محفوظ مستقل سیشن اسٹوریج بناتا ہے؛ خفیہ کاری کی کلید نظام کے اسناد والٹ سے لیں۔
پیرامیٹر
  • directory: منتخب ترتیب راستے یا موجودہ صارف کا نجی کیش اور اسٹوریج فولڈر۔
  • vaultKey: نظام کے اسناد والٹ سے خفیہ کاری کلید؛ خفیہ ریکارڈ کے ساتھ نہ رکھیں۔
واپسی قدر
EncryptedFileStore

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

Launch.HTTPTransport.request
request(String method, URI uri, String bearer, byte[] body) → Response
مقصد
اکاؤنٹ HTTP درخواست بھیج کر حالت، ہیڈر یا خام متن لوٹاتا ہے؛ اجازت کا فیصلہ نہیں کرتا۔
پیرامیٹر
  • method, uri, bearer, body: ترتیب، رن ٹائم اڈاپٹر، ٹرانسپورٹ یا درخواست آبجیکٹ، صرف اعلیٰ انضمام کے لیے۔
واپسی قدر
Response

دستخط میں بیان کردہ قسم کی قدر لوٹاتا ہے؛ اس سے فنکشن اجازت نہیں ملتی۔

Launch.Failure
new Launch.Failure(String code [, int status, String requestID, long retryAfterMillis, boolean transport]) → Failure
مقصد
درجہ بندی، انتظار اور تشخیصی ربط کے لیے منظم خطا بناتا یا پڑھتا ہے۔
پیرامیٹر
  • code, status, requestID, retryAfterMillis, transport: درجہ بندی، انتظار اور تشخیصی ربط کے لیے منظم خطا بناتا یا پڑھتا ہے۔
واپسی قدر
Failure

دستخط میں بیان کردہ قسم کی قدر لوٹاتا ہے؛ اس سے فنکشن اجازت نہیں ملتی۔

Launch.Failure.unavailable
unavailable() → boolean
مقصد
عارضی سروس عدم دستیابی پہچانتا ہے؛ یہ آف لائن اجازت نہیں دیتا۔
واپسی قدر
boolean

بولین درجہ بندی لوٹاتا ہے، اجازت نہیں۔

Store.load / MemoryStore.load / EncryptedFileStore.load
load(String scope) → byte[] | null
مقصد
الگ کلید سے اکاؤنٹ ریکارڈ پڑھتا ہے؛ اس میں راز ہیں، صرف SDK کو دیں۔
پیرامیٹر
  • scope / key, value / record: SDK کی الگ کلیدیں اور خفیہ ریکارڈ؛ حسب ضرورت اسٹوریج متعدد کلیدیں اور ایٹمی تبدیلی سنبھالے۔
واپسی قدر
byte[] | null

خفیہ ریکارڈ لوٹاتا ہے؛ غیر موجود ہو تو زبان کے مطابق خالی قدر یا ErrNoSession۔

Store.save / MemoryStore.save / EncryptedFileStore.save
save(String scope, byte[] secret) → void
مقصد
الگ کلید کے تحت اکاؤنٹ ریکارڈ ایٹمی طور پر محفوظ کرتا ہے۔
پیرامیٹر
  • scope / key, value / record: SDK کی الگ کلیدیں اور خفیہ ریکارڈ؛ حسب ضرورت اسٹوریج متعدد کلیدیں اور ایٹمی تبدیلی سنبھالے۔
واپسی قدر
void

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Store.delete / MemoryStore.delete / EncryptedFileStore.delete
delete(String scope) → void
مقصد
اکاؤنٹ ریکارڈ حذف کرتا ہے، سرکاری SDK کی اجازت کیش یا اخراج جرنل نہیں۔
پیرامیٹر
  • scope / key, value / record: SDK کی الگ کلیدیں اور خفیہ ریکارڈ؛ حسب ضرورت اسٹوریج متعدد کلیدیں اور ایٹمی تبدیلی سنبھالے۔
واپسی قدر
void

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Runtime.canStartOffline
canStartOffline() → boolean
مقصد
سرکاری SDK کی موجودہ اجازت حالت پڑھتا ہے؛ لاگ ان یا فی فنکشن جانچ کا بدل نہیں۔
واپسی قدر
boolean

بولین درجہ بندی لوٹاتا ہے، اجازت نہیں۔

Runtime.start
start() → void
مقصد
سرکاری SDK کی جانچ اور پس منظر دیکھ بھال شروع کرتا ہے؛ لاگ ان اور فنکشن حفاظت الگ API ہیں۔
واپسی قدر
void

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Runtime.runFeature
runFeature(String feature, Client.FeatureAction action) → void
مقصد
سرکاری SDK ہر عمل پر اجازت جانچتا ہے؛ کال بیک صرف اجازت ملنے پر چلتا ہے۔
پیرامیٹر
  • feature / name, action / block: فنکشن نام پالیسی سے ملے؛ کال بیک میں اصل محفوظ کاروباری کوڈ ہو۔
واپسی قدر
void

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Runtime.releaseDevice
releaseDevice() → void
مقصد
سرکاری SDK کا ڈیوائس اخراج کرتا ہے؛ ایپ Launch اکاؤنٹ سیشن الگ منسوخ کرتی ہے۔
واپسی قدر
void

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Runtime.close
close() → void
مقصد
یہ انسٹینس اور پس منظر کام روکتا ہے، محفوظ لاگ ان اور ڈیوائس ربط برقرار رہتے ہیں۔
واپسی قدر
void

کاروباری قدر نہیں؛ معمول کا بند ہونا اکاؤنٹ اخراج یا ڈیوائس رہائی کی تصدیق نہیں۔

RuntimeFactory.create
create(Map<String,Object> settings) → Runtime
مقصد
اعلیٰ انضمام کے لیے سرکاری SDK اڈاپٹر بناتا ہے؛ شناختی ثبوت صرف میموری میں دیا جاتا ہے۔
پیرامیٹر
  • settings: ترتیب، رن ٹائم اڈاپٹر، ٹرانسپورٹ یا درخواست آبجیکٹ، صرف اعلیٰ انضمام کے لیے۔
واپسی قدر
Runtime

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

Sleeper.sleep
sleep(long milliseconds) → void
مقصد
اعلیٰ دوبارہ کوشش کے نظام کے لیے مقررہ مدت انتظار کرتا ہے۔
پیرامیٹر
  • milliseconds: تجویز کردہ انتظار؛ زبان کے مطابق سیکنڈ، ملی سیکنڈ یا Duration پہچانیں۔
واپسی قدر
void

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

JavaScript / TypeScript

متعلقہ سورس · v0.1.6 · index.d.ts · index.mjs

خطائیں اور ناکامیاں: await Promise; catch (error); LaunchError(code, status, retryAfterSeconds)

Application.connect
Application.connect(merchantOrigin, productID, licentivoProductID, trustedKeys, options?) → Application
مقصد
عوامی ترتیبات جانچ کر ایپ بناتا ہے؛ ابھی لاگ ان یا محفوظ فنکشن کی اجازت نہیں ملتی۔
پیرامیٹر
  • merchantOrigin / origin: موجودہ اسٹور کا مکمل اصل پتہ، پروٹوکول اور ضروری پورٹ سمیت؛ پیداوار میں HTTPS۔
  • productID / product_id: Launch اسٹور پروڈکٹ ID، انتظامی انضمامی کوڈ خود بھرتا ہے۔
  • licentivoProductID / licentivo_product_id: Licentivo لائسنس پروڈکٹ ID، عوامی دستخطی ترتیب سے ملنا ضروری۔
  • trustedKeys / trusted_keys: دستخطی کلید ID اور عوامی کلید کا نقشہ، سرکاری SDK کے دستخط شدہ حقوق جانچنے کے لیے۔
  • environment: sandbox یا live؛ اکاؤنٹ، پروڈکٹ اور کیش ایک ماحول میں رکھیں۔
  • options / config: سیشن اسٹوریج، نجی کیش، منسوخی، دوبارہ کوشش یا اعلیٰ اجزا کے اختیار۔
واپسی قدر
Application

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

Application.login
login(email: string, password: string, options?: {signal?: AbortSignal}) → Promise<SessionState>
مقصد
اسٹور اکاؤنٹ سے لاگ ان، مختصر شناختی تصدیق حاصل اور سرکاری اجازت SDK شروع کرتا ہے۔
پیرامیٹر
  • email, password: اس اسٹور کے صارف کی ای میل اور پاس ورڈ؛ صرف اس لاگ ان کے لیے استعمال کریں۔
  • ctx / ct / signal / cancellation: درخواست سیاق یا منسوخی سگنل؛ Go لائف سائیکل سیاق پس منظر کام بھی چلاتا ہے۔
واپسی قدر
Promise<SessionState>

اکاؤنٹ حالت لوٹاتا ہے؛ نیچے فیلڈ جدول دیکھیں۔

Application.restore
restore(options?: {signal?: AbortSignal}) → Promise<SessionState | null>
مقصد
محفوظ سیشن پڑھ کر اکاؤنٹ کی آن لائن تصدیق، نیا شناختی ثبوت حاصل اور سرکاری SDK شروع کرتا ہے۔
پیرامیٹر
  • ctx / ct / signal / cancellation: درخواست سیاق یا منسوخی سگنل؛ Go لائف سائیکل سیاق پس منظر کام بھی چلاتا ہے۔
واپسی قدر
Promise<SessionState | null>

اکاؤنٹ حالت لوٹاتا ہے؛ null یا nil قابل بحالی سیشن نہ ہونا ہے۔ دیگر ناکامیاں خطا بنتی ہیں۔

Application.runFeature
runFeature<T>(name: string, action: () => T | Promise<T>) → Promise<T>
مقصد
سرکاری SDK ہر عمل پر اجازت جانچتا ہے؛ کال بیک صرف اجازت ملنے پر چلتا ہے۔
پیرامیٹر
  • feature / name, action / block: فنکشن نام پالیسی سے ملے؛ کال بیک میں اصل محفوظ کاروباری کوڈ ہو۔
واپسی قدر
Promise<T>

کاروباری کال بیک کا نتیجہ لوٹاتا ہے؛ اجازت ناکامی یا کاروباری استثنا خطا ہے۔

Application.logout
logout(options?: {signal?: AbortSignal}) → Promise<boolean>
مقصد
مقامی اجازت روکتا، سرکاری SDK سے نکلتا، پھر Launch سیشن منسوخ کرتا ہے۔ نامکمل دور کی کارروائیاں دوبارہ کوشش کے لیے محفوظ رہتی ہیں۔
پیرامیٹر
  • ctx / ct / signal / cancellation: درخواست سیاق یا منسوخی سگنل؛ Go لائف سائیکل سیاق پس منظر کام بھی چلاتا ہے۔
واپسی قدر
Promise<boolean>

true لاگ آؤٹ کی تصدیق ہے؛ false دور کے اکاؤنٹ اخراج یا ڈیوائس منسوخی کا زیر التوا ہونا ہے۔ اسٹوریج بھی خطا دے سکتا ہے۔

Application.releaseDevice
releaseDevice(options?: {signal?: AbortSignal}) → Promise<void>
مقصد
واضح لاگ آؤٹ کا مطابقتی راستہ؛ Logout جیسا اکاؤنٹ اور ڈیوائس اخراج انجام دیتا ہے۔
پیرامیٹر
  • ctx / ct / signal / cancellation: درخواست سیاق یا منسوخی سگنل؛ Go لائف سائیکل سیاق پس منظر کام بھی چلاتا ہے۔
واپسی قدر
Promise<void>

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Application.close
close() → Promise<void>
مقصد
یہ انسٹینس اور پس منظر کام روکتا ہے، محفوظ لاگ ان اور ڈیوائس ربط برقرار رہتے ہیں۔
واپسی قدر
Promise<void>

کاروباری قدر نہیں؛ معمول کا بند ہونا اکاؤنٹ اخراج یا ڈیوائس رہائی کی تصدیق نہیں۔

اعلیٰ اور مطابقتی API

Application
new Application(launch: LaunchConfig, product: PublicProductConfig, options?: Options) → Application
مقصد
عوامی ترتیبات جانچ کر ایپ بناتا ہے؛ ابھی لاگ ان یا محفوظ فنکشن کی اجازت نہیں ملتی۔
پیرامیٹر
  • launch, product: ترتیب، رن ٹائم اڈاپٹر، ٹرانسپورٹ یا درخواست آبجیکٹ، صرف اعلیٰ انضمام کے لیے۔
  • options / config: سیشن اسٹوریج، نجی کیش، منسوخی، دوبارہ کوشش یا اعلیٰ اجزا کے اختیار۔
واپسی قدر
Application

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

Application.fromFiles
Application.fromFiles(launchPath: string, productPath: string, options?: Options) → Promise<Application>
مقصد
دو موجودہ عوامی ترتیب فائلیں پڑھ کر پروڈکٹ مطابقت جانچتا اور ایپ بناتا ہے۔ براہ راست کنکشن کو فائل درکار نہیں۔
پیرامیٹر
  • launchPath, productPath: منتخب ترتیب راستے یا موجودہ صارف کا نجی کیش اور اسٹوریج فولڈر۔
  • options / config: سیشن اسٹوریج، نجی کیش، منسوخی، دوبارہ کوشش یا اعلیٰ اجزا کے اختیار۔
واپسی قدر
Promise<Application>

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

validateConfig
validateConfig(launch: LaunchConfig, product: PublicProductConfig) → {launch: LaunchConfig, product: PublicProductConfig}
مقصد
عوامی ترتیبات پڑھتا یا جانچتا ہے؛ پروڈکٹ، ماحول اور دستخطی کلیدیں ملنی چاہییں۔
پیرامیٹر
  • launch, product: ترتیب، رن ٹائم اڈاپٹر، ٹرانسپورٹ یا درخواست آبجیکٹ، صرف اعلیٰ انضمام کے لیے۔
واپسی قدر
{launch: LaunchConfig, product: PublicProductConfig}

دستخط میں بیان کردہ قسم کی قدر لوٹاتا ہے؛ اس سے فنکشن اجازت نہیں ملتی۔

loadConfig
loadConfig(launchPath: string, productPath: string) → Promise<{launch: LaunchConfig, product: PublicProductConfig}>
مقصد
عوامی ترتیبات پڑھتا یا جانچتا ہے؛ پروڈکٹ، ماحول اور دستخطی کلیدیں ملنی چاہییں۔
پیرامیٹر
  • launchPath, productPath: منتخب ترتیب راستے یا موجودہ صارف کا نجی کیش اور اسٹوریج فولڈر۔
واپسی قدر
Promise<{launch: LaunchConfig, product: PublicProductConfig}>

دستخط میں بیان کردہ قسم کی قدر لوٹاتا ہے؛ اس سے فنکشن اجازت نہیں ملتی۔

defaultTransport
defaultTransport(request: Request) → Promise<Response>
مقصد
اکاؤنٹ HTTP درخواست بھیج کر حالت، ہیڈر یا خام متن لوٹاتا ہے؛ اجازت کا فیصلہ نہیں کرتا۔
پیرامیٹر
  • request: ترتیب، رن ٹائم اڈاپٹر، ٹرانسپورٹ یا درخواست آبجیکٹ، صرف اعلیٰ انضمام کے لیے۔
واپسی قدر
Promise<Response>

دستخط میں بیان کردہ قسم کی قدر لوٹاتا ہے؛ اس سے فنکشن اجازت نہیں ملتی۔

MemoryStore
new MemoryStore() → MemoryStore
مقصد
صرف موجودہ عمل تک مؤثر سیشن اسٹوریج بناتا ہے۔
واپسی قدر
MemoryStore

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

EncryptedFileStore
new EncryptedFileStore(directory: string, key: Uint8Array) → EncryptedFileStore
مقصد
محفوظ مستقل سیشن اسٹوریج بناتا ہے؛ خفیہ کاری کی کلید نظام کے اسناد والٹ سے لیں۔
پیرامیٹر
  • directory: منتخب ترتیب راستے یا موجودہ صارف کا نجی کیش اور اسٹوریج فولڈر۔
  • key: نظام کے اسناد والٹ سے خفیہ کاری کلید؛ خفیہ ریکارڈ کے ساتھ نہ رکھیں۔
واپسی قدر
EncryptedFileStore

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

LaunchError
new LaunchError(code: string, status=0, retryAfterSeconds=0) → LaunchError
مقصد
درجہ بندی، انتظار اور تشخیصی ربط کے لیے منظم خطا بناتا یا پڑھتا ہے۔
پیرامیٹر
  • code, status, retryAfterSeconds: درجہ بندی، انتظار اور تشخیصی ربط کے لیے منظم خطا بناتا یا پڑھتا ہے۔
واپسی قدر
LaunchError

دستخط میں بیان کردہ قسم کی قدر لوٹاتا ہے؛ اس سے فنکشن اجازت نہیں ملتی۔

SessionStore.load / MemoryStore.load / EncryptedFileStore.load
load(scope: string) → Promise<SavedSession | null>
مقصد
الگ کلید سے اکاؤنٹ ریکارڈ پڑھتا ہے؛ اس میں راز ہیں، صرف SDK کو دیں۔
پیرامیٹر
  • scope / key, value / record: SDK کی الگ کلیدیں اور خفیہ ریکارڈ؛ حسب ضرورت اسٹوریج متعدد کلیدیں اور ایٹمی تبدیلی سنبھالے۔
واپسی قدر
Promise<SavedSession | null>

خفیہ ریکارڈ لوٹاتا ہے؛ غیر موجود ہو تو زبان کے مطابق خالی قدر یا ErrNoSession۔

SessionStore.save / MemoryStore.save / EncryptedFileStore.save
save(scope: string, value: SavedSession) → Promise<void>
مقصد
الگ کلید کے تحت اکاؤنٹ ریکارڈ ایٹمی طور پر محفوظ کرتا ہے۔
پیرامیٹر
  • scope / key, value / record: SDK کی الگ کلیدیں اور خفیہ ریکارڈ؛ حسب ضرورت اسٹوریج متعدد کلیدیں اور ایٹمی تبدیلی سنبھالے۔
واپسی قدر
Promise<void>

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

SessionStore.delete / MemoryStore.delete / EncryptedFileStore.delete
delete(scope: string) → Promise<void>
مقصد
اکاؤنٹ ریکارڈ حذف کرتا ہے، سرکاری SDK کی اجازت کیش یا اخراج جرنل نہیں۔
پیرامیٹر
  • scope / key, value / record: SDK کی الگ کلیدیں اور خفیہ ریکارڈ؛ حسب ضرورت اسٹوریج متعدد کلیدیں اور ایٹمی تبدیلی سنبھالے۔
واپسی قدر
Promise<void>

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Runtime.status
status() → {allowed:boolean,state:string} | Promise<{allowed:boolean,state:string}>
مقصد
سرکاری SDK کی موجودہ اجازت حالت پڑھتا ہے؛ لاگ ان یا فی فنکشن جانچ کا بدل نہیں۔
واپسی قدر
{allowed:boolean,state:string} | Promise<{allowed:boolean,state:string}>

سرکاری SDK کی موجودہ اجازت حالت پڑھتا ہے؛ لاگ ان یا فی فنکشن جانچ کا بدل نہیں۔

Runtime.start
start(onError?: (error: unknown) => void, signal?: AbortSignal) → Promise<unknown>
مقصد
سرکاری SDK کی جانچ اور پس منظر دیکھ بھال شروع کرتا ہے؛ لاگ ان اور فنکشن حفاظت الگ API ہیں۔
پیرامیٹر
  • onError: درجہ بندی، انتظار اور تشخیصی ربط کے لیے منظم خطا بناتا یا پڑھتا ہے۔
  • ctx / ct / signal / cancellation: درخواست سیاق یا منسوخی سگنل؛ Go لائف سائیکل سیاق پس منظر کام بھی چلاتا ہے۔
واپسی قدر
Promise<unknown>

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Runtime.runFeature
runFeature<T>(name: string, action: () => T | Promise<T>) → Promise<T>
مقصد
سرکاری SDK ہر عمل پر اجازت جانچتا ہے؛ کال بیک صرف اجازت ملنے پر چلتا ہے۔
پیرامیٹر
  • feature / name, action / block: فنکشن نام پالیسی سے ملے؛ کال بیک میں اصل محفوظ کاروباری کوڈ ہو۔
واپسی قدر
Promise<T>

کاروباری کال بیک کا نتیجہ لوٹاتا ہے؛ اجازت ناکامی یا کاروباری استثنا خطا ہے۔

Runtime.deactivate
deactivate(signal?: AbortSignal) → Promise<unknown>
مقصد
سرکاری SDK کا ڈیوائس اخراج کرتا ہے؛ ایپ Launch اکاؤنٹ سیشن الگ منسوخ کرتی ہے۔
پیرامیٹر
  • ctx / ct / signal / cancellation: درخواست سیاق یا منسوخی سگنل؛ Go لائف سائیکل سیاق پس منظر کام بھی چلاتا ہے۔
واپسی قدر
Promise<unknown>

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Runtime.logout
logout?(signal?: AbortSignal) → Promise<{local_complete:boolean,revocation_pending:boolean,storage_error?:string}>
مقصد
سرکاری SDK کا ڈیوائس اخراج کرتا ہے؛ ایپ Launch اکاؤنٹ سیشن الگ منسوخ کرتی ہے۔
پیرامیٹر
  • ctx / ct / signal / cancellation: درخواست سیاق یا منسوخی سگنل؛ Go لائف سائیکل سیاق پس منظر کام بھی چلاتا ہے۔
واپسی قدر
Promise<{local_complete:boolean,revocation_pending:boolean,storage_error?:string}>

مقامی اخراج اور دور کی منسوخی الگ ہیں۔ زیر التوا کام اور اسٹوریج ناکامی سنبھالیں، SDK جرنل محفوظ رکھیں۔

Runtime.close
close() → Promise<unknown>
مقصد
یہ انسٹینس اور پس منظر کام روکتا ہے، محفوظ لاگ ان اور ڈیوائس ربط برقرار رہتے ہیں۔
واپسی قدر
Promise<unknown>

کاروباری قدر نہیں؛ معمول کا بند ہونا اکاؤنٹ اخراج یا ڈیوائس رہائی کی تصدیق نہیں۔

Rust

متعلقہ سورس · v0.1.6 · lib.rs · store.rs · transport.rs

خطائیں اور ناکامیاں: Result<T, Failure>: Ok(value) / Err(Failure {code, status, request_id, retry_after, transport})

Application::connect
Application::connect(origin: &str, product_id: &str, licentivo_product_id: &str, trusted_keys: &[(&str,&str)], environment: &str) → Result<Application, Failure>
مقصد
عوامی ترتیبات جانچ کر ایپ بناتا ہے؛ ابھی لاگ ان یا محفوظ فنکشن کی اجازت نہیں ملتی۔
پیرامیٹر
  • merchantOrigin / origin: موجودہ اسٹور کا مکمل اصل پتہ، پروٹوکول اور ضروری پورٹ سمیت؛ پیداوار میں HTTPS۔
  • productID / product_id: Launch اسٹور پروڈکٹ ID، انتظامی انضمامی کوڈ خود بھرتا ہے۔
  • licentivoProductID / licentivo_product_id: Licentivo لائسنس پروڈکٹ ID، عوامی دستخطی ترتیب سے ملنا ضروری۔
  • trustedKeys / trusted_keys: دستخطی کلید ID اور عوامی کلید کا نقشہ، سرکاری SDK کے دستخط شدہ حقوق جانچنے کے لیے۔
  • environment: sandbox یا live؛ اکاؤنٹ، پروڈکٹ اور کیش ایک ماحول میں رکھیں۔
واپسی قدر
Result<Application, Failure>

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

Application::login
login(&mut self, email: &str, password: &str) → Result<State, Failure>
مقصد
اسٹور اکاؤنٹ سے لاگ ان، مختصر شناختی تصدیق حاصل اور سرکاری اجازت SDK شروع کرتا ہے۔
پیرامیٹر
  • email, password: اس اسٹور کے صارف کی ای میل اور پاس ورڈ؛ صرف اس لاگ ان کے لیے استعمال کریں۔
واپسی قدر
Result<State, Failure>

اکاؤنٹ حالت لوٹاتا ہے؛ نیچے فیلڈ جدول دیکھیں۔

Application::restore
restore(&mut self) → Result<State, Failure>
مقصد
محفوظ سیشن پڑھ کر اکاؤنٹ کی آن لائن تصدیق، نیا شناختی ثبوت حاصل اور سرکاری SDK شروع کرتا ہے۔
واپسی قدر
Result<State, Failure>

اکاؤنٹ حالت لوٹاتا ہے؛ ErrNoSession یا NO_SESSION محفوظ سیشن نہ ہونا ہے۔ دوسری خطائیں الگ سنبھالیں۔

Application::run_feature
run_feature<T,F: FnOnce() -> Result<T,Failure>>(&mut self, feature: &str, action: F) → Result<T, Failure>
مقصد
سرکاری SDK ہر عمل پر اجازت جانچتا ہے؛ کال بیک صرف اجازت ملنے پر چلتا ہے۔
پیرامیٹر
  • feature / name, action / block: فنکشن نام پالیسی سے ملے؛ کال بیک میں اصل محفوظ کاروباری کوڈ ہو۔
واپسی قدر
Result<T, Failure>

کاروباری کال بیک کا نتیجہ لوٹاتا ہے؛ اجازت ناکامی یا کاروباری استثنا خطا ہے۔

Application::logout
logout(&mut self) → Result<(), Failure>
مقصد
مقامی اجازت روکتا، سرکاری SDK سے نکلتا، پھر Launch سیشن منسوخ کرتا ہے۔ نامکمل دور کی کارروائیاں دوبارہ کوشش کے لیے محفوظ رہتی ہیں۔
واپسی قدر
Result<(), Failure>

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Application::release_device
release_device(&mut self) → Result<(), Failure>
مقصد
واضح لاگ آؤٹ کا مطابقتی راستہ؛ Logout جیسا اکاؤنٹ اور ڈیوائس اخراج انجام دیتا ہے۔
واپسی قدر
Result<(), Failure>

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Application::close / Drop
close(&mut self) / drop(&mut self) → ()
مقصد
یہ انسٹینس اور پس منظر کام روکتا ہے، محفوظ لاگ ان اور ڈیوائس ربط برقرار رہتے ہیں۔
واپسی قدر
()

کاروباری قدر نہیں؛ معمول کا بند ہونا اکاؤنٹ اخراج یا ڈیوائس رہائی کی تصدیق نہیں۔

اعلیٰ اور مطابقتی API

Application::new
Application::new(config: Config, product: Value, cache_root: PathBuf) → Result<Application, Failure>
مقصد
عوامی ترتیبات جانچ کر ایپ بناتا ہے؛ ابھی لاگ ان یا محفوظ فنکشن کی اجازت نہیں ملتی۔
پیرامیٹر
  • config, product: ترتیب، رن ٹائم اڈاپٹر، ٹرانسپورٹ یا درخواست آبجیکٹ، صرف اعلیٰ انضمام کے لیے۔
  • cache_root: منتخب ترتیب راستے یا موجودہ صارف کا نجی کیش اور اسٹوریج فولڈر۔
واپسی قدر
Result<Application, Failure>

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

Application::with_components
Application::with_components(config: Config, product: Value, cache_root: PathBuf, store: Box<dyn Store>, transport: Box<dyn Transport>, factory: Box<dyn RuntimeFactory>, sleeper: Box<dyn Sleeper>) → Result<Application, Failure>
مقصد
عوامی ترتیبات جانچ کر ایپ بناتا ہے؛ ابھی لاگ ان یا محفوظ فنکشن کی اجازت نہیں ملتی۔
پیرامیٹر
  • config, product: ترتیب، رن ٹائم اڈاپٹر، ٹرانسپورٹ یا درخواست آبجیکٹ، صرف اعلیٰ انضمام کے لیے۔
  • cache_root: منتخب ترتیب راستے یا موجودہ صارف کا نجی کیش اور اسٹوریج فولڈر۔
  • store, transport, factory, sleeper: سیشن اسٹوریج، نجی کیش، منسوخی، دوبارہ کوشش یا اعلیٰ اجزا کے اختیار۔
واپسی قدر
Result<Application, Failure>

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

Config::new
Config::new(origin: &str, product: &str, runtime_product: &str, environment: &str) → Result<Config, Failure>
مقصد
عوامی ترتیبات پڑھتا یا جانچتا ہے؛ پروڈکٹ، ماحول اور دستخطی کلیدیں ملنی چاہییں۔
پیرامیٹر
  • merchantOrigin / origin: موجودہ اسٹور کا مکمل اصل پتہ، پروٹوکول اور ضروری پورٹ سمیت؛ پیداوار میں HTTPS۔
  • productID / product_id: Launch اسٹور پروڈکٹ ID، انتظامی انضمامی کوڈ خود بھرتا ہے۔
  • licentivoProductID / licentivo_product_id: Licentivo لائسنس پروڈکٹ ID، عوامی دستخطی ترتیب سے ملنا ضروری۔
  • environment: sandbox یا live؛ اکاؤنٹ، پروڈکٹ اور کیش ایک ماحول میں رکھیں۔
واپسی قدر
Result<Config, Failure>

دستخط میں بیان کردہ قسم کی قدر لوٹاتا ہے؛ اس سے فنکشن اجازت نہیں ملتی۔

Config::load
Config::load(path: impl AsRef<Path>) → Result<Config, Failure>
مقصد
عوامی ترتیبات پڑھتا یا جانچتا ہے؛ پروڈکٹ، ماحول اور دستخطی کلیدیں ملنی چاہییں۔
پیرامیٹر
  • path: منتخب ترتیب راستے یا موجودہ صارف کا نجی کیش اور اسٹوریج فولڈر۔
واپسی قدر
Result<Config, Failure>

دستخط میں بیان کردہ قسم کی قدر لوٹاتا ہے؛ اس سے فنکشن اجازت نہیں ملتی۔

read_public
read_public(path: impl AsRef<Path>) → Result<Value, Failure>
مقصد
عوامی ترتیبات پڑھتا یا جانچتا ہے؛ پروڈکٹ، ماحول اور دستخطی کلیدیں ملنی چاہییں۔
پیرامیٹر
  • path: منتخب ترتیب راستے یا موجودہ صارف کا نجی کیش اور اسٹوریج فولڈر۔
واپسی قدر
Result<Value, Failure>

دستخط میں بیان کردہ قسم کی قدر لوٹاتا ہے؛ اس سے فنکشن اجازت نہیں ملتی۔

MemoryStore::default
MemoryStore::default() → MemoryStore
مقصد
صرف موجودہ عمل تک مؤثر سیشن اسٹوریج بناتا ہے۔
واپسی قدر
MemoryStore

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

EncryptedFileStore::new
EncryptedFileStore::new(root: PathBuf, vault_key: [u8;32]) → Result<EncryptedFileStore, Failure>
مقصد
محفوظ مستقل سیشن اسٹوریج بناتا ہے؛ خفیہ کاری کی کلید نظام کے اسناد والٹ سے لیں۔
پیرامیٹر
  • root: منتخب ترتیب راستے یا موجودہ صارف کا نجی کیش اور اسٹوریج فولڈر۔
  • vault_key: نظام کے اسناد والٹ سے خفیہ کاری کلید؛ خفیہ ریکارڈ کے ساتھ نہ رکھیں۔
واپسی قدر
Result<EncryptedFileStore, Failure>

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

CurlTransport::new
CurlTransport::new() → Result<CurlTransport, Failure>
مقصد
اکاؤنٹ HTTP درخواست بھیج کر حالت، ہیڈر یا خام متن لوٹاتا ہے؛ اجازت کا فیصلہ نہیں کرتا۔
واپسی قدر
Result<CurlTransport, Failure>

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

CurlTransport::request
request(&mut self, method: &str, url: &str, bearer: &str, body: &[u8]) → Result<Response, Failure>
مقصد
اکاؤنٹ HTTP درخواست بھیج کر حالت، ہیڈر یا خام متن لوٹاتا ہے؛ اجازت کا فیصلہ نہیں کرتا۔
پیرامیٹر
  • method, url, bearer, body: ترتیب، رن ٹائم اڈاپٹر، ٹرانسپورٹ یا درخواست آبجیکٹ، صرف اعلیٰ انضمام کے لیے۔
واپسی قدر
Result<Response, Failure>

دستخط میں بیان کردہ قسم کی قدر لوٹاتا ہے؛ اس سے فنکشن اجازت نہیں ملتی۔

Failure::new
Failure::new(code: &str) → Failure
مقصد
درجہ بندی، انتظار اور تشخیصی ربط کے لیے منظم خطا بناتا یا پڑھتا ہے۔
پیرامیٹر
  • code: درجہ بندی، انتظار اور تشخیصی ربط کے لیے منظم خطا بناتا یا پڑھتا ہے۔
واپسی قدر
Failure

دستخط میں بیان کردہ قسم کی قدر لوٹاتا ہے؛ اس سے فنکشن اجازت نہیں ملتی۔

ThreadSleeper::sleep
sleep(&mut self, duration: Duration) → Result<(), Failure>
مقصد
اعلیٰ دوبارہ کوشش کے نظام کے لیے مقررہ مدت انتظار کرتا ہے۔
پیرامیٹر
  • duration: تجویز کردہ انتظار؛ زبان کے مطابق سیکنڈ، ملی سیکنڈ یا Duration پہچانیں۔
واپسی قدر
Result<(), Failure>

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Store::load / MemoryStore::load / EncryptedFileStore::load
load(&mut self, scope: &str) → Result<Option<Vec<u8>>, Failure>
مقصد
الگ کلید سے اکاؤنٹ ریکارڈ پڑھتا ہے؛ اس میں راز ہیں، صرف SDK کو دیں۔
پیرامیٹر
  • scope / key, value / record: SDK کی الگ کلیدیں اور خفیہ ریکارڈ؛ حسب ضرورت اسٹوریج متعدد کلیدیں اور ایٹمی تبدیلی سنبھالے۔
واپسی قدر
Result<Option<Vec<u8>>, Failure>

خفیہ ریکارڈ لوٹاتا ہے؛ غیر موجود ہو تو زبان کے مطابق خالی قدر یا ErrNoSession۔

Store::save / MemoryStore::save / EncryptedFileStore::save
save(&mut self, scope: &str, value: &[u8]) → Result<(), Failure>
مقصد
الگ کلید کے تحت اکاؤنٹ ریکارڈ ایٹمی طور پر محفوظ کرتا ہے۔
پیرامیٹر
  • scope / key, value / record: SDK کی الگ کلیدیں اور خفیہ ریکارڈ؛ حسب ضرورت اسٹوریج متعدد کلیدیں اور ایٹمی تبدیلی سنبھالے۔
واپسی قدر
Result<(), Failure>

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Store::delete / MemoryStore::delete / EncryptedFileStore::delete
delete(&mut self, scope: &str) → Result<(), Failure>
مقصد
اکاؤنٹ ریکارڈ حذف کرتا ہے، سرکاری SDK کی اجازت کیش یا اخراج جرنل نہیں۔
پیرامیٹر
  • scope / key, value / record: SDK کی الگ کلیدیں اور خفیہ ریکارڈ؛ حسب ضرورت اسٹوریج متعدد کلیدیں اور ایٹمی تبدیلی سنبھالے۔
واپسی قدر
Result<(), Failure>

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Runtime::run_feature
run_feature(&mut self, feature: &str, action: &mut dyn FnMut() -> Result<(),Failure>) → Result<(), Failure>
مقصد
سرکاری SDK ہر عمل پر اجازت جانچتا ہے؛ کال بیک صرف اجازت ملنے پر چلتا ہے۔
پیرامیٹر
  • feature / name, action / block: فنکشن نام پالیسی سے ملے؛ کال بیک میں اصل محفوظ کاروباری کوڈ ہو۔
واپسی قدر
Result<(), Failure>

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Runtime::release_device
release_device(&mut self) → Result<(), Failure>
مقصد
سرکاری SDK کا ڈیوائس اخراج کرتا ہے؛ ایپ Launch اکاؤنٹ سیشن الگ منسوخ کرتی ہے۔
واپسی قدر
Result<(), Failure>

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Runtime::close
close(&mut self) → ()
مقصد
یہ انسٹینس اور پس منظر کام روکتا ہے، محفوظ لاگ ان اور ڈیوائس ربط برقرار رہتے ہیں۔
واپسی قدر
()

کاروباری قدر نہیں؛ معمول کا بند ہونا اکاؤنٹ اخراج یا ڈیوائس رہائی کی تصدیق نہیں۔

RuntimeFactory::open / OfficialRuntimeFactory::open
open(&mut self, settings: &Value, cached_only: bool) → Result<Box<dyn Runtime>, Failure>
مقصد
اعلیٰ انضمام کے لیے سرکاری SDK اڈاپٹر بناتا ہے؛ شناختی ثبوت صرف میموری میں دیا جاتا ہے۔
پیرامیٹر
  • settings, cached_only: ترتیب، رن ٹائم اڈاپٹر، ٹرانسپورٹ یا درخواست آبجیکٹ، صرف اعلیٰ انضمام کے لیے۔
واپسی قدر
Result<Box<dyn Runtime>, Failure>

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

RuntimeFactory::for_logout / OfficialRuntimeFactory::for_logout
for_logout(&mut self, settings: &Value) → Result<Box<dyn Runtime>, Failure>
مقصد
اعلیٰ انضمام کے لیے سرکاری SDK اڈاپٹر بناتا ہے؛ شناختی ثبوت صرف میموری میں دیا جاتا ہے۔
پیرامیٹر
  • settings: ترتیب، رن ٹائم اڈاپٹر، ٹرانسپورٹ یا درخواست آبجیکٹ، صرف اعلیٰ انضمام کے لیے۔
واپسی قدر
Result<Box<dyn Runtime>, Failure>

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

Sleeper::sleep
sleep(&mut self, duration: Duration) → Result<(), Failure>
مقصد
اعلیٰ دوبارہ کوشش کے نظام کے لیے مقررہ مدت انتظار کرتا ہے۔
پیرامیٹر
  • duration: تجویز کردہ انتظار؛ زبان کے مطابق سیکنڈ، ملی سیکنڈ یا Duration پہچانیں۔
واپسی قدر
Result<(), Failure>

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Ruby

متعلقہ سورس · v0.1.6 · licentivo_launch.rb

خطائیں اور ناکامیاں: rescue LicentivoLaunch::Error; code / status / retry_after_seconds; callback exceptions

Application.connect
LicentivoLaunch::Application.connect(merchant_origin, product_id, licentivo_product_id, trusted_keys, environment: "live", **options) → Application
مقصد
عوامی ترتیبات جانچ کر ایپ بناتا ہے؛ ابھی لاگ ان یا محفوظ فنکشن کی اجازت نہیں ملتی۔
پیرامیٹر
  • merchantOrigin / origin: موجودہ اسٹور کا مکمل اصل پتہ، پروٹوکول اور ضروری پورٹ سمیت؛ پیداوار میں HTTPS۔
  • productID / product_id: Launch اسٹور پروڈکٹ ID، انتظامی انضمامی کوڈ خود بھرتا ہے۔
  • licentivoProductID / licentivo_product_id: Licentivo لائسنس پروڈکٹ ID، عوامی دستخطی ترتیب سے ملنا ضروری۔
  • trustedKeys / trusted_keys: دستخطی کلید ID اور عوامی کلید کا نقشہ، سرکاری SDK کے دستخط شدہ حقوق جانچنے کے لیے۔
  • environment: sandbox یا live؛ اکاؤنٹ، پروڈکٹ اور کیش ایک ماحول میں رکھیں۔
  • options / config: سیشن اسٹوریج، نجی کیش، منسوخی، دوبارہ کوشش یا اعلیٰ اجزا کے اختیار۔
واپسی قدر
Application

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

Application#login
login(email, password, cancellation: nil) → Hash
مقصد
اسٹور اکاؤنٹ سے لاگ ان، مختصر شناختی تصدیق حاصل اور سرکاری اجازت SDK شروع کرتا ہے۔
پیرامیٹر
  • email, password: اس اسٹور کے صارف کی ای میل اور پاس ورڈ؛ صرف اس لاگ ان کے لیے استعمال کریں۔
  • ctx / ct / signal / cancellation: درخواست سیاق یا منسوخی سگنل؛ Go لائف سائیکل سیاق پس منظر کام بھی چلاتا ہے۔
واپسی قدر
Hash

اکاؤنٹ حالت لوٹاتا ہے؛ نیچے فیلڈ جدول دیکھیں۔

Application#restore
restore(cancellation: nil) → Hash | nil
مقصد
محفوظ سیشن پڑھ کر اکاؤنٹ کی آن لائن تصدیق، نیا شناختی ثبوت حاصل اور سرکاری SDK شروع کرتا ہے۔
پیرامیٹر
  • ctx / ct / signal / cancellation: درخواست سیاق یا منسوخی سگنل؛ Go لائف سائیکل سیاق پس منظر کام بھی چلاتا ہے۔
واپسی قدر
Hash | nil

اکاؤنٹ حالت لوٹاتا ہے؛ null یا nil قابل بحالی سیشن نہ ہونا ہے۔ دیگر ناکامیاں خطا بنتی ہیں۔

Application#run_feature
run_feature(feature) { ... } → T
مقصد
سرکاری SDK ہر عمل پر اجازت جانچتا ہے؛ کال بیک صرف اجازت ملنے پر چلتا ہے۔
پیرامیٹر
  • feature / name, action / block: فنکشن نام پالیسی سے ملے؛ کال بیک میں اصل محفوظ کاروباری کوڈ ہو۔
واپسی قدر
T

کاروباری کال بیک کا نتیجہ لوٹاتا ہے؛ اجازت ناکامی یا کاروباری استثنا خطا ہے۔

Application#logout
logout(cancellation: nil) → true | false
مقصد
مقامی اجازت روکتا، سرکاری SDK سے نکلتا، پھر Launch سیشن منسوخ کرتا ہے۔ نامکمل دور کی کارروائیاں دوبارہ کوشش کے لیے محفوظ رہتی ہیں۔
پیرامیٹر
  • ctx / ct / signal / cancellation: درخواست سیاق یا منسوخی سگنل؛ Go لائف سائیکل سیاق پس منظر کام بھی چلاتا ہے۔
واپسی قدر
true | false

true لاگ آؤٹ کی تصدیق ہے؛ false دور کے اکاؤنٹ اخراج یا ڈیوائس منسوخی کا زیر التوا ہونا ہے۔ اسٹوریج بھی خطا دے سکتا ہے۔

Application#release_device
release_device(cancellation: nil) → true | false
مقصد
واضح لاگ آؤٹ کا مطابقتی راستہ؛ Logout جیسا اکاؤنٹ اور ڈیوائس اخراج انجام دیتا ہے۔
پیرامیٹر
  • ctx / ct / signal / cancellation: درخواست سیاق یا منسوخی سگنل؛ Go لائف سائیکل سیاق پس منظر کام بھی چلاتا ہے۔
واپسی قدر
true | false

true لاگ آؤٹ کی تصدیق ہے؛ false دور کے اکاؤنٹ اخراج یا ڈیوائس منسوخی کا زیر التوا ہونا ہے۔ اسٹوریج بھی خطا دے سکتا ہے۔

Application#close
close → nil
مقصد
یہ انسٹینس اور پس منظر کام روکتا ہے، محفوظ لاگ ان اور ڈیوائس ربط برقرار رہتے ہیں۔
واپسی قدر
nil

کاروباری قدر نہیں؛ معمول کا بند ہونا اکاؤنٹ اخراج یا ڈیوائس رہائی کی تصدیق نہیں۔

اعلیٰ اور مطابقتی API

Application.new
Application.new(launch, product, store: MemoryStore.new, transport: nil, runtime_factory: nil, cache_dir: nil, sleep: nil, pending_attempts: 5) → Application
مقصد
عوامی ترتیبات جانچ کر ایپ بناتا ہے؛ ابھی لاگ ان یا محفوظ فنکشن کی اجازت نہیں ملتی۔
پیرامیٹر
  • launch, product: ترتیب، رن ٹائم اڈاپٹر، ٹرانسپورٹ یا درخواست آبجیکٹ، صرف اعلیٰ انضمام کے لیے۔
  • options / config: سیشن اسٹوریج، نجی کیش، منسوخی، دوبارہ کوشش یا اعلیٰ اجزا کے اختیار۔
واپسی قدر
Application

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

Application.from_files
Application.from_files(launch_path, product_path, **options) → Application
مقصد
دو موجودہ عوامی ترتیب فائلیں پڑھ کر پروڈکٹ مطابقت جانچتا اور ایپ بناتا ہے۔ براہ راست کنکشن کو فائل درکار نہیں۔
پیرامیٹر
  • launchPath, productPath: منتخب ترتیب راستے یا موجودہ صارف کا نجی کیش اور اسٹوریج فولڈر۔
  • options / config: سیشن اسٹوریج، نجی کیش، منسوخی، دوبارہ کوشش یا اعلیٰ اجزا کے اختیار۔
واپسی قدر
Application

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

LicentivoLaunch.origin
LicentivoLaunch.origin(value, environment) → String
مقصد
عوامی ترتیبات پڑھتا یا جانچتا ہے؛ پروڈکٹ، ماحول اور دستخطی کلیدیں ملنی چاہییں۔
پیرامیٹر
  • value: موجودہ اسٹور کا مکمل اصل پتہ، پروٹوکول اور ضروری پورٹ سمیت؛ پیداوار میں HTTPS۔
  • environment: sandbox یا live؛ اکاؤنٹ، پروڈکٹ اور کیش ایک ماحول میں رکھیں۔
واپسی قدر
String

دستخط میں بیان کردہ قسم کی قدر لوٹاتا ہے؛ اس سے فنکشن اجازت نہیں ملتی۔

LicentivoLaunch.validate_config
LicentivoLaunch.validate_config(launch, product) → [Hash, Hash]
مقصد
عوامی ترتیبات پڑھتا یا جانچتا ہے؛ پروڈکٹ، ماحول اور دستخطی کلیدیں ملنی چاہییں۔
پیرامیٹر
  • launch, product: ترتیب، رن ٹائم اڈاپٹر، ٹرانسپورٹ یا درخواست آبجیکٹ، صرف اعلیٰ انضمام کے لیے۔
واپسی قدر
[Hash, Hash]

دستخط میں بیان کردہ قسم کی قدر لوٹاتا ہے؛ اس سے فنکشن اجازت نہیں ملتی۔

LicentivoLaunch.load_config
LicentivoLaunch.load_config(launch_path, product_path) → [Hash, Hash]
مقصد
عوامی ترتیبات پڑھتا یا جانچتا ہے؛ پروڈکٹ، ماحول اور دستخطی کلیدیں ملنی چاہییں۔
پیرامیٹر
  • launchPath, productPath: منتخب ترتیب راستے یا موجودہ صارف کا نجی کیش اور اسٹوریج فولڈر۔
واپسی قدر
[Hash, Hash]

دستخط میں بیان کردہ قسم کی قدر لوٹاتا ہے؛ اس سے فنکشن اجازت نہیں ملتی۔

LicentivoLaunch.default_transport
LicentivoLaunch.default_transport(request) → Hash
مقصد
اکاؤنٹ HTTP درخواست بھیج کر حالت، ہیڈر یا خام متن لوٹاتا ہے؛ اجازت کا فیصلہ نہیں کرتا۔
پیرامیٹر
  • request: ترتیب، رن ٹائم اڈاپٹر، ٹرانسپورٹ یا درخواست آبجیکٹ، صرف اعلیٰ انضمام کے لیے۔
واپسی قدر
Hash

دستخط میں بیان کردہ قسم کی قدر لوٹاتا ہے؛ اس سے فنکشن اجازت نہیں ملتی۔

MemoryStore.new
MemoryStore.new → MemoryStore
مقصد
صرف موجودہ عمل تک مؤثر سیشن اسٹوریج بناتا ہے۔
واپسی قدر
MemoryStore

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

EncryptedFileStore.new
EncryptedFileStore.new(directory, key) → EncryptedFileStore
مقصد
محفوظ مستقل سیشن اسٹوریج بناتا ہے؛ خفیہ کاری کی کلید نظام کے اسناد والٹ سے لیں۔
پیرامیٹر
  • directory: منتخب ترتیب راستے یا موجودہ صارف کا نجی کیش اور اسٹوریج فولڈر۔
  • key: نظام کے اسناد والٹ سے خفیہ کاری کلید؛ خفیہ ریکارڈ کے ساتھ نہ رکھیں۔
واپسی قدر
EncryptedFileStore

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

MemoryStore#persistent? / EncryptedFileStore#persistent? / #secure?
persistent? / secure? → true | false
مقصد
عوامی ترتیبات پڑھتا یا جانچتا ہے؛ پروڈکٹ، ماحول اور دستخطی کلیدیں ملنی چاہییں۔
واپسی قدر
true | false

بولین درجہ بندی لوٹاتا ہے، اجازت نہیں۔

EncryptedFileStore#path
path(scope) → String
مقصد
عوامی ترتیبات پڑھتا یا جانچتا ہے؛ پروڈکٹ، ماحول اور دستخطی کلیدیں ملنی چاہییں۔
پیرامیٹر
  • scope: SDK کی الگ کلیدیں اور خفیہ ریکارڈ؛ حسب ضرورت اسٹوریج متعدد کلیدیں اور ایٹمی تبدیلی سنبھالے۔
واپسی قدر
String

دستخط میں بیان کردہ قسم کی قدر لوٹاتا ہے؛ اس سے فنکشن اجازت نہیں ملتی۔

CancellationToken#cancel / #check!
CancellationToken.new.cancel / check! → true / nil
مقصد
تعاونی منسوخی کی درخواست یا جانچ کرتا ہے؛ منسوخی اجازت کی کامیابی نہیں۔
واپسی قدر
true / nil

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Error.new
Error.new(code, status: 0, retry_after_seconds: 0) → Error
مقصد
درجہ بندی، انتظار اور تشخیصی ربط کے لیے منظم خطا بناتا یا پڑھتا ہے۔
پیرامیٹر
  • code, status, retry_after_seconds: درجہ بندی، انتظار اور تشخیصی ربط کے لیے منظم خطا بناتا یا پڑھتا ہے۔
واپسی قدر
Error

دستخط میں بیان کردہ قسم کی قدر لوٹاتا ہے؛ اس سے فنکشن اجازت نہیں ملتی۔

MemoryStore#load / EncryptedFileStore#load
load(scope) → Hash | nil
مقصد
الگ کلید سے اکاؤنٹ ریکارڈ پڑھتا ہے؛ اس میں راز ہیں، صرف SDK کو دیں۔
پیرامیٹر
  • scope / key, value / record: SDK کی الگ کلیدیں اور خفیہ ریکارڈ؛ حسب ضرورت اسٹوریج متعدد کلیدیں اور ایٹمی تبدیلی سنبھالے۔
واپسی قدر
Hash | nil

خفیہ ریکارڈ لوٹاتا ہے؛ غیر موجود ہو تو زبان کے مطابق خالی قدر یا ErrNoSession۔

MemoryStore#save / EncryptedFileStore#save
save(scope, record) → Object
مقصد
الگ کلید کے تحت اکاؤنٹ ریکارڈ ایٹمی طور پر محفوظ کرتا ہے۔
پیرامیٹر
  • scope / key, value / record: SDK کی الگ کلیدیں اور خفیہ ریکارڈ؛ حسب ضرورت اسٹوریج متعدد کلیدیں اور ایٹمی تبدیلی سنبھالے۔
واپسی قدر
Object

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

MemoryStore#delete / EncryptedFileStore#delete
delete(scope) → Object
مقصد
اکاؤنٹ ریکارڈ حذف کرتا ہے، سرکاری SDK کی اجازت کیش یا اخراج جرنل نہیں۔
پیرامیٹر
  • scope / key, value / record: SDK کی الگ کلیدیں اور خفیہ ریکارڈ؛ حسب ضرورت اسٹوریج متعدد کلیدیں اور ایٹمی تبدیلی سنبھالے۔
واپسی قدر
Object

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

C

متعلقہ سورس · v0.1.6 · account.h · account.c

خطائیں اور ناکامیاں: NULL / 0 / -1; launch_application_error(app); action(context): 1=success, 0=failure

launch_application_connect
launch_application_connect(origin, product_id, licentivo_product_id, trusted_keys_json, environment, remember, store) → launch_application *
مقصد
عوامی ترتیبات جانچ کر ایپ بناتا ہے؛ ابھی لاگ ان یا محفوظ فنکشن کی اجازت نہیں ملتی۔
پیرامیٹر
  • merchantOrigin / origin: موجودہ اسٹور کا مکمل اصل پتہ، پروٹوکول اور ضروری پورٹ سمیت؛ پیداوار میں HTTPS۔
  • productID / product_id: Launch اسٹور پروڈکٹ ID، انتظامی انضمامی کوڈ خود بھرتا ہے۔
  • licentivoProductID / licentivo_product_id: Licentivo لائسنس پروڈکٹ ID، عوامی دستخطی ترتیب سے ملنا ضروری۔
  • trustedKeys / trusted_keys: دستخطی کلید ID اور عوامی کلید کا نقشہ، سرکاری SDK کے دستخط شدہ حقوق جانچنے کے لیے۔
  • environment: sandbox یا live؛ اکاؤنٹ، پروڈکٹ اور کیش ایک ماحول میں رکھیں۔
  • remember, store: سیشن اسٹوریج، نجی کیش، منسوخی، دوبارہ کوشش یا اعلیٰ اجزا کے اختیار۔
واپسی قدر
launch_application *

اپنی ملکیت کا ایپ پوائنٹر لوٹاتا ہے؛ NULL ابتدا کی ناکامی ہے۔ close سے آزاد کریں۔

launch_application_login
launch_application_login(launch_application *app, const char *email, const char *password) → int
مقصد
اسٹور اکاؤنٹ سے لاگ ان، مختصر شناختی تصدیق حاصل اور سرکاری اجازت SDK شروع کرتا ہے۔
پیرامیٹر
  • email, password: اس اسٹور کے صارف کی ای میل اور پاس ورڈ؛ صرف اس لاگ ان کے لیے استعمال کریں۔
واپسی قدر
int

1 کامیابی، 0 ناکامی ہے۔ ناکامی کے بعد خطا کوڈ پڑھیں۔

launch_application_restore
launch_application_restore(launch_application *app) → int
مقصد
محفوظ سیشن پڑھ کر اکاؤنٹ کی آن لائن تصدیق، نیا شناختی ثبوت حاصل اور سرکاری SDK شروع کرتا ہے۔
واپسی قدر
int

1 بحالی، 0 کوئی سیشن نہیں، -1 انکار یا ناکامی ہے۔ ناکامی پر خطا کوڈ پڑھیں۔

launch_application_run_feature
launch_application_run_feature(app, feature, ln_feature_action action, void *context) → int
مقصد
سرکاری SDK ہر عمل پر اجازت جانچتا ہے؛ کال بیک صرف اجازت ملنے پر چلتا ہے۔
پیرامیٹر
  • feature / name, action / block: فنکشن نام پالیسی سے ملے؛ کال بیک میں اصل محفوظ کاروباری کوڈ ہو۔
  • context: ترتیب، رن ٹائم اڈاپٹر، ٹرانسپورٹ یا درخواست آبجیکٹ، صرف اعلیٰ انضمام کے لیے۔
واپسی قدر
int

1 کامیابی، 0 ناکامی ہے۔ ناکامی کے بعد خطا کوڈ پڑھیں۔

launch_application_logout
launch_application_logout(launch_application *app) → int
مقصد
مقامی اجازت روکتا، سرکاری SDK سے نکلتا، پھر Launch سیشن منسوخ کرتا ہے۔ نامکمل دور کی کارروائیاں دوبارہ کوشش کے لیے محفوظ رہتی ہیں۔
واپسی قدر
int

1 کامیابی، 0 ناکامی ہے۔ ناکامی کے بعد خطا کوڈ پڑھیں۔

launch_application_release_device
launch_application_release_device(launch_application *app) → int
مقصد
واضح لاگ آؤٹ کا مطابقتی راستہ؛ Logout جیسا اکاؤنٹ اور ڈیوائس اخراج انجام دیتا ہے۔
واپسی قدر
int

1 کامیابی، 0 ناکامی ہے۔ ناکامی کے بعد خطا کوڈ پڑھیں۔

launch_application_status
launch_application_status(launch_application *app) → char *
مقصد
سرکاری SDK کی موجودہ اجازت حالت پڑھتا ہے؛ لاگ ان یا فی فنکشن جانچ کا بدل نہیں۔
واپسی قدر
char *

اپنی ملکیت کا JSON متن لوٹاتا ہے؛ ln_free_string سے آزاد کریں۔ رن ٹائم نہ ہو تو login_required اور allowed=false۔

launch_application_error
launch_application_error(const launch_application *app) → const char *
مقصد
درجہ بندی، انتظار اور تشخیصی ربط کے لیے منظم خطا بناتا یا پڑھتا ہے۔
واپسی قدر
const char *

عارضی مستعار خطا کوڈ متن لوٹاتا ہے؛ آزاد نہ کریں یا ایپ ختم ہونے پر استعمال نہ کریں۔

launch_application_close
launch_application_close(launch_application *app) → void
مقصد
یہ انسٹینس اور پس منظر کام روکتا ہے، محفوظ لاگ ان اور ڈیوائس ربط برقرار رہتے ہیں۔
واپسی قدر
void

کاروباری قدر نہیں؛ معمول کا بند ہونا اکاؤنٹ اخراج یا ڈیوائس رہائی کی تصدیق نہیں۔

اعلیٰ اور مطابقتی API

launch_application_open
launch_application_open(origin, product_id, product_config_path, environment, remember, store) → launch_application *
مقصد
دو موجودہ عوامی ترتیب فائلیں پڑھ کر پروڈکٹ مطابقت جانچتا اور ایپ بناتا ہے۔ براہ راست کنکشن کو فائل درکار نہیں۔
پیرامیٹر
  • origin: موجودہ اسٹور کا مکمل اصل پتہ، پروٹوکول اور ضروری پورٹ سمیت؛ پیداوار میں HTTPS۔
  • product_id: Launch اسٹور پروڈکٹ ID، انتظامی انضمامی کوڈ خود بھرتا ہے۔
  • product_config_path: منتخب ترتیب راستے یا موجودہ صارف کا نجی کیش اور اسٹوریج فولڈر۔
  • environment: sandbox یا live؛ اکاؤنٹ، پروڈکٹ اور کیش ایک ماحول میں رکھیں۔
  • remember, store: سیشن اسٹوریج، نجی کیش، منسوخی، دوبارہ کوشش یا اعلیٰ اجزا کے اختیار۔
واپسی قدر
launch_application *

اپنی ملکیت کا ایپ پوائنٹر لوٹاتا ہے؛ NULL ابتدا کی ناکامی ہے۔ close سے آزاد کریں۔

launch_application_from_files
launch_application_from_files(launch_config_path, product_config_path, remember, store) → launch_application *
مقصد
دو موجودہ عوامی ترتیب فائلیں پڑھ کر پروڈکٹ مطابقت جانچتا اور ایپ بناتا ہے۔ براہ راست کنکشن کو فائل درکار نہیں۔
پیرامیٹر
  • launchPath, productPath: منتخب ترتیب راستے یا موجودہ صارف کا نجی کیش اور اسٹوریج فولڈر۔
  • remember, store: سیشن اسٹوریج، نجی کیش، منسوخی، دوبارہ کوشش یا اعلیٰ اجزا کے اختیار۔
واپسی قدر
launch_application *

اپنی ملکیت کا ایپ پوائنٹر لوٹاتا ہے؛ NULL ابتدا کی ناکامی ہے۔ close سے آزاد کریں۔

launch_application_cli
launch_application_cli(int argc, char **argv) → launch_application *
مقصد
دو موجودہ عوامی ترتیب فائلیں پڑھ کر پروڈکٹ مطابقت جانچتا اور ایپ بناتا ہے۔ براہ راست کنکشن کو فائل درکار نہیں۔
پیرامیٹر
  • argc, argv: ترتیب، رن ٹائم اڈاپٹر، ٹرانسپورٹ یا درخواست آبجیکٹ، صرف اعلیٰ انضمام کے لیے۔
واپسی قدر
launch_application *

اپنی ملکیت کا ایپ پوائنٹر لوٹاتا ہے؛ NULL ابتدا کی ناکامی ہے۔ close سے آزاد کریں۔

launch_login / launch_sign_in
launch_login(account, origin, product_id, config_path, environment, email, password) / launch_sign_in(account, argc, argv) → int
مقصد
پرانی API برقرار ہے؛ طویل لائسنس اسناد کا پروٹوکول ہٹ چکا، اس لیے کال ناکام ہوتی ہے۔ Application استعمال کریں۔
پیرامیٹر
  • account, origin, product_id, config_path, environment, email, password, argc, argv: ترتیب، رن ٹائم اڈاپٹر، ٹرانسپورٹ یا درخواست آبجیکٹ، صرف اعلیٰ انضمام کے لیے۔
واپسی قدر
int

ہمیشہ ناکام؛ اکاؤنٹ شناخت کے تبادلے پر منتقل ہوں۔

launch_sign_out
launch_sign_out(launch_account *account, int clear_cache) → void
مقصد
یہ انسٹینس اور پس منظر کام روکتا ہے، محفوظ لاگ ان اور ڈیوائس ربط برقرار رہتے ہیں۔
پیرامیٹر
  • account, clear_cache: ترتیب، رن ٹائم اڈاپٹر، ٹرانسپورٹ یا درخواست آبجیکٹ، صرف اعلیٰ انضمام کے لیے۔
واپسی قدر
void

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

ln_free_string
ln_free_string(char *value) → void
مقصد
یہ انسٹینس اور پس منظر کام روکتا ہے، محفوظ لاگ ان اور ڈیوائس ربط برقرار رہتے ہیں۔
پیرامیٹر
  • value: اپنی ملکیت کا JSON متن لوٹاتا ہے؛ ln_free_string سے آزاد کریں۔ رن ٹائم نہ ہو تو login_required اور allowed=false۔
واپسی قدر
void

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

launch_secret_store.load
load(void *context, const char *scope, char **record) → int
مقصد
الگ کلید سے اکاؤنٹ ریکارڈ پڑھتا ہے؛ اس میں راز ہیں، صرف SDK کو دیں۔
پیرامیٹر
  • context: ترتیب، رن ٹائم اڈاپٹر، ٹرانسپورٹ یا درخواست آبجیکٹ، صرف اعلیٰ انضمام کے لیے۔
  • scope, record: SDK کی الگ کلیدیں اور خفیہ ریکارڈ؛ حسب ضرورت اسٹوریج متعدد کلیدیں اور ایٹمی تبدیلی سنبھالے۔
واپسی قدر
int

1 ریکارڈ ملا، 0 نہیں ملا، -1 پڑھنے میں ناکامی۔ load ریکارڈ کی میموری بناتا اور کالر آزاد کرتا ہے۔

launch_secret_store.save
save(void *context, const char *scope, const char *record) → int (1: success, 0: failure)
مقصد
الگ کلید کے تحت اکاؤنٹ ریکارڈ ایٹمی طور پر محفوظ کرتا ہے۔
پیرامیٹر
  • context: ترتیب، رن ٹائم اڈاپٹر، ٹرانسپورٹ یا درخواست آبجیکٹ، صرف اعلیٰ انضمام کے لیے۔
  • scope, record: SDK کی الگ کلیدیں اور خفیہ ریکارڈ؛ حسب ضرورت اسٹوریج متعدد کلیدیں اور ایٹمی تبدیلی سنبھالے۔
واپسی قدر
int (1: success, 0: failure)

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

launch_secret_store.remove
remove(void *context, const char *scope) → int (1: success, 0: failure)
مقصد
اکاؤنٹ ریکارڈ حذف کرتا ہے، سرکاری SDK کی اجازت کیش یا اخراج جرنل نہیں۔
پیرامیٹر
  • context: ترتیب، رن ٹائم اڈاپٹر، ٹرانسپورٹ یا درخواست آبجیکٹ، صرف اعلیٰ انضمام کے لیے۔
  • scope: SDK کی الگ کلیدیں اور خفیہ ریکارڈ؛ حسب ضرورت اسٹوریج متعدد کلیدیں اور ایٹمی تبدیلی سنبھالے۔
واپسی قدر
int (1: success, 0: failure)

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

C++

متعلقہ سورس · v0.1.6 · launch.hpp

خطائیں اور ناکامیاں: std::runtime_error; callback exceptions propagate; RAII; Status(): std::string JSON

Application::Connect
Application::Connect(origin, product, licentivo_product, trusted_keys_json, environment="live", remember=false, store=nullptr) → Application
مقصد
عوامی ترتیبات جانچ کر ایپ بناتا ہے؛ ابھی لاگ ان یا محفوظ فنکشن کی اجازت نہیں ملتی۔
پیرامیٹر
  • merchantOrigin / origin: موجودہ اسٹور کا مکمل اصل پتہ، پروٹوکول اور ضروری پورٹ سمیت؛ پیداوار میں HTTPS۔
  • productID / product_id: Launch اسٹور پروڈکٹ ID، انتظامی انضمامی کوڈ خود بھرتا ہے۔
  • licentivoProductID / licentivo_product_id: Licentivo لائسنس پروڈکٹ ID، عوامی دستخطی ترتیب سے ملنا ضروری۔
  • trustedKeys / trusted_keys: دستخطی کلید ID اور عوامی کلید کا نقشہ، سرکاری SDK کے دستخط شدہ حقوق جانچنے کے لیے۔
  • environment: sandbox یا live؛ اکاؤنٹ، پروڈکٹ اور کیش ایک ماحول میں رکھیں۔
  • remember, store: سیشن اسٹوریج، نجی کیش، منسوخی، دوبارہ کوشش یا اعلیٰ اجزا کے اختیار۔
واپسی قدر
Application

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

Application::Login
Login(const char *email, const char *password) → void
مقصد
اسٹور اکاؤنٹ سے لاگ ان، مختصر شناختی تصدیق حاصل اور سرکاری اجازت SDK شروع کرتا ہے۔
پیرامیٹر
  • email, password: اس اسٹور کے صارف کی ای میل اور پاس ورڈ؛ صرف اس لاگ ان کے لیے استعمال کریں۔
واپسی قدر
void

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Application::Restore
Restore() → bool
مقصد
محفوظ سیشن پڑھ کر اکاؤنٹ کی آن لائن تصدیق، نیا شناختی ثبوت حاصل اور سرکاری SDK شروع کرتا ہے۔
واپسی قدر
bool

true بحالی کی کامیابی اور false قابل بحالی سیشن نہ ہونا ہے۔ انکار، میعاد یا نیٹ ورک کی ناکامی خطا ہے۔

Application::RunFeature
RunFeature(const char *feature, Action action) → void
مقصد
سرکاری SDK ہر عمل پر اجازت جانچتا ہے؛ کال بیک صرف اجازت ملنے پر چلتا ہے۔
پیرامیٹر
  • feature / name, action / block: فنکشن نام پالیسی سے ملے؛ کال بیک میں اصل محفوظ کاروباری کوڈ ہو۔
واپسی قدر
void

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Application::Logout
Logout() → void
مقصد
مقامی اجازت روکتا، سرکاری SDK سے نکلتا، پھر Launch سیشن منسوخ کرتا ہے۔ نامکمل دور کی کارروائیاں دوبارہ کوشش کے لیے محفوظ رہتی ہیں۔
واپسی قدر
void

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Application::ReleaseDevice
ReleaseDevice() → void
مقصد
واضح لاگ آؤٹ کا مطابقتی راستہ؛ Logout جیسا اکاؤنٹ اور ڈیوائس اخراج انجام دیتا ہے۔
واپسی قدر
void

کاروباری قدر واپس نہیں؛ معمول کی تکمیل کامیابی، خطا یا استثنا ناکامی ہے۔

Application::Status
Status() → std::string (JSON)
مقصد
سرکاری SDK کی موجودہ اجازت حالت پڑھتا ہے؛ لاگ ان یا فی فنکشن جانچ کا بدل نہیں۔
واپسی قدر
std::string (JSON)

سرکاری SDK کی موجودہ اجازت حالت پڑھتا ہے؛ لاگ ان یا فی فنکشن جانچ کا بدل نہیں۔

Application::~Application
~Application() → void
مقصد
یہ انسٹینس اور پس منظر کام روکتا ہے، محفوظ لاگ ان اور ڈیوائس ربط برقرار رہتے ہیں۔
واپسی قدر
void

کاروباری قدر نہیں؛ معمول کا بند ہونا اکاؤنٹ اخراج یا ڈیوائس رہائی کی تصدیق نہیں۔

اعلیٰ اور مطابقتی API

Application
Application(origin, product, config, environment="live", remember=false, store=nullptr) → Application
مقصد
دو موجودہ عوامی ترتیب فائلیں پڑھ کر پروڈکٹ مطابقت جانچتا اور ایپ بناتا ہے۔ براہ راست کنکشن کو فائل درکار نہیں۔
پیرامیٹر
  • origin: موجودہ اسٹور کا مکمل اصل پتہ، پروٹوکول اور ضروری پورٹ سمیت؛ پیداوار میں HTTPS۔
  • product: Launch اسٹور پروڈکٹ ID، انتظامی انضمامی کوڈ خود بھرتا ہے۔
  • config: منتخب ترتیب راستے یا موجودہ صارف کا نجی کیش اور اسٹوریج فولڈر۔
  • environment: sandbox یا live؛ اکاؤنٹ، پروڈکٹ اور کیش ایک ماحول میں رکھیں۔
  • remember, store: سیشن اسٹوریج، نجی کیش، منسوخی، دوبارہ کوشش یا اعلیٰ اجزا کے اختیار۔
واپسی قدر
Application

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

Application(launch_application *)
explicit Application(launch_application *app) → Application
مقصد
عوامی ترتیبات جانچ کر ایپ بناتا ہے؛ ابھی لاگ ان یا محفوظ فنکشن کی اجازت نہیں ملتی۔
پیرامیٹر
  • app: اپنی ملکیت کا ایپ پوائنٹر لوٹاتا ہے؛ NULL ابتدا کی ناکامی ہے۔ close سے آزاد کریں۔
واپسی قدر
Application

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

Application::FromFiles
Application::FromFiles(launch, product, remember=false, store=nullptr) → Application
مقصد
دو موجودہ عوامی ترتیب فائلیں پڑھ کر پروڈکٹ مطابقت جانچتا اور ایپ بناتا ہے۔ براہ راست کنکشن کو فائل درکار نہیں۔
پیرامیٹر
  • launch, product: منتخب ترتیب راستے یا موجودہ صارف کا نجی کیش اور اسٹوریج فولڈر۔
  • remember, store: سیشن اسٹوریج، نجی کیش، منسوخی، دوبارہ کوشش یا اعلیٰ اجزا کے اختیار۔
واپسی قدر
Application

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

Application(Application&&) / operator=
Application(Application&& other) / operator=(Application&& other) → Application / Application&
مقصد
مقامی ایپ کی ملکیت منتقل کرتا ہے۔ نقل بند ہے اور اصل آبجیکٹ اب پوائنٹر کا مالک نہیں۔
پیرامیٹر
  • other: ترتیب، رن ٹائم اڈاپٹر، ٹرانسپورٹ یا درخواست آبجیکٹ، صرف اعلیٰ انضمام کے لیے۔
واپسی قدر
Application / Application&

بنایا گیا آبجیکٹ لوٹاتا ہے؛ ابتدا بذات خود اجازت نہیں۔

واپس آنے والی فیلڈز

اکاؤنٹ حالت لوٹاتا ہے؛ نیچے فیلڈ جدول دیکھیں۔

فیلڈقسممقصد
Go State.User.ID · JS user.id · Java userID · Rust user_id · Ruby user.idstringاسٹور اکاؤنٹ کی منفرد ID، پروڈکٹ، لائسنس یا ڈیوائس ID نہیں۔
Go User.Email · JS user.email · Java/Rust/Ruby emailstringاسٹور اکاؤنٹ ای میل؛ بعض زبانوں کی حالت صرف اکاؤنٹ ID رکھتی ہے۔
Go User.Verified / user.verifiedbooleanکیا اسٹور ای میل تصدیق شدہ ہے؛ یہ سافٹ ویئر اجازت کی حالت نہیں۔
JS user.display_namestring (optional)اسٹور اکاؤنٹ کا نمایشی نام؛ سرور نہ دے تو یہ فیلڈ نہیں ہوتی۔
Go State/Session.ExpiresAt · JS expiresAt · Java expiresAt · Rust/Ruby expires_attime.Time / ISO 8601 / InstantLaunch اکاؤنٹ سیشن کی میعاد، خرید یا آف لائن اجازت کی میعاد نہیں۔
Java offlineFallback · Rust offline_fallbackboolean = falseمطابقتی فیلڈ؛ موجودہ بحالی آف لائن متبادل نہیں چنتی، اس لیے false۔
C / C++ status.allowed · C# Status().Allowedbooleanکیا سرکاری SDK ابھی استعمال کی اجازت دیتا ہے؛ انفرادی فنکشن الگ جانچیں۔
C / C++ status.state · C# Status().Statestringسرکاری SDK حالت کا نام؛ لاگ ان سے پہلے login_required ہو سکتا ہے۔
C / C++ status.code · C# Status().Codestringمستحکم مشینی خطا کوڈ، پیغام اور کارروائی کا راستہ چننے کے لیے۔
C / C++ status.request_id · C# Status().RequestIDstringتشخیص کے لیے سرور درخواست کا ربط ID؛ ہر زبان یہ نہیں دیتی۔
C / C++ status.retryable · C# Status().Retryablebooleanدوبارہ کوشش تجویز ہے یا نہیں؛ یہ ابھی محفوظ کام کی اجازت نہیں۔
C / C++ status.lease_valid_until · C# Status().LeaseValidUntilUnix secondsسرکاری SDK کی دستخط شدہ اجازت کی میعاد Unix سیکنڈ میں؛ اکاؤنٹ میعاد سے الگ۔
Go Identity.ProductID / product_idUUIDLaunch اسٹور پروڈکٹ ID، انتظامی انضمامی کوڈ خود بھرتا ہے۔
Go Identity.LicentivoProductID / licentivo_product_idUUIDLicentivo لائسنس پروڈکٹ ID، عوامی دستخطی ترتیب سے ملنا ضروری۔
Go Identity.LaunchConnectionID / launch_connection_idUUIDمتعین Launch اجازت کنکشن ID؛ پروڈکٹ اور ماحول سے مطابقت ضروری۔
Go Identity.Environment / environmentsandbox | livesandbox یا live؛ اکاؤنٹ، پروڈکٹ اور کیش ایک ماحول میں رکھیں۔
Go Identity.IdentityToken / identity_tokenstringمختصر، ایک بار کا شناختی ثبوت، صرف SDK میموری میں؛ آف لائن سند نہیں۔
Go Identity.ExpiresAt / identity.expires_attime.Time / ISO 8601شناختی ثبوت کی میعاد، اکاؤنٹ سیشن یا خرید کی میعاد نہیں۔
Go Session.AccessToken / access_token / tokenstringLaunch سیشن ٹوکن؛ صرف نچلی سیشن یا خفیہ اسٹوریج انٹرفیس سے ملتا ہے۔

ٹوکن، شناختی ثبوت اور محفوظ ریکارڈ راز ہیں؛ لاگ یا براؤزر رینڈرر کو نہ دیں۔

خطائیں اور ناکامیاں

فیلڈقسممقصد
Go APIError.Code · Python APIError.code · C# Code · Java/Rust/Ruby code · JS code · C error()stringمستحکم مشینی خطا کوڈ، پیغام اور کارروائی کا راستہ چننے کے لیے۔
Go APIError.Status · Python status · C# Status · Java/Rust/Ruby/JS statusintegerHTTP حالت؛ 0 کا مطلب HTTP جواب دستیاب نہیں۔
Go RequestID · Java requestID · Rust request_idstringتشخیص کے لیے سرور درخواست کا ربط ID؛ ہر زبان یہ نہیں دیتی۔
Go RetryAfter · Python retry_after · C# RetryAfterSeconds · Java retryAfterMillis · JS/Ruby retryAfterSeconds / retry_after_seconds · Rust retry_afterDuration / s / msتجویز کردہ انتظار؛ زبان کے مطابق سیکنڈ، ملی سیکنڈ یا Duration پہچانیں۔

مقامی اخراج اور دور کی منسوخی الگ ہیں۔ زیر التوا کام اور اسٹوریج ناکامی سنبھالیں، SDK جرنل محفوظ رکھیں۔