मुख्य सामग्री पर जाएँ

नौ भाषाओं के 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, record की मेमोरी बनाता है; कॉलर मुक्त करता है।

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 जर्नल बचाएँ।