مرجع دوال SDK ونتائجها بتسع لغات

Connect(merchantOrigin, productID, licentivoProductID string, trustedKeys map[string]string, options Config) → (*Application, error)

الغرض

يتحقق من الإعدادات العامة وينشئ التطبيق، دون تسجيل الدخول أو السماح بالوظائف المحمية.

المعاملات

• merchantOrigin / origin: عنوان أصل المتجر الحالي كاملًا بالبروتوكول والمنفذ اللازم؛ استخدم HTTPS في الإنتاج.
• productID / product_id: معرف منتج متجر Launch، يملؤه كود التكامل الإداري تلقائيًا.
• licentivoProductID / licentivo_product_id: معرف منتج ترخيص Licentivo، ويجب أن يطابق إعداد التوقيع العام.
• trustedKeys / trusted_keys: ربط معرفات مفاتيح التوقيع بالمفاتيح العامة للتحقق من أذونات SDK الرسمي الموقعة.
• environment: sandbox أو live؛ يجب توحيد البيئة للحساب والمنتجات والذاكرة المؤقتة.
• options / config: خيارات تخزين الجلسة والدليل الخاص والإلغاء والمحاولات أو المكونات المتقدمة.

القيمة المعادة

(*Application, error)

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

Login(ctx context.Context, email, password string) → (State, error)

الغرض

يسجل الدخول بحساب المتجر ويحصل على إثبات هوية قصير العمر ويشغل SDK الرسمي للتفويض.

المعاملات

• ctx / ct / signal / cancellation: سياق الطلب أو إشارة الإلغاء؛ يتحكم سياق دورة حياة Go في مهام الخلفية أيضًا.
• email, password: بريد العميل وكلمة مروره في هذا المتجر؛ تستخدم كلمة المرور لهذا الدخول فقط.

القيمة المعادة

(State, error)

يعيد حالة الحساب؛ راجع جدول الحقول أدناه.

Restore(ctx context.Context) → (State, error)

الغرض

يقرأ الجلسة المحفوظة ويؤكد الحساب عبر الإنترنت ويحصل على إثبات جديد ويشغل SDK الرسمي.

المعاملات

• ctx / ct / signal / cancellation: سياق الطلب أو إشارة الإلغاء؛ يتحكم سياق دورة حياة Go في مهام الخلفية أيضًا.

القيمة المعادة

(State, error)

يعيد حالة الحساب؛ تعني ErrNoSession أو NO_SESSION عدم وجود جلسة محفوظة. عالج الأخطاء الأخرى منفصلة.

RunFeature(feature string, action func() error) → error

الغرض

يتحقق SDK الرسمي من الإذن عند كل تنفيذ، ولا يشغل الاستدعاء إلا عند السماح.

المعاملات

• feature / name, action / block: اسم الوظيفة يطابق السياسة؛ يحتوي الاستدعاء على العمل المحمي الفعلي.

القيمة المعادة

error

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

Logout(ctx context.Context) → error

الغرض

يوقف التفويض المحلي ويخرج من SDK الرسمي ثم يلغي جلسة Launch. يحتفظ بالمهام البعيدة غير المكتملة لإعادة المحاولة.

المعاملات

• ctx / ct / signal / cancellation: سياق الطلب أو إشارة الإلغاء؛ يتحكم سياق دورة حياة Go في مهام الخلفية أيضًا.

القيمة المعادة

error

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

ReleaseDevice(ctx context.Context) → error

الغرض

مدخل توافق للخروج الصريح ينفذ مسار خروج الحساب والجهاز نفسه الذي ينفذه Logout.

المعاملات

• ctx / ct / signal / cancellation: سياق الطلب أو إشارة الإلغاء؛ يتحكم سياق دورة حياة Go في مهام الخلفية أيضًا.

القيمة المعادة

error

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

Close() → void

الغرض

يوقف هذه النسخة ومهام الخلفية مع الاحتفاظ بالدخول المحفوظ وربط الجهاز.

القيمة المعادة

void

لا يعيد قيمة عمل؛ الإغلاق العادي لا يؤكد خروج الحساب أو تحرير الجهاز.

NewApplication(config Config) → (*Application, error)

الغرض

يتحقق من الإعدادات العامة وينشئ التطبيق، دون تسجيل الدخول أو السماح بالوظائف المحمية.

المعاملات

• options / config: خيارات تخزين الجلسة والدليل الخاص والإلغاء والمحاولات أو المكونات المتقدمة.

القيمة المعادة

(*Application, error)

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

NewApplicationFromFiles(launchPath, productPath string, options Config) → (*Application, error)

الغرض

يقرأ ملفي إعدادات عامة موجودين ويتحقق من ربط المنتجات وينشئ التطبيق. الاتصال المباشر لا يتطلب ملفات.

المعاملات

• launchPath, productPath: مسارات الإعدادات المختارة أو دليل الذاكرة والتخزين الخاص بالمستخدم الحالي.
• options / config: خيارات تخزين الجلسة والدليل الخاص والإلغاء والمحاولات أو المكونات المتقدمة.

القيمة المعادة

(*Application, error)

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

LoadPublicConfig(path string) → (PublicConfig, error)

الغرض

يتحقق من الإعدادات العامة أو يقرؤها؛ يجب تطابق المنتجات والبيئة ومفاتيح التوقيع.

المعاملات

• path: مسارات الإعدادات المختارة أو دليل الذاكرة والتخزين الخاص بالمستخدم الحالي.

القيمة المعادة

(PublicConfig, error)

يعيد نوع القيمة المحدد في التوقيع؛ النتيجة لا تمنح إذن وظيفة.

NewRuntime(product ProductConfig, runtime RuntimeConfig) → (Runtime, error)

الغرض

ينشئ محول SDK الرسمي للتكامل المتقدم؛ يمرر إثبات الهوية في الذاكرة فقط.

المعاملات

• product, runtime: كائن إعداد أو محول تشغيل أو نقل أو طلب، للتكامل المتقدم فقط.

القيمة المعادة

(Runtime, error)

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

New(origin string, allowLocalHTTP bool) → (*Client, error)

الغرض

يتحقق من الإعدادات العامة وينشئ التطبيق، دون تسجيل الدخول أو السماح بالوظائف المحمية.

المعاملات

• origin: عنوان أصل المتجر الحالي كاملًا بالبروتوكول والمنفذ اللازم؛ استخدم HTTPS في الإنتاج.
• allowLocalHTTP: خيارات تخزين الجلسة والدليل الخاص والإلغاء والمحاولات أو المكونات المتقدمة.

القيمة المعادة

(*Client, error)

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

WithToken(token string) → *Client

الغرض

يعيد نسخة عميل تحمل رمز الحساب المحدد، للخوادم الخلفية الموثوقة.

المعاملات

• token: رمز جلسة Launch، تعيده فقط واجهات الجلسات المنخفضة المستوى أو التخزين المشفر.

القيمة المعادة

*Client

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

Login(ctx context.Context, email, password string) → (User, error)

الغرض

يصادق الحساب ويعيد تفاصيله أو جلسته، دون تشغيل محرك التفويض.

المعاملات

• ctx / ct / signal / cancellation: سياق الطلب أو إشارة الإلغاء؛ يتحكم سياق دورة حياة Go في مهام الخلفية أيضًا.
• email, password: بريد العميل وكلمة مروره في هذا المتجر؛ تستخدم كلمة المرور لهذا الدخول فقط.

القيمة المعادة

(User, error)

يعيد حالة الحساب؛ راجع جدول الحقول أدناه.

LoginSession(ctx context.Context, email, password string) → (Session, error)

الغرض

يصادق الحساب ويعيد تفاصيله أو جلسته، دون تشغيل محرك التفويض.

المعاملات

• ctx / ct / signal / cancellation: سياق الطلب أو إشارة الإلغاء؛ يتحكم سياق دورة حياة Go في مهام الخلفية أيضًا.
• email, password: بريد العميل وكلمة مروره في هذا المتجر؛ تستخدم كلمة المرور لهذا الدخول فقط.

القيمة المعادة

(Session, error)

يعيد حالة الحساب؛ راجع جدول الحقول أدناه.

CurrentUser(ctx context.Context) → (User, error)

الغرض

يستعلم عن الحساب الحالي؛ النجاح لا يسمح بالوظائف المحمية.

المعاملات

• ctx / ct / signal / cancellation: سياق الطلب أو إشارة الإلغاء؛ يتحكم سياق دورة حياة Go في مهام الخلفية أيضًا.

القيمة المعادة

(User, error)

يعيد حالة الحساب؛ راجع جدول الحقول أدناه.

Identity(ctx context.Context, product, environment string) → (Identity, error)

الغرض

يحصل على إثبات هوية أحادي الاستخدام وسياق توجيه عام؛ ليس ترخيصًا أو إذن وظيفة.

المعاملات

• ctx / ct / signal / cancellation: سياق الطلب أو إشارة الإلغاء؛ يتحكم سياق دورة حياة Go في مهام الخلفية أيضًا.
• product: معرف منتج متجر Launch، يملؤه كود التكامل الإداري تلقائيًا.
• environment: sandbox أو live؛ يجب توحيد البيئة للحساب والمنتجات والذاكرة المؤقتة.

القيمة المعادة

(Identity, error)

يعيد حالة الحساب؛ راجع جدول الحقول أدناه.

SignOut(ctx context.Context) → error

الغرض

يلغي جلسة Launch ويمسح رمز العميل؛ لا يحل محل خروج الجهاز عبر SDK الرسمي.

المعاملات

• ctx / ct / signal / cancellation: سياق الطلب أو إشارة الإلغاء؛ يتحكم سياق دورة حياة Go في مهام الخلفية أيضًا.

القيمة المعادة

error

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

Credential(ctx context.Context, product, environment string) → (Credential, error)

الغرض

واجهة قديمة محفوظة؛ أزيل بروتوكول بيانات الترخيص الطويلة الأجل ولذلك تفشل الطلبات. استخدم Application.

المعاملات

• ctx / ct / signal / cancellation: سياق الطلب أو إشارة الإلغاء؛ يتحكم سياق دورة حياة Go في مهام الخلفية أيضًا.
• product: معرف منتج متجر Launch، يملؤه كود التكامل الإداري تلقائيًا.
• environment: sandbox أو live؛ يجب توحيد البيئة للحساب والمنتجات والذاكرة المؤقتة.

القيمة المعادة

(Credential, error)

يفشل دائمًا؛ انتقل إلى تبادل هوية الحساب.

CredentialWithRetry(ctx context.Context, product, environment string, policy RetryPolicy) → (Credential, error)

الغرض

واجهة قديمة محفوظة؛ أزيل بروتوكول بيانات الترخيص الطويلة الأجل ولذلك تفشل الطلبات. استخدم Application.

المعاملات

• ctx / ct / signal / cancellation: سياق الطلب أو إشارة الإلغاء؛ يتحكم سياق دورة حياة Go في مهام الخلفية أيضًا.
• product: معرف منتج متجر Launch، يملؤه كود التكامل الإداري تلقائيًا.
• environment: sandbox أو live؛ يجب توحيد البيئة للحساب والمنتجات والذاكرة المؤقتة.
• policy: خيارات تخزين الجلسة والدليل الخاص والإلغاء والمحاولات أو المكونات المتقدمة.

القيمة المعادة

(Credential, error)

يفشل دائمًا؛ انتقل إلى تبادل هوية الحساب.

NewSystemSessionStore(directory string) → (SessionStore, error)

الغرض

ينشئ مخزن جلسات دائمًا ومحميًا؛ احصل على مفتاح التشفير من خزنة بيانات اعتماد نظام التشغيل.

المعاملات

• directory: مسارات الإعدادات المختارة أو دليل الذاكرة والتخزين الخاص بالمستخدم الحالي.

القيمة المعادة

(SessionStore, error)

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

ProtectDirectory(directory string) → error

الغرض

يقصر الوصول للدليل على مستخدم Windows الحالي أو صلاحيات خاصة على المنصات الأخرى.

المعاملات

• directory: مسارات الإعدادات المختارة أو دليل الذاكرة والتخزين الخاص بالمستخدم الحالي.

القيمة المعادة

error

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

ServiceUnavailable(err error) → bool

الغرض

يصنف عدم توفر الخدمة المؤقت؛ لا يسمح ذلك بالتفويض دون اتصال.

المعاملات

• err: ينشئ أو يقرأ خطأ منظمًا للتصنيف والتأخير وربط التشخيص.

القيمة المعادة

bool

يعيد تصنيفًا منطقيًا، وليس تفويضًا.

Error() → string

الغرض

ينشئ أو يقرأ خطأ منظمًا للتصنيف والتأخير وربط التشخيص.

القيمة المعادة

string

يعيد نوع القيمة المحدد في التوقيع؛ النتيجة لا تمنح إذن وظيفة.

Unwrap() → error

الغرض

ينشئ أو يقرأ خطأ منظمًا للتصنيف والتأخير وربط التشخيص.

القيمة المعادة

error

يعيد نوع القيمة المحدد في التوقيع؛ النتيجة لا تمنح إذن وظيفة.

Load(ctx context.Context, key string) → ([]byte, error)

الغرض

يحمل سجل الحساب بمفتاح معزول؛ يتضمن أسرارًا مخصصة لـ SDK فقط.

المعاملات

• scope / key, value / record: مفاتيح العزل والسجلات السرية لـ SDK؛ يجب أن يدعم التخزين المخصص مفاتيح متعددة واستبدالًا ذريًا.

القيمة المعادة

([]byte, error)

يعيد السجل السري؛ عند الغياب يعيد قيمة فارغة أو ErrNoSession حسب اللغة.

Save(ctx context.Context, key string, value []byte) → error

الغرض

يحفظ سجل الحساب ذريًا باستخدام مفتاحه المعزول.

المعاملات

• scope / key, value / record: مفاتيح العزل والسجلات السرية لـ SDK؛ يجب أن يدعم التخزين المخصص مفاتيح متعددة واستبدالًا ذريًا.

القيمة المعادة

error

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

Delete(ctx context.Context, key string) → error

الغرض

يحذف سجل الحساب مع إبقاء ذاكرة تفويض SDK الرسمي وسجل الخروج.

المعاملات

• scope / key, value / record: مفاتيح العزل والسجلات السرية لـ SDK؛ يجب أن يدعم التخزين المخصص مفاتيح متعددة واستبدالًا ذريًا.

القيمة المعادة

error

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

Start(ctx context.Context, onError func(error)) → error

الغرض

يشغل التحقق والصيانة الخلفية لـ SDK الرسمي؛ للدخول وحماية الوظائف واجهات منفصلة.

المعاملات

• ctx / ct / signal / cancellation: سياق الطلب أو إشارة الإلغاء؛ يتحكم سياق دورة حياة Go في مهام الخلفية أيضًا.
• onError: ينشئ أو يقرأ خطأ منظمًا للتصنيف والتأخير وربط التشخيص.

القيمة المعادة

error

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

RunFeature(feature string, action func() error) → error

الغرض

يتحقق SDK الرسمي من الإذن عند كل تنفيذ، ولا يشغل الاستدعاء إلا عند السماح.

المعاملات

• feature / name, action / block: اسم الوظيفة يطابق السياسة؛ يحتوي الاستدعاء على العمل المحمي الفعلي.

القيمة المعادة

error

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

Deactivate(ctx context.Context) → error

الغرض

ينفذ خروج الجهاز عبر SDK الرسمي؛ يلغي التطبيق جلسة حساب Launch بصورة منفصلة.

المعاملات

• ctx / ct / signal / cancellation: سياق الطلب أو إشارة الإلغاء؛ يتحكم سياق دورة حياة Go في مهام الخلفية أيضًا.

القيمة المعادة

error

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

Close() → void

الغرض

يوقف هذه النسخة ومهام الخلفية مع الاحتفاظ بالدخول المحفوظ وربط الجهاز.

القيمة المعادة

void

لا يعيد قيمة عمل؛ الإغلاق العادي لا يؤكد خروج الحساب أو تحرير الجهاز.

Application.connect(merchant_origin, product_id, licentivo_product_id, trusted_keys, environment="live", **kwargs) → Application

الغرض

يتحقق من الإعدادات العامة وينشئ التطبيق، دون تسجيل الدخول أو السماح بالوظائف المحمية.

المعاملات

• merchantOrigin / origin: عنوان أصل المتجر الحالي كاملًا بالبروتوكول والمنفذ اللازم؛ استخدم HTTPS في الإنتاج.
• productID / product_id: معرف منتج متجر Launch، يملؤه كود التكامل الإداري تلقائيًا.
• licentivoProductID / licentivo_product_id: معرف منتج ترخيص Licentivo، ويجب أن يطابق إعداد التوقيع العام.
• trustedKeys / trusted_keys: ربط معرفات مفاتيح التوقيع بالمفاتيح العامة للتحقق من أذونات SDK الرسمي الموقعة.
• environment: sandbox أو live؛ يجب توحيد البيئة للحساب والمنتجات والذاكرة المؤقتة.
• options / config: خيارات تخزين الجلسة والدليل الخاص والإلغاء والمحاولات أو المكونات المتقدمة.

القيمة المعادة

Application

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

login(email, password, *, pending_attempts=3) → Application (self)

الغرض

يسجل الدخول بحساب المتجر ويحصل على إثبات هوية قصير العمر ويشغل SDK الرسمي للتفويض.

المعاملات

• email, password: بريد العميل وكلمة مروره في هذا المتجر؛ تستخدم كلمة المرور لهذا الدخول فقط.
• pending_attempts: خيارات تخزين الجلسة والدليل الخاص والإلغاء والمحاولات أو المكونات المتقدمة.

القيمة المعادة

Application (self)

يعيد نسخة التطبيق نفسها، لا تفاصيل الحساب ولا نتيجة تفويض.

restore() → bool

الغرض

يقرأ الجلسة المحفوظة ويؤكد الحساب عبر الإنترنت ويحصل على إثبات جديد ويشغل SDK الرسمي.

القيمة المعادة

bool

تعني true نجاح الاستعادة وfalse عدم وجود جلسة قابلة للاستعادة. الرفض والانتهاء وفشل الشبكة أخطاء.

run_feature(name, action) → T

الغرض

يتحقق SDK الرسمي من الإذن عند كل تنفيذ، ولا يشغل الاستدعاء إلا عند السماح.

المعاملات

• feature / name, action / block: اسم الوظيفة يطابق السياسة؛ يحتوي الاستدعاء على العمل المحمي الفعلي.

القيمة المعادة

T

يعيد نتيجة استدعاء العمل؛ تبلغ إخفاقات التفويض واستثناءات العمل كأخطاء.

logout() → bool

الغرض

يوقف التفويض المحلي ويخرج من SDK الرسمي ثم يلغي جلسة Launch. يحتفظ بالمهام البعيدة غير المكتملة لإعادة المحاولة.

القيمة المعادة

bool

تؤكد true الخروج؛ وتعني false أن خروج الحساب البعيد أو إلغاء الجهاز معلق. قد تحدث أخطاء تخزين أيضًا.

release_device() → bool

الغرض

مدخل توافق للخروج الصريح ينفذ مسار خروج الحساب والجهاز نفسه الذي ينفذه Logout.

القيمة المعادة

bool

تؤكد true الخروج؛ وتعني false أن خروج الحساب البعيد أو إلغاء الجهاز معلق. قد تحدث أخطاء تخزين أيضًا.

close() → None

الغرض

يوقف هذه النسخة ومهام الخلفية مع الاحتفاظ بالدخول المحفوظ وربط الجهاز.

القيمة المعادة

None

لا يعيد قيمة عمل؛ الإغلاق العادي لا يؤكد خروج الحساب أو تحرير الجهاز.

with Application.connect(...) as app: ... → Application / None

الغرض

يوقف هذه النسخة ومهام الخلفية مع الاحتفاظ بالدخول المحفوظ وربط الجهاز.

القيمة المعادة

Application / None

لا يعيد قيمة عمل؛ الإغلاق العادي لا يؤكد خروج الحساب أو تحرير الجهاز.

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، يملؤه كود التكامل الإداري تلقائيًا.
• product_config: كائن إعداد أو محول تشغيل أو نقل أو طلب، للتكامل المتقدم فقط.
• environment: sandbox أو live؛ يجب توحيد البيئة للحساب والمنتجات والذاكرة المؤقتة.
• options / config: خيارات تخزين الجلسة والدليل الخاص والإلغاء والمحاولات أو المكونات المتقدمة.

القيمة المعادة

Application

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

Application.from_files(launch_config, product_config, **kwargs) → Application

الغرض

يقرأ ملفي إعدادات عامة موجودين ويتحقق من ربط المنتجات وينشئ التطبيق. الاتصال المباشر لا يتطلب ملفات.

المعاملات

• launch_config, product_config: مسارات الإعدادات المختارة أو دليل الذاكرة والتخزين الخاص بالمستخدم الحالي.
• options / config: خيارات تخزين الجلسة والدليل الخاص والإلغاء والمحاولات أو المكونات المتقدمة.

القيمة المعادة

Application

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

MemoryStore() → MemoryStore

الغرض

ينشئ مخزن جلسات صالحًا داخل العملية الحالية فقط.

القيمة المعادة

MemoryStore

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

WindowsDPAPIStore(directory=None) → WindowsDPAPIStore

الغرض

ينشئ مخزن جلسات دائمًا ومحميًا؛ احصل على مفتاح التشفير من خزنة بيانات اعتماد نظام التشغيل.

المعاملات

• directory: مسارات الإعدادات المختارة أو دليل الذاكرة والتخزين الخاص بالمستخدم الحالي.

القيمة المعادة

WindowsDPAPIStore

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

APIError(code, status=0, retry_after=0) → APIError

الغرض

ينشئ أو يقرأ خطأ منظمًا للتصنيف والتأخير وربط التشخيص.

المعاملات

• code, status, retry_after: ينشئ أو يقرأ خطأ منظمًا للتصنيف والتأخير وربط التشخيص.

القيمة المعادة

APIError

يعيد نوع القيمة المحدد في التوقيع؛ النتيجة لا تمنح إذن وظيفة.

load(key) → bytes | None

الغرض

يحمل سجل الحساب بمفتاح معزول؛ يتضمن أسرارًا مخصصة لـ SDK فقط.

المعاملات

• scope / key, value / record: مفاتيح العزل والسجلات السرية لـ SDK؛ يجب أن يدعم التخزين المخصص مفاتيح متعددة واستبدالًا ذريًا.

القيمة المعادة

bytes | None

يعيد السجل السري؛ عند الغياب يعيد قيمة فارغة أو ErrNoSession حسب اللغة.

save(key, value) → None

الغرض

يحفظ سجل الحساب ذريًا باستخدام مفتاحه المعزول.

المعاملات

• scope / key, value / record: مفاتيح العزل والسجلات السرية لـ SDK؛ يجب أن يدعم التخزين المخصص مفاتيح متعددة واستبدالًا ذريًا.

القيمة المعادة

None

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

delete(key) → None

الغرض

يحذف سجل الحساب مع إبقاء ذاكرة تفويض SDK الرسمي وسجل الخروج.

المعاملات

• scope / key, value / record: مفاتيح العزل والسجلات السرية لـ SDK؛ يجب أن يدعم التخزين المخصص مفاتيح متعددة واستبدالًا ذريًا.

القيمة المعادة

None

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

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، يملؤه كود التكامل الإداري تلقائيًا.
• licentivoProductID / licentivo_product_id: معرف منتج ترخيص Licentivo، ويجب أن يطابق إعداد التوقيع العام.
• trustedKeys / trusted_keys: ربط معرفات مفاتيح التوقيع بالمفاتيح العامة للتحقق من أذونات SDK الرسمي الموقعة.
• environment: sandbox أو live؛ يجب توحيد البيئة للحساب والمنتجات والذاكرة المؤقتة.
• store, cacheDirectory: خيارات تخزين الجلسة والدليل الخاص والإلغاء والمحاولات أو المكونات المتقدمة.

القيمة المعادة

Application

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

Login(string email, string password, int pendingAttempts=3, CancellationToken ct=default) → Task

الغرض

يسجل الدخول بحساب المتجر ويحصل على إثبات هوية قصير العمر ويشغل SDK الرسمي للتفويض.

المعاملات

• email, password: بريد العميل وكلمة مروره في هذا المتجر؛ تستخدم كلمة المرور لهذا الدخول فقط.
• pendingAttempts: خيارات تخزين الجلسة والدليل الخاص والإلغاء والمحاولات أو المكونات المتقدمة.
• ctx / ct / signal / cancellation: سياق الطلب أو إشارة الإلغاء؛ يتحكم سياق دورة حياة Go في مهام الخلفية أيضًا.

القيمة المعادة

Task

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

Restore(CancellationToken ct=default) → Task<bool>

الغرض

يقرأ الجلسة المحفوظة ويؤكد الحساب عبر الإنترنت ويحصل على إثبات جديد ويشغل SDK الرسمي.

المعاملات

• ctx / ct / signal / cancellation: سياق الطلب أو إشارة الإلغاء؛ يتحكم سياق دورة حياة Go في مهام الخلفية أيضًا.

القيمة المعادة

Task<bool>

تعني true نجاح الاستعادة وfalse عدم وجود جلسة قابلة للاستعادة. الرفض والانتهاء وفشل الشبكة أخطاء.

RunFeature(string feature, Func<Task> action) → Task

الغرض

يتحقق SDK الرسمي من الإذن عند كل تنفيذ، ولا يشغل الاستدعاء إلا عند السماح.

المعاملات

• feature / name, action / block: اسم الوظيفة يطابق السياسة؛ يحتوي الاستدعاء على العمل المحمي الفعلي.

القيمة المعادة

Task

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

Status() → AuthorizationStatus? (null: runtime absent)

الغرض

يقرأ حالة التفويض الحالية في SDK الرسمي، دون تسجيل دخول أو استبدال فحص الوظيفة.

القيمة المعادة

AuthorizationStatus? (null: runtime absent)

يقرأ حالة التفويض الحالية في SDK الرسمي، دون تسجيل دخول أو استبدال فحص الوظيفة.

Logout(CancellationToken ct=default) → Task

الغرض

يوقف التفويض المحلي ويخرج من SDK الرسمي ثم يلغي جلسة Launch. يحتفظ بالمهام البعيدة غير المكتملة لإعادة المحاولة.

المعاملات

• ctx / ct / signal / cancellation: سياق الطلب أو إشارة الإلغاء؛ يتحكم سياق دورة حياة Go في مهام الخلفية أيضًا.

القيمة المعادة

Task

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

ReleaseDevice(CancellationToken ct=default) → Task

الغرض

مدخل توافق للخروج الصريح ينفذ مسار خروج الحساب والجهاز نفسه الذي ينفذه Logout.

المعاملات

• ctx / ct / signal / cancellation: سياق الطلب أو إشارة الإلغاء؛ يتحكم سياق دورة حياة Go في مهام الخلفية أيضًا.

القيمة المعادة

Task

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

DisposeAsync() → ValueTask

الغرض

يوقف هذه النسخة ومهام الخلفية مع الاحتفاظ بالدخول المحفوظ وربط الجهاز.

القيمة المعادة

ValueTask

لا يعيد قيمة عمل؛ الإغلاق العادي لا يؤكد خروج الحساب أو تحرير الجهاز.

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، يملؤه كود التكامل الإداري تلقائيًا.
• productConfig: كائن إعداد أو محول تشغيل أو نقل أو طلب، للتكامل المتقدم فقط.
• environment: sandbox أو live؛ يجب توحيد البيئة للحساب والمنتجات والذاكرة المؤقتة.
• options / config: خيارات تخزين الجلسة والدليل الخاص والإلغاء والمحاولات أو المكونات المتقدمة.

القيمة المعادة

Application

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

Application.FromFiles(string launchPath, string productPath, ISessionStore? store=null) → Application

الغرض

يقرأ ملفي إعدادات عامة موجودين ويتحقق من ربط المنتجات وينشئ التطبيق. الاتصال المباشر لا يتطلب ملفات.

المعاملات

• launchPath, productPath: مسارات الإعدادات المختارة أو دليل الذاكرة والتخزين الخاص بالمستخدم الحالي.
• store: خيارات تخزين الجلسة والدليل الخاص والإلغاء والمحاولات أو المكونات المتقدمة.

القيمة المعادة

Application

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

new MemoryStore() → MemoryStore

الغرض

ينشئ مخزن جلسات صالحًا داخل العملية الحالية فقط.

القيمة المعادة

MemoryStore

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

new WindowsDPAPIStore(string? directory=null) → WindowsDPAPIStore

الغرض

ينشئ مخزن جلسات دائمًا ومحميًا؛ احصل على مفتاح التشفير من خزنة بيانات اعتماد نظام التشغيل.

المعاملات

• directory: مسارات الإعدادات المختارة أو دليل الذاكرة والتخزين الخاص بالمستخدم الحالي.

القيمة المعادة

WindowsDPAPIStore

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

new LaunchException(string code, int status=0, int retryAfterSeconds=0) → LaunchException

الغرض

ينشئ أو يقرأ خطأ منظمًا للتصنيف والتأخير وربط التشخيص.

المعاملات

• code, status, retryAfterSeconds: ينشئ أو يقرأ خطأ منظمًا للتصنيف والتأخير وربط التشخيص.

القيمة المعادة

LaunchException

يعيد نوع القيمة المحدد في التوقيع؛ النتيجة لا تمنح إذن وظيفة.

Load(string key) → byte[]?

الغرض

يحمل سجل الحساب بمفتاح معزول؛ يتضمن أسرارًا مخصصة لـ SDK فقط.

المعاملات

• scope / key, value / record: مفاتيح العزل والسجلات السرية لـ SDK؛ يجب أن يدعم التخزين المخصص مفاتيح متعددة واستبدالًا ذريًا.

القيمة المعادة

byte[]?

يعيد السجل السري؛ عند الغياب يعيد قيمة فارغة أو ErrNoSession حسب اللغة.

Save(string key, byte[] value) → void

الغرض

يحفظ سجل الحساب ذريًا باستخدام مفتاحه المعزول.

المعاملات

• scope / key, value / record: مفاتيح العزل والسجلات السرية لـ SDK؛ يجب أن يدعم التخزين المخصص مفاتيح متعددة واستبدالًا ذريًا.

القيمة المعادة

void

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

Delete(string key) → void

الغرض

يحذف سجل الحساب مع إبقاء ذاكرة تفويض SDK الرسمي وسجل الخروج.

المعاملات

• scope / key, value / record: مفاتيح العزل والسجلات السرية لـ SDK؛ يجب أن يدعم التخزين المخصص مفاتيح متعددة واستبدالًا ذريًا.

القيمة المعادة

void

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

Start(CancellationToken ct) → Task

الغرض

يشغل التحقق والصيانة الخلفية لـ SDK الرسمي؛ للدخول وحماية الوظائف واجهات منفصلة.

المعاملات

• ctx / ct / signal / cancellation: سياق الطلب أو إشارة الإلغاء؛ يتحكم سياق دورة حياة Go في مهام الخلفية أيضًا.

القيمة المعادة

Task

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

Status() → AuthorizationStatus

الغرض

يقرأ حالة التفويض الحالية في SDK الرسمي، دون تسجيل دخول أو استبدال فحص الوظيفة.

القيمة المعادة

AuthorizationStatus

يقرأ حالة التفويض الحالية في SDK الرسمي، دون تسجيل دخول أو استبدال فحص الوظيفة.

RunFeature(string feature, Func<Task> action) → Task

الغرض

يتحقق SDK الرسمي من الإذن عند كل تنفيذ، ولا يشغل الاستدعاء إلا عند السماح.

المعاملات

• feature / name, action / block: اسم الوظيفة يطابق السياسة؛ يحتوي الاستدعاء على العمل المحمي الفعلي.

القيمة المعادة

Task

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

Deactivate(CancellationToken ct) → Task

الغرض

ينفذ خروج الجهاز عبر SDK الرسمي؛ يلغي التطبيق جلسة حساب Launch بصورة منفصلة.

المعاملات

• ctx / ct / signal / cancellation: سياق الطلب أو إشارة الإلغاء؛ يتحكم سياق دورة حياة Go في مهام الخلفية أيضًا.

القيمة المعادة

Task

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

DisposeAsync() → ValueTask

الغرض

يوقف هذه النسخة ومهام الخلفية مع الاحتفاظ بالدخول المحفوظ وربط الجهاز.

القيمة المعادة

ValueTask

لا يعيد قيمة عمل؛ الإغلاق العادي لا يؤكد خروج الحساب أو تحرير الجهاز.

Launch.connect(String merchantOrigin, String productId, String licentivoProductId, Map<String,String> trustedKeys, String environment) → Launch

الغرض

يتحقق من الإعدادات العامة وينشئ التطبيق، دون تسجيل الدخول أو السماح بالوظائف المحمية.

المعاملات

• merchantOrigin / origin: عنوان أصل المتجر الحالي كاملًا بالبروتوكول والمنفذ اللازم؛ استخدم HTTPS في الإنتاج.
• productID / product_id: معرف منتج متجر Launch، يملؤه كود التكامل الإداري تلقائيًا.
• licentivoProductID / licentivo_product_id: معرف منتج ترخيص Licentivo، ويجب أن يطابق إعداد التوقيع العام.
• trustedKeys / trusted_keys: ربط معرفات مفاتيح التوقيع بالمفاتيح العامة للتحقق من أذونات SDK الرسمي الموقعة.
• environment: sandbox أو live؛ يجب توحيد البيئة للحساب والمنتجات والذاكرة المؤقتة.

القيمة المعادة

Launch

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

login(String email, char[] password) → State

الغرض

يسجل الدخول بحساب المتجر ويحصل على إثبات هوية قصير العمر ويشغل SDK الرسمي للتفويض.

المعاملات

• email, password: بريد العميل وكلمة مروره في هذا المتجر؛ تستخدم كلمة المرور لهذا الدخول فقط.

القيمة المعادة

State

يعيد حالة الحساب؛ راجع جدول الحقول أدناه.

restore() → State

الغرض

يقرأ الجلسة المحفوظة ويؤكد الحساب عبر الإنترنت ويحصل على إثبات جديد ويشغل SDK الرسمي.

القيمة المعادة

State

يعيد حالة الحساب؛ تعني ErrNoSession أو NO_SESSION عدم وجود جلسة محفوظة. عالج الأخطاء الأخرى منفصلة.

runFeature(String feature, Client.FeatureAction action) → void

الغرض

يتحقق SDK الرسمي من الإذن عند كل تنفيذ، ولا يشغل الاستدعاء إلا عند السماح.

المعاملات

• feature / name, action / block: اسم الوظيفة يطابق السياسة؛ يحتوي الاستدعاء على العمل المحمي الفعلي.

القيمة المعادة

void

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

logout() → void

الغرض

يوقف التفويض المحلي ويخرج من SDK الرسمي ثم يلغي جلسة Launch. يحتفظ بالمهام البعيدة غير المكتملة لإعادة المحاولة.

القيمة المعادة

void

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

releaseDevice() → void

الغرض

مدخل توافق للخروج الصريح ينفذ مسار خروج الحساب والجهاز نفسه الذي ينفذه Logout.

القيمة المعادة

void

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

close() → void

الغرض

يوقف هذه النسخة ومهام الخلفية مع الاحتفاظ بالدخول المحفوظ وربط الجهاز.

القيمة المعادة

void

لا يعيد قيمة عمل؛ الإغلاق العادي لا يؤكد خروج الحساب أو تحرير الجهاز.

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

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

new Launch.Config(String merchantOrigin, String launchProductID, String licentivoProductID, String environment) → Config

الغرض

يتحقق من الإعدادات العامة أو يقرؤها؛ يجب تطابق المنتجات والبيئة ومفاتيح التوقيع.

المعاملات

• merchantOrigin / origin: عنوان أصل المتجر الحالي كاملًا بالبروتوكول والمنفذ اللازم؛ استخدم HTTPS في الإنتاج.
• productID / product_id: معرف منتج متجر Launch، يملؤه كود التكامل الإداري تلقائيًا.
• licentivoProductID / licentivo_product_id: معرف منتج ترخيص Licentivo، ويجب أن يطابق إعداد التوقيع العام.
• environment: sandbox أو live؛ يجب توحيد البيئة للحساب والمنتجات والذاكرة المؤقتة.

القيمة المعادة

Config

يعيد نوع القيمة المحدد في التوقيع؛ النتيجة لا تمنح إذن وظيفة.

Launch.Config.load(Path path) → Config

الغرض

يتحقق من الإعدادات العامة أو يقرؤها؛ يجب تطابق المنتجات والبيئة ومفاتيح التوقيع.

المعاملات

• path: مسارات الإعدادات المختارة أو دليل الذاكرة والتخزين الخاص بالمستخدم الحالي.

القيمة المعادة

Config

يعيد نوع القيمة المحدد في التوقيع؛ النتيجة لا تمنح إذن وظيفة.

Launch.readPublic(Path path) → Map<String,Object>

الغرض

يتحقق من الإعدادات العامة أو يقرؤها؛ يجب تطابق المنتجات والبيئة ومفاتيح التوقيع.

المعاملات

• path: مسارات الإعدادات المختارة أو دليل الذاكرة والتخزين الخاص بالمستخدم الحالي.

القيمة المعادة

Map<String,Object>

يعيد نوع القيمة المحدد في التوقيع؛ النتيجة لا تمنح إذن وظيفة.

new Launch.MemoryStore() → MemoryStore

الغرض

ينشئ مخزن جلسات صالحًا داخل العملية الحالية فقط.

القيمة المعادة

MemoryStore

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

new EncryptedFileStore(Path directory, SecretKey vaultKey) → EncryptedFileStore

الغرض

ينشئ مخزن جلسات دائمًا ومحميًا؛ احصل على مفتاح التشفير من خزنة بيانات اعتماد نظام التشغيل.

المعاملات

• directory: مسارات الإعدادات المختارة أو دليل الذاكرة والتخزين الخاص بالمستخدم الحالي.
• vaultKey: مفتاح تشفير من خزنة نظام التشغيل؛ لا تخزنه بجانب السجلات المشفرة.

القيمة المعادة

EncryptedFileStore

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

request(String method, URI uri, String bearer, byte[] body) → Response

الغرض

يرسل طلبات HTTP للحساب ويعيد الحالة والترويسات أو المحتوى الخام، دون اتخاذ قرار تفويض.

المعاملات

• method, uri, bearer, body: كائن إعداد أو محول تشغيل أو نقل أو طلب، للتكامل المتقدم فقط.

القيمة المعادة

Response

يعيد نوع القيمة المحدد في التوقيع؛ النتيجة لا تمنح إذن وظيفة.

new Launch.Failure(String code [, int status, String requestID, long retryAfterMillis, boolean transport]) → Failure

الغرض

ينشئ أو يقرأ خطأ منظمًا للتصنيف والتأخير وربط التشخيص.

المعاملات

• code, status, requestID, retryAfterMillis, transport: ينشئ أو يقرأ خطأ منظمًا للتصنيف والتأخير وربط التشخيص.

القيمة المعادة

Failure

يعيد نوع القيمة المحدد في التوقيع؛ النتيجة لا تمنح إذن وظيفة.

unavailable() → boolean

الغرض

يصنف عدم توفر الخدمة المؤقت؛ لا يسمح ذلك بالتفويض دون اتصال.

القيمة المعادة

boolean

يعيد تصنيفًا منطقيًا، وليس تفويضًا.

load(String scope) → byte[] | null

الغرض

يحمل سجل الحساب بمفتاح معزول؛ يتضمن أسرارًا مخصصة لـ SDK فقط.

المعاملات

• scope / key, value / record: مفاتيح العزل والسجلات السرية لـ SDK؛ يجب أن يدعم التخزين المخصص مفاتيح متعددة واستبدالًا ذريًا.

القيمة المعادة

byte[] | null

يعيد السجل السري؛ عند الغياب يعيد قيمة فارغة أو ErrNoSession حسب اللغة.

save(String scope, byte[] secret) → void

الغرض

يحفظ سجل الحساب ذريًا باستخدام مفتاحه المعزول.

المعاملات

• scope / key, value / record: مفاتيح العزل والسجلات السرية لـ SDK؛ يجب أن يدعم التخزين المخصص مفاتيح متعددة واستبدالًا ذريًا.

القيمة المعادة

void

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

delete(String scope) → void

الغرض

يحذف سجل الحساب مع إبقاء ذاكرة تفويض SDK الرسمي وسجل الخروج.

المعاملات

• scope / key, value / record: مفاتيح العزل والسجلات السرية لـ SDK؛ يجب أن يدعم التخزين المخصص مفاتيح متعددة واستبدالًا ذريًا.

القيمة المعادة

void

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

canStartOffline() → boolean

الغرض

يقرأ حالة التفويض الحالية في SDK الرسمي، دون تسجيل دخول أو استبدال فحص الوظيفة.

القيمة المعادة

boolean

يعيد تصنيفًا منطقيًا، وليس تفويضًا.

start() → void

الغرض

يشغل التحقق والصيانة الخلفية لـ SDK الرسمي؛ للدخول وحماية الوظائف واجهات منفصلة.

القيمة المعادة

void

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

runFeature(String feature, Client.FeatureAction action) → void

الغرض

يتحقق SDK الرسمي من الإذن عند كل تنفيذ، ولا يشغل الاستدعاء إلا عند السماح.

المعاملات

• feature / name, action / block: اسم الوظيفة يطابق السياسة؛ يحتوي الاستدعاء على العمل المحمي الفعلي.

القيمة المعادة

void

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

releaseDevice() → void

الغرض

ينفذ خروج الجهاز عبر SDK الرسمي؛ يلغي التطبيق جلسة حساب Launch بصورة منفصلة.

القيمة المعادة

void

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

close() → void

الغرض

يوقف هذه النسخة ومهام الخلفية مع الاحتفاظ بالدخول المحفوظ وربط الجهاز.

القيمة المعادة

void

لا يعيد قيمة عمل؛ الإغلاق العادي لا يؤكد خروج الحساب أو تحرير الجهاز.

create(Map<String,Object> settings) → Runtime

الغرض

ينشئ محول SDK الرسمي للتكامل المتقدم؛ يمرر إثبات الهوية في الذاكرة فقط.

المعاملات

• settings: كائن إعداد أو محول تشغيل أو نقل أو طلب، للتكامل المتقدم فقط.

القيمة المعادة

Runtime

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

sleep(long milliseconds) → void

الغرض

ينتظر المدة المحددة لجدولة المحاولات المتقدمة.

المعاملات

• milliseconds: مدة الانتظار المقترحة للمحاولة؛ ميز بين الثواني والمللي ثانية وDuration حسب اللغة.

القيمة المعادة

void

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

Application.connect(merchantOrigin, productID, licentivoProductID, trustedKeys, options?) → Application

الغرض

يتحقق من الإعدادات العامة وينشئ التطبيق، دون تسجيل الدخول أو السماح بالوظائف المحمية.

المعاملات

• merchantOrigin / origin: عنوان أصل المتجر الحالي كاملًا بالبروتوكول والمنفذ اللازم؛ استخدم HTTPS في الإنتاج.
• productID / product_id: معرف منتج متجر Launch، يملؤه كود التكامل الإداري تلقائيًا.
• licentivoProductID / licentivo_product_id: معرف منتج ترخيص Licentivo، ويجب أن يطابق إعداد التوقيع العام.
• trustedKeys / trusted_keys: ربط معرفات مفاتيح التوقيع بالمفاتيح العامة للتحقق من أذونات SDK الرسمي الموقعة.
• environment: sandbox أو live؛ يجب توحيد البيئة للحساب والمنتجات والذاكرة المؤقتة.
• options / config: خيارات تخزين الجلسة والدليل الخاص والإلغاء والمحاولات أو المكونات المتقدمة.

القيمة المعادة

Application

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

login(email: string, password: string, options?: {signal?: AbortSignal}) → Promise<SessionState>

الغرض

يسجل الدخول بحساب المتجر ويحصل على إثبات هوية قصير العمر ويشغل SDK الرسمي للتفويض.

المعاملات

• email, password: بريد العميل وكلمة مروره في هذا المتجر؛ تستخدم كلمة المرور لهذا الدخول فقط.
• ctx / ct / signal / cancellation: سياق الطلب أو إشارة الإلغاء؛ يتحكم سياق دورة حياة Go في مهام الخلفية أيضًا.

القيمة المعادة

Promise<SessionState>

يعيد حالة الحساب؛ راجع جدول الحقول أدناه.

restore(options?: {signal?: AbortSignal}) → Promise<SessionState | null>

الغرض

يقرأ الجلسة المحفوظة ويؤكد الحساب عبر الإنترنت ويحصل على إثبات جديد ويشغل SDK الرسمي.

المعاملات

• ctx / ct / signal / cancellation: سياق الطلب أو إشارة الإلغاء؛ يتحكم سياق دورة حياة Go في مهام الخلفية أيضًا.

القيمة المعادة

Promise<SessionState | null>

يعيد حالة الحساب؛ تعني null أو nil عدم وجود جلسة قابلة للاستعادة. تبلغ الإخفاقات الأخرى كأخطاء.

runFeature<T>(name: string, action: () => T | Promise<T>) → Promise<T>

الغرض

يتحقق SDK الرسمي من الإذن عند كل تنفيذ، ولا يشغل الاستدعاء إلا عند السماح.

المعاملات

• feature / name, action / block: اسم الوظيفة يطابق السياسة؛ يحتوي الاستدعاء على العمل المحمي الفعلي.

القيمة المعادة

Promise<T>

يعيد نتيجة استدعاء العمل؛ تبلغ إخفاقات التفويض واستثناءات العمل كأخطاء.

logout(options?: {signal?: AbortSignal}) → Promise<boolean>

الغرض

يوقف التفويض المحلي ويخرج من SDK الرسمي ثم يلغي جلسة Launch. يحتفظ بالمهام البعيدة غير المكتملة لإعادة المحاولة.

المعاملات

• ctx / ct / signal / cancellation: سياق الطلب أو إشارة الإلغاء؛ يتحكم سياق دورة حياة Go في مهام الخلفية أيضًا.

القيمة المعادة

Promise<boolean>

تؤكد true الخروج؛ وتعني false أن خروج الحساب البعيد أو إلغاء الجهاز معلق. قد تحدث أخطاء تخزين أيضًا.

releaseDevice(options?: {signal?: AbortSignal}) → Promise<void>

الغرض

مدخل توافق للخروج الصريح ينفذ مسار خروج الحساب والجهاز نفسه الذي ينفذه Logout.

المعاملات

• ctx / ct / signal / cancellation: سياق الطلب أو إشارة الإلغاء؛ يتحكم سياق دورة حياة Go في مهام الخلفية أيضًا.

القيمة المعادة

Promise<void>

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

close() → Promise<void>

الغرض

يوقف هذه النسخة ومهام الخلفية مع الاحتفاظ بالدخول المحفوظ وربط الجهاز.

القيمة المعادة

Promise<void>

لا يعيد قيمة عمل؛ الإغلاق العادي لا يؤكد خروج الحساب أو تحرير الجهاز.

new Application(launch: LaunchConfig, product: PublicProductConfig, options?: Options) → Application

الغرض

يتحقق من الإعدادات العامة وينشئ التطبيق، دون تسجيل الدخول أو السماح بالوظائف المحمية.

المعاملات

• launch, product: كائن إعداد أو محول تشغيل أو نقل أو طلب، للتكامل المتقدم فقط.
• options / config: خيارات تخزين الجلسة والدليل الخاص والإلغاء والمحاولات أو المكونات المتقدمة.

القيمة المعادة

Application

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

Application.fromFiles(launchPath: string, productPath: string, options?: Options) → Promise<Application>

الغرض

يقرأ ملفي إعدادات عامة موجودين ويتحقق من ربط المنتجات وينشئ التطبيق. الاتصال المباشر لا يتطلب ملفات.

المعاملات

• launchPath, productPath: مسارات الإعدادات المختارة أو دليل الذاكرة والتخزين الخاص بالمستخدم الحالي.
• options / config: خيارات تخزين الجلسة والدليل الخاص والإلغاء والمحاولات أو المكونات المتقدمة.

القيمة المعادة

Promise<Application>

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

validateConfig(launch: LaunchConfig, product: PublicProductConfig) → {launch: LaunchConfig, product: PublicProductConfig}

الغرض

يتحقق من الإعدادات العامة أو يقرؤها؛ يجب تطابق المنتجات والبيئة ومفاتيح التوقيع.

المعاملات

• launch, product: كائن إعداد أو محول تشغيل أو نقل أو طلب، للتكامل المتقدم فقط.

القيمة المعادة

{launch: LaunchConfig, product: PublicProductConfig}

يعيد نوع القيمة المحدد في التوقيع؛ النتيجة لا تمنح إذن وظيفة.

loadConfig(launchPath: string, productPath: string) → Promise<{launch: LaunchConfig, product: PublicProductConfig}>

الغرض

يتحقق من الإعدادات العامة أو يقرؤها؛ يجب تطابق المنتجات والبيئة ومفاتيح التوقيع.

المعاملات

• launchPath, productPath: مسارات الإعدادات المختارة أو دليل الذاكرة والتخزين الخاص بالمستخدم الحالي.

القيمة المعادة

Promise<{launch: LaunchConfig, product: PublicProductConfig}>

يعيد نوع القيمة المحدد في التوقيع؛ النتيجة لا تمنح إذن وظيفة.

defaultTransport(request: Request) → Promise<Response>

الغرض

يرسل طلبات HTTP للحساب ويعيد الحالة والترويسات أو المحتوى الخام، دون اتخاذ قرار تفويض.

المعاملات

• request: كائن إعداد أو محول تشغيل أو نقل أو طلب، للتكامل المتقدم فقط.

القيمة المعادة

Promise<Response>

يعيد نوع القيمة المحدد في التوقيع؛ النتيجة لا تمنح إذن وظيفة.

new MemoryStore() → MemoryStore

الغرض

ينشئ مخزن جلسات صالحًا داخل العملية الحالية فقط.

القيمة المعادة

MemoryStore

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

new EncryptedFileStore(directory: string, key: Uint8Array) → EncryptedFileStore

الغرض

ينشئ مخزن جلسات دائمًا ومحميًا؛ احصل على مفتاح التشفير من خزنة بيانات اعتماد نظام التشغيل.

المعاملات

• directory: مسارات الإعدادات المختارة أو دليل الذاكرة والتخزين الخاص بالمستخدم الحالي.
• key: مفتاح تشفير من خزنة نظام التشغيل؛ لا تخزنه بجانب السجلات المشفرة.

القيمة المعادة

EncryptedFileStore

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

new LaunchError(code: string, status=0, retryAfterSeconds=0) → LaunchError

الغرض

ينشئ أو يقرأ خطأ منظمًا للتصنيف والتأخير وربط التشخيص.

المعاملات

• code, status, retryAfterSeconds: ينشئ أو يقرأ خطأ منظمًا للتصنيف والتأخير وربط التشخيص.

القيمة المعادة

LaunchError

يعيد نوع القيمة المحدد في التوقيع؛ النتيجة لا تمنح إذن وظيفة.

load(scope: string) → Promise<SavedSession | null>

الغرض

يحمل سجل الحساب بمفتاح معزول؛ يتضمن أسرارًا مخصصة لـ SDK فقط.

المعاملات

• scope / key, value / record: مفاتيح العزل والسجلات السرية لـ SDK؛ يجب أن يدعم التخزين المخصص مفاتيح متعددة واستبدالًا ذريًا.

القيمة المعادة

Promise<SavedSession | null>

يعيد السجل السري؛ عند الغياب يعيد قيمة فارغة أو ErrNoSession حسب اللغة.

save(scope: string, value: SavedSession) → Promise<void>

الغرض

يحفظ سجل الحساب ذريًا باستخدام مفتاحه المعزول.

المعاملات

• scope / key, value / record: مفاتيح العزل والسجلات السرية لـ SDK؛ يجب أن يدعم التخزين المخصص مفاتيح متعددة واستبدالًا ذريًا.

القيمة المعادة

Promise<void>

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

delete(scope: string) → Promise<void>

الغرض

يحذف سجل الحساب مع إبقاء ذاكرة تفويض SDK الرسمي وسجل الخروج.

المعاملات

• scope / key, value / record: مفاتيح العزل والسجلات السرية لـ SDK؛ يجب أن يدعم التخزين المخصص مفاتيح متعددة واستبدالًا ذريًا.

القيمة المعادة

Promise<void>

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

status() → {allowed:boolean,state:string} | Promise<{allowed:boolean,state:string}>

الغرض

يقرأ حالة التفويض الحالية في SDK الرسمي، دون تسجيل دخول أو استبدال فحص الوظيفة.

القيمة المعادة

{allowed:boolean,state:string} | Promise<{allowed:boolean,state:string}>

يقرأ حالة التفويض الحالية في SDK الرسمي، دون تسجيل دخول أو استبدال فحص الوظيفة.

start(onError?: (error: unknown) => void, signal?: AbortSignal) → Promise<unknown>

الغرض

يشغل التحقق والصيانة الخلفية لـ SDK الرسمي؛ للدخول وحماية الوظائف واجهات منفصلة.

المعاملات

• onError: ينشئ أو يقرأ خطأ منظمًا للتصنيف والتأخير وربط التشخيص.
• ctx / ct / signal / cancellation: سياق الطلب أو إشارة الإلغاء؛ يتحكم سياق دورة حياة Go في مهام الخلفية أيضًا.

القيمة المعادة

Promise<unknown>

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

runFeature<T>(name: string, action: () => T | Promise<T>) → Promise<T>

الغرض

يتحقق SDK الرسمي من الإذن عند كل تنفيذ، ولا يشغل الاستدعاء إلا عند السماح.

المعاملات

• feature / name, action / block: اسم الوظيفة يطابق السياسة؛ يحتوي الاستدعاء على العمل المحمي الفعلي.

القيمة المعادة

Promise<T>

يعيد نتيجة استدعاء العمل؛ تبلغ إخفاقات التفويض واستثناءات العمل كأخطاء.

deactivate(signal?: AbortSignal) → Promise<unknown>

الغرض

ينفذ خروج الجهاز عبر SDK الرسمي؛ يلغي التطبيق جلسة حساب Launch بصورة منفصلة.

المعاملات

• ctx / ct / signal / cancellation: سياق الطلب أو إشارة الإلغاء؛ يتحكم سياق دورة حياة Go في مهام الخلفية أيضًا.

القيمة المعادة

Promise<unknown>

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

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.

close() → Promise<unknown>

الغرض

يوقف هذه النسخة ومهام الخلفية مع الاحتفاظ بالدخول المحفوظ وربط الجهاز.

القيمة المعادة

Promise<unknown>

لا يعيد قيمة عمل؛ الإغلاق العادي لا يؤكد خروج الحساب أو تحرير الجهاز.

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، يملؤه كود التكامل الإداري تلقائيًا.
• licentivoProductID / licentivo_product_id: معرف منتج ترخيص Licentivo، ويجب أن يطابق إعداد التوقيع العام.
• trustedKeys / trusted_keys: ربط معرفات مفاتيح التوقيع بالمفاتيح العامة للتحقق من أذونات SDK الرسمي الموقعة.
• environment: sandbox أو live؛ يجب توحيد البيئة للحساب والمنتجات والذاكرة المؤقتة.

القيمة المعادة

Result<Application, Failure>

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

login(&mut self, email: &str, password: &str) → Result<State, Failure>

الغرض

يسجل الدخول بحساب المتجر ويحصل على إثبات هوية قصير العمر ويشغل SDK الرسمي للتفويض.

المعاملات

• email, password: بريد العميل وكلمة مروره في هذا المتجر؛ تستخدم كلمة المرور لهذا الدخول فقط.

القيمة المعادة

Result<State, Failure>

يعيد حالة الحساب؛ راجع جدول الحقول أدناه.

restore(&mut self) → Result<State, Failure>

الغرض

يقرأ الجلسة المحفوظة ويؤكد الحساب عبر الإنترنت ويحصل على إثبات جديد ويشغل SDK الرسمي.

القيمة المعادة

Result<State, Failure>

يعيد حالة الحساب؛ تعني ErrNoSession أو NO_SESSION عدم وجود جلسة محفوظة. عالج الأخطاء الأخرى منفصلة.

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>

يعيد نتيجة استدعاء العمل؛ تبلغ إخفاقات التفويض واستثناءات العمل كأخطاء.

logout(&mut self) → Result<(), Failure>

الغرض

يوقف التفويض المحلي ويخرج من SDK الرسمي ثم يلغي جلسة Launch. يحتفظ بالمهام البعيدة غير المكتملة لإعادة المحاولة.

القيمة المعادة

Result<(), Failure>

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

release_device(&mut self) → Result<(), Failure>

الغرض

مدخل توافق للخروج الصريح ينفذ مسار خروج الحساب والجهاز نفسه الذي ينفذه Logout.

القيمة المعادة

Result<(), Failure>

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

close(&mut self) / drop(&mut self) → ()

الغرض

يوقف هذه النسخة ومهام الخلفية مع الاحتفاظ بالدخول المحفوظ وربط الجهاز.

القيمة المعادة

()

لا يعيد قيمة عمل؛ الإغلاق العادي لا يؤكد خروج الحساب أو تحرير الجهاز.

Application::new(config: Config, product: Value, cache_root: PathBuf) → Result<Application, Failure>

الغرض

يتحقق من الإعدادات العامة وينشئ التطبيق، دون تسجيل الدخول أو السماح بالوظائف المحمية.

المعاملات

• config, product: كائن إعداد أو محول تشغيل أو نقل أو طلب، للتكامل المتقدم فقط.
• cache_root: مسارات الإعدادات المختارة أو دليل الذاكرة والتخزين الخاص بالمستخدم الحالي.

القيمة المعادة

Result<Application, Failure>

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

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(origin: &str, product: &str, runtime_product: &str, environment: &str) → Result<Config, Failure>

الغرض

يتحقق من الإعدادات العامة أو يقرؤها؛ يجب تطابق المنتجات والبيئة ومفاتيح التوقيع.

المعاملات

• merchantOrigin / origin: عنوان أصل المتجر الحالي كاملًا بالبروتوكول والمنفذ اللازم؛ استخدم HTTPS في الإنتاج.
• productID / product_id: معرف منتج متجر Launch، يملؤه كود التكامل الإداري تلقائيًا.
• licentivoProductID / licentivo_product_id: معرف منتج ترخيص Licentivo، ويجب أن يطابق إعداد التوقيع العام.
• environment: sandbox أو live؛ يجب توحيد البيئة للحساب والمنتجات والذاكرة المؤقتة.

القيمة المعادة

Result<Config, Failure>

يعيد نوع القيمة المحدد في التوقيع؛ النتيجة لا تمنح إذن وظيفة.

Config::load(path: impl AsRef<Path>) → Result<Config, Failure>

الغرض

يتحقق من الإعدادات العامة أو يقرؤها؛ يجب تطابق المنتجات والبيئة ومفاتيح التوقيع.

المعاملات

• path: مسارات الإعدادات المختارة أو دليل الذاكرة والتخزين الخاص بالمستخدم الحالي.

القيمة المعادة

Result<Config, Failure>

يعيد نوع القيمة المحدد في التوقيع؛ النتيجة لا تمنح إذن وظيفة.

read_public(path: impl AsRef<Path>) → Result<Value, Failure>

الغرض

يتحقق من الإعدادات العامة أو يقرؤها؛ يجب تطابق المنتجات والبيئة ومفاتيح التوقيع.

المعاملات

• path: مسارات الإعدادات المختارة أو دليل الذاكرة والتخزين الخاص بالمستخدم الحالي.

القيمة المعادة

Result<Value, Failure>

يعيد نوع القيمة المحدد في التوقيع؛ النتيجة لا تمنح إذن وظيفة.

MemoryStore::default() → MemoryStore

الغرض

ينشئ مخزن جلسات صالحًا داخل العملية الحالية فقط.

القيمة المعادة

MemoryStore

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

EncryptedFileStore::new(root: PathBuf, vault_key: [u8;32]) → Result<EncryptedFileStore, Failure>

الغرض

ينشئ مخزن جلسات دائمًا ومحميًا؛ احصل على مفتاح التشفير من خزنة بيانات اعتماد نظام التشغيل.

المعاملات

• root: مسارات الإعدادات المختارة أو دليل الذاكرة والتخزين الخاص بالمستخدم الحالي.
• vault_key: مفتاح تشفير من خزنة نظام التشغيل؛ لا تخزنه بجانب السجلات المشفرة.

القيمة المعادة

Result<EncryptedFileStore, Failure>

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

CurlTransport::new() → Result<CurlTransport, Failure>

الغرض

يرسل طلبات HTTP للحساب ويعيد الحالة والترويسات أو المحتوى الخام، دون اتخاذ قرار تفويض.

القيمة المعادة

Result<CurlTransport, Failure>

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

request(&mut self, method: &str, url: &str, bearer: &str, body: &[u8]) → Result<Response, Failure>

الغرض

يرسل طلبات HTTP للحساب ويعيد الحالة والترويسات أو المحتوى الخام، دون اتخاذ قرار تفويض.

المعاملات

• method, url, bearer, body: كائن إعداد أو محول تشغيل أو نقل أو طلب، للتكامل المتقدم فقط.

القيمة المعادة

Result<Response, Failure>

يعيد نوع القيمة المحدد في التوقيع؛ النتيجة لا تمنح إذن وظيفة.

Failure::new(code: &str) → Failure

الغرض

ينشئ أو يقرأ خطأ منظمًا للتصنيف والتأخير وربط التشخيص.

المعاملات

• code: ينشئ أو يقرأ خطأ منظمًا للتصنيف والتأخير وربط التشخيص.

القيمة المعادة

Failure

يعيد نوع القيمة المحدد في التوقيع؛ النتيجة لا تمنح إذن وظيفة.

sleep(&mut self, duration: Duration) → Result<(), Failure>

الغرض

ينتظر المدة المحددة لجدولة المحاولات المتقدمة.

المعاملات

• duration: مدة الانتظار المقترحة للمحاولة؛ ميز بين الثواني والمللي ثانية وDuration حسب اللغة.

القيمة المعادة

Result<(), Failure>

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

load(&mut self, scope: &str) → Result<Option<Vec<u8>>, Failure>

الغرض

يحمل سجل الحساب بمفتاح معزول؛ يتضمن أسرارًا مخصصة لـ SDK فقط.

المعاملات

• scope / key, value / record: مفاتيح العزل والسجلات السرية لـ SDK؛ يجب أن يدعم التخزين المخصص مفاتيح متعددة واستبدالًا ذريًا.

القيمة المعادة

Result<Option<Vec<u8>>, Failure>

يعيد السجل السري؛ عند الغياب يعيد قيمة فارغة أو ErrNoSession حسب اللغة.

save(&mut self, scope: &str, value: &[u8]) → Result<(), Failure>

الغرض

يحفظ سجل الحساب ذريًا باستخدام مفتاحه المعزول.

المعاملات

• scope / key, value / record: مفاتيح العزل والسجلات السرية لـ SDK؛ يجب أن يدعم التخزين المخصص مفاتيح متعددة واستبدالًا ذريًا.

القيمة المعادة

Result<(), Failure>

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

delete(&mut self, scope: &str) → Result<(), Failure>

الغرض

يحذف سجل الحساب مع إبقاء ذاكرة تفويض SDK الرسمي وسجل الخروج.

المعاملات

• scope / key, value / record: مفاتيح العزل والسجلات السرية لـ SDK؛ يجب أن يدعم التخزين المخصص مفاتيح متعددة واستبدالًا ذريًا.

القيمة المعادة

Result<(), Failure>

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

run_feature(&mut self, feature: &str, action: &mut dyn FnMut() -> Result<(),Failure>) → Result<(), Failure>

الغرض

يتحقق SDK الرسمي من الإذن عند كل تنفيذ، ولا يشغل الاستدعاء إلا عند السماح.

المعاملات

• feature / name, action / block: اسم الوظيفة يطابق السياسة؛ يحتوي الاستدعاء على العمل المحمي الفعلي.

القيمة المعادة

Result<(), Failure>

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

release_device(&mut self) → Result<(), Failure>

الغرض

ينفذ خروج الجهاز عبر SDK الرسمي؛ يلغي التطبيق جلسة حساب Launch بصورة منفصلة.

القيمة المعادة

Result<(), Failure>

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

close(&mut self) → ()

الغرض

يوقف هذه النسخة ومهام الخلفية مع الاحتفاظ بالدخول المحفوظ وربط الجهاز.

القيمة المعادة

()

لا يعيد قيمة عمل؛ الإغلاق العادي لا يؤكد خروج الحساب أو تحرير الجهاز.

open(&mut self, settings: &Value, cached_only: bool) → Result<Box<dyn Runtime>, Failure>

الغرض

ينشئ محول SDK الرسمي للتكامل المتقدم؛ يمرر إثبات الهوية في الذاكرة فقط.

المعاملات

• settings, cached_only: كائن إعداد أو محول تشغيل أو نقل أو طلب، للتكامل المتقدم فقط.

القيمة المعادة

Result<Box<dyn Runtime>, Failure>

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

for_logout(&mut self, settings: &Value) → Result<Box<dyn Runtime>, Failure>

الغرض

ينشئ محول SDK الرسمي للتكامل المتقدم؛ يمرر إثبات الهوية في الذاكرة فقط.

المعاملات

• settings: كائن إعداد أو محول تشغيل أو نقل أو طلب، للتكامل المتقدم فقط.

القيمة المعادة

Result<Box<dyn Runtime>, Failure>

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

sleep(&mut self, duration: Duration) → Result<(), Failure>

الغرض

ينتظر المدة المحددة لجدولة المحاولات المتقدمة.

المعاملات

• duration: مدة الانتظار المقترحة للمحاولة؛ ميز بين الثواني والمللي ثانية وDuration حسب اللغة.

القيمة المعادة

Result<(), Failure>

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

LicentivoLaunch::Application.connect(merchant_origin, product_id, licentivo_product_id, trusted_keys, environment: "live", **options) → Application

الغرض

يتحقق من الإعدادات العامة وينشئ التطبيق، دون تسجيل الدخول أو السماح بالوظائف المحمية.

المعاملات

• merchantOrigin / origin: عنوان أصل المتجر الحالي كاملًا بالبروتوكول والمنفذ اللازم؛ استخدم HTTPS في الإنتاج.
• productID / product_id: معرف منتج متجر Launch، يملؤه كود التكامل الإداري تلقائيًا.
• licentivoProductID / licentivo_product_id: معرف منتج ترخيص Licentivo، ويجب أن يطابق إعداد التوقيع العام.
• trustedKeys / trusted_keys: ربط معرفات مفاتيح التوقيع بالمفاتيح العامة للتحقق من أذونات SDK الرسمي الموقعة.
• environment: sandbox أو live؛ يجب توحيد البيئة للحساب والمنتجات والذاكرة المؤقتة.
• options / config: خيارات تخزين الجلسة والدليل الخاص والإلغاء والمحاولات أو المكونات المتقدمة.

القيمة المعادة

Application

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

login(email, password, cancellation: nil) → Hash

الغرض

يسجل الدخول بحساب المتجر ويحصل على إثبات هوية قصير العمر ويشغل SDK الرسمي للتفويض.

المعاملات

• email, password: بريد العميل وكلمة مروره في هذا المتجر؛ تستخدم كلمة المرور لهذا الدخول فقط.
• ctx / ct / signal / cancellation: سياق الطلب أو إشارة الإلغاء؛ يتحكم سياق دورة حياة Go في مهام الخلفية أيضًا.

القيمة المعادة

Hash

يعيد حالة الحساب؛ راجع جدول الحقول أدناه.

restore(cancellation: nil) → Hash | nil

الغرض

يقرأ الجلسة المحفوظة ويؤكد الحساب عبر الإنترنت ويحصل على إثبات جديد ويشغل SDK الرسمي.

المعاملات

• ctx / ct / signal / cancellation: سياق الطلب أو إشارة الإلغاء؛ يتحكم سياق دورة حياة Go في مهام الخلفية أيضًا.

القيمة المعادة

Hash | nil

يعيد حالة الحساب؛ تعني null أو nil عدم وجود جلسة قابلة للاستعادة. تبلغ الإخفاقات الأخرى كأخطاء.

run_feature(feature) { ... } → T

الغرض

يتحقق SDK الرسمي من الإذن عند كل تنفيذ، ولا يشغل الاستدعاء إلا عند السماح.

المعاملات

• feature / name, action / block: اسم الوظيفة يطابق السياسة؛ يحتوي الاستدعاء على العمل المحمي الفعلي.

القيمة المعادة

T

يعيد نتيجة استدعاء العمل؛ تبلغ إخفاقات التفويض واستثناءات العمل كأخطاء.

logout(cancellation: nil) → true | false

الغرض

يوقف التفويض المحلي ويخرج من SDK الرسمي ثم يلغي جلسة Launch. يحتفظ بالمهام البعيدة غير المكتملة لإعادة المحاولة.

المعاملات

• ctx / ct / signal / cancellation: سياق الطلب أو إشارة الإلغاء؛ يتحكم سياق دورة حياة Go في مهام الخلفية أيضًا.

القيمة المعادة

true | false

تؤكد true الخروج؛ وتعني false أن خروج الحساب البعيد أو إلغاء الجهاز معلق. قد تحدث أخطاء تخزين أيضًا.

release_device(cancellation: nil) → true | false

الغرض

مدخل توافق للخروج الصريح ينفذ مسار خروج الحساب والجهاز نفسه الذي ينفذه Logout.

المعاملات

• ctx / ct / signal / cancellation: سياق الطلب أو إشارة الإلغاء؛ يتحكم سياق دورة حياة Go في مهام الخلفية أيضًا.

القيمة المعادة

true | false

تؤكد true الخروج؛ وتعني false أن خروج الحساب البعيد أو إلغاء الجهاز معلق. قد تحدث أخطاء تخزين أيضًا.

close → nil

الغرض

يوقف هذه النسخة ومهام الخلفية مع الاحتفاظ بالدخول المحفوظ وربط الجهاز.

القيمة المعادة

nil

لا يعيد قيمة عمل؛ الإغلاق العادي لا يؤكد خروج الحساب أو تحرير الجهاز.

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(launch_path, product_path, **options) → Application

الغرض

يقرأ ملفي إعدادات عامة موجودين ويتحقق من ربط المنتجات وينشئ التطبيق. الاتصال المباشر لا يتطلب ملفات.

المعاملات

• launchPath, productPath: مسارات الإعدادات المختارة أو دليل الذاكرة والتخزين الخاص بالمستخدم الحالي.
• options / config: خيارات تخزين الجلسة والدليل الخاص والإلغاء والمحاولات أو المكونات المتقدمة.

القيمة المعادة

Application

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

LicentivoLaunch.origin(value, environment) → String

الغرض

يتحقق من الإعدادات العامة أو يقرؤها؛ يجب تطابق المنتجات والبيئة ومفاتيح التوقيع.

المعاملات

• value: عنوان أصل المتجر الحالي كاملًا بالبروتوكول والمنفذ اللازم؛ استخدم HTTPS في الإنتاج.
• environment: sandbox أو live؛ يجب توحيد البيئة للحساب والمنتجات والذاكرة المؤقتة.

القيمة المعادة

String

يعيد نوع القيمة المحدد في التوقيع؛ النتيجة لا تمنح إذن وظيفة.

LicentivoLaunch.validate_config(launch, product) → [Hash, Hash]

الغرض

يتحقق من الإعدادات العامة أو يقرؤها؛ يجب تطابق المنتجات والبيئة ومفاتيح التوقيع.

المعاملات

• launch, product: كائن إعداد أو محول تشغيل أو نقل أو طلب، للتكامل المتقدم فقط.

القيمة المعادة

[Hash, Hash]

يعيد نوع القيمة المحدد في التوقيع؛ النتيجة لا تمنح إذن وظيفة.

LicentivoLaunch.load_config(launch_path, product_path) → [Hash, Hash]

الغرض

يتحقق من الإعدادات العامة أو يقرؤها؛ يجب تطابق المنتجات والبيئة ومفاتيح التوقيع.

المعاملات

• launchPath, productPath: مسارات الإعدادات المختارة أو دليل الذاكرة والتخزين الخاص بالمستخدم الحالي.

القيمة المعادة

[Hash, Hash]

يعيد نوع القيمة المحدد في التوقيع؛ النتيجة لا تمنح إذن وظيفة.

LicentivoLaunch.default_transport(request) → Hash

الغرض

يرسل طلبات HTTP للحساب ويعيد الحالة والترويسات أو المحتوى الخام، دون اتخاذ قرار تفويض.

المعاملات

• request: كائن إعداد أو محول تشغيل أو نقل أو طلب، للتكامل المتقدم فقط.

القيمة المعادة

Hash

يعيد نوع القيمة المحدد في التوقيع؛ النتيجة لا تمنح إذن وظيفة.

MemoryStore.new → MemoryStore

الغرض

ينشئ مخزن جلسات صالحًا داخل العملية الحالية فقط.

القيمة المعادة

MemoryStore

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

EncryptedFileStore.new(directory, key) → EncryptedFileStore

الغرض

ينشئ مخزن جلسات دائمًا ومحميًا؛ احصل على مفتاح التشفير من خزنة بيانات اعتماد نظام التشغيل.

المعاملات

• directory: مسارات الإعدادات المختارة أو دليل الذاكرة والتخزين الخاص بالمستخدم الحالي.
• key: مفتاح تشفير من خزنة نظام التشغيل؛ لا تخزنه بجانب السجلات المشفرة.

القيمة المعادة

EncryptedFileStore

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

persistent? / secure? → true | false

الغرض

يتحقق من الإعدادات العامة أو يقرؤها؛ يجب تطابق المنتجات والبيئة ومفاتيح التوقيع.

القيمة المعادة

true | false

يعيد تصنيفًا منطقيًا، وليس تفويضًا.

path(scope) → String

الغرض

يتحقق من الإعدادات العامة أو يقرؤها؛ يجب تطابق المنتجات والبيئة ومفاتيح التوقيع.

المعاملات

• scope: مفاتيح العزل والسجلات السرية لـ SDK؛ يجب أن يدعم التخزين المخصص مفاتيح متعددة واستبدالًا ذريًا.

القيمة المعادة

String

يعيد نوع القيمة المحدد في التوقيع؛ النتيجة لا تمنح إذن وظيفة.

CancellationToken.new.cancel / check! → true / nil

الغرض

يطلب الإلغاء التعاوني أو يتحقق منه؛ الإلغاء ليس نجاحًا في التفويض.

القيمة المعادة

true / nil

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

Error.new(code, status: 0, retry_after_seconds: 0) → Error

الغرض

ينشئ أو يقرأ خطأ منظمًا للتصنيف والتأخير وربط التشخيص.

المعاملات

• code, status, retry_after_seconds: ينشئ أو يقرأ خطأ منظمًا للتصنيف والتأخير وربط التشخيص.

القيمة المعادة

Error

يعيد نوع القيمة المحدد في التوقيع؛ النتيجة لا تمنح إذن وظيفة.

load(scope) → Hash | nil

الغرض

يحمل سجل الحساب بمفتاح معزول؛ يتضمن أسرارًا مخصصة لـ SDK فقط.

المعاملات

• scope / key, value / record: مفاتيح العزل والسجلات السرية لـ SDK؛ يجب أن يدعم التخزين المخصص مفاتيح متعددة واستبدالًا ذريًا.

القيمة المعادة

Hash | nil

يعيد السجل السري؛ عند الغياب يعيد قيمة فارغة أو ErrNoSession حسب اللغة.

save(scope, record) → Object

الغرض

يحفظ سجل الحساب ذريًا باستخدام مفتاحه المعزول.

المعاملات

• scope / key, value / record: مفاتيح العزل والسجلات السرية لـ SDK؛ يجب أن يدعم التخزين المخصص مفاتيح متعددة واستبدالًا ذريًا.

القيمة المعادة

Object

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

delete(scope) → Object

الغرض

يحذف سجل الحساب مع إبقاء ذاكرة تفويض SDK الرسمي وسجل الخروج.

المعاملات

• scope / key, value / record: مفاتيح العزل والسجلات السرية لـ SDK؛ يجب أن يدعم التخزين المخصص مفاتيح متعددة واستبدالًا ذريًا.

القيمة المعادة

Object

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

launch_application_connect(origin, product_id, licentivo_product_id, trusted_keys_json, environment, remember, store) → launch_application *

الغرض

يتحقق من الإعدادات العامة وينشئ التطبيق، دون تسجيل الدخول أو السماح بالوظائف المحمية.

المعاملات

• merchantOrigin / origin: عنوان أصل المتجر الحالي كاملًا بالبروتوكول والمنفذ اللازم؛ استخدم HTTPS في الإنتاج.
• productID / product_id: معرف منتج متجر Launch، يملؤه كود التكامل الإداري تلقائيًا.
• licentivoProductID / licentivo_product_id: معرف منتج ترخيص Licentivo، ويجب أن يطابق إعداد التوقيع العام.
• trustedKeys / trusted_keys: ربط معرفات مفاتيح التوقيع بالمفاتيح العامة للتحقق من أذونات SDK الرسمي الموقعة.
• environment: sandbox أو live؛ يجب توحيد البيئة للحساب والمنتجات والذاكرة المؤقتة.
• remember, store: خيارات تخزين الجلسة والدليل الخاص والإلغاء والمحاولات أو المكونات المتقدمة.

القيمة المعادة

launch_application *

يعيد مؤشر تطبيق مملوكًا؛ تعني NULL فشل التهيئة. حرره باستخدام close.

launch_application_login(launch_application *app, const char *email, const char *password) → int

الغرض

يسجل الدخول بحساب المتجر ويحصل على إثبات هوية قصير العمر ويشغل SDK الرسمي للتفويض.

المعاملات

• email, password: بريد العميل وكلمة مروره في هذا المتجر؛ تستخدم كلمة المرور لهذا الدخول فقط.

القيمة المعادة

int

1 نجاح و0 فشل. اقرأ رمز الخطأ بعد الفشل.

launch_application_restore(launch_application *app) → int

الغرض

يقرأ الجلسة المحفوظة ويؤكد الحساب عبر الإنترنت ويحصل على إثبات جديد ويشغل SDK الرسمي.

القيمة المعادة

int

1 نجاح الاستعادة، و0 لا جلسة، و-1 رفض أو فشل. اقرأ رمز الخطأ بعد الفشل.

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 *app) → int

الغرض

يوقف التفويض المحلي ويخرج من SDK الرسمي ثم يلغي جلسة Launch. يحتفظ بالمهام البعيدة غير المكتملة لإعادة المحاولة.

القيمة المعادة

int

1 نجاح و0 فشل. اقرأ رمز الخطأ بعد الفشل.

launch_application_release_device(launch_application *app) → int

الغرض

مدخل توافق للخروج الصريح ينفذ مسار خروج الحساب والجهاز نفسه الذي ينفذه Logout.

القيمة المعادة

int

1 نجاح و0 فشل. اقرأ رمز الخطأ بعد الفشل.

launch_application_status(launch_application *app) → char *

الغرض

يقرأ حالة التفويض الحالية في SDK الرسمي، دون تسجيل دخول أو استبدال فحص الوظيفة.

القيمة المعادة

char *

يعيد نص JSON مملوكًا؛ حرره باستخدام ln_free_string. دون محرك تكون الحالة login_required وallowed=false.

launch_application_error(const launch_application *app) → const char *

الغرض

ينشئ أو يقرأ خطأ منظمًا للتصنيف والتأخير وربط التشخيص.

القيمة المعادة

const char *

يعيد نص رمز خطأ مستعارًا. لا تحرره ولا تستخدمه بعد إتلاف التطبيق.

launch_application_close(launch_application *app) → void

الغرض

يوقف هذه النسخة ومهام الخلفية مع الاحتفاظ بالدخول المحفوظ وربط الجهاز.

القيمة المعادة

void

لا يعيد قيمة عمل؛ الإغلاق العادي لا يؤكد خروج الحساب أو تحرير الجهاز.

launch_application_open(origin, product_id, product_config_path, environment, remember, store) → launch_application *

الغرض

يقرأ ملفي إعدادات عامة موجودين ويتحقق من ربط المنتجات وينشئ التطبيق. الاتصال المباشر لا يتطلب ملفات.

المعاملات

• origin: عنوان أصل المتجر الحالي كاملًا بالبروتوكول والمنفذ اللازم؛ استخدم HTTPS في الإنتاج.
• product_id: معرف منتج متجر Launch، يملؤه كود التكامل الإداري تلقائيًا.
• product_config_path: مسارات الإعدادات المختارة أو دليل الذاكرة والتخزين الخاص بالمستخدم الحالي.
• environment: sandbox أو live؛ يجب توحيد البيئة للحساب والمنتجات والذاكرة المؤقتة.
• remember, store: خيارات تخزين الجلسة والدليل الخاص والإلغاء والمحاولات أو المكونات المتقدمة.

القيمة المعادة

launch_application *

يعيد مؤشر تطبيق مملوكًا؛ تعني NULL فشل التهيئة. حرره باستخدام close.

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(int argc, char **argv) → launch_application *

الغرض

يقرأ ملفي إعدادات عامة موجودين ويتحقق من ربط المنتجات وينشئ التطبيق. الاتصال المباشر لا يتطلب ملفات.

المعاملات

• argc, argv: كائن إعداد أو محول تشغيل أو نقل أو طلب، للتكامل المتقدم فقط.

القيمة المعادة

launch_application *

يعيد مؤشر تطبيق مملوكًا؛ تعني NULL فشل التهيئة. حرره باستخدام close.

launch_login(account, origin, product_id, config_path, environment, email, password) / launch_sign_in(account, argc, argv) → int

الغرض

واجهة قديمة محفوظة؛ أزيل بروتوكول بيانات الترخيص الطويلة الأجل ولذلك تفشل الطلبات. استخدم Application.

المعاملات

• account, origin, product_id, config_path, environment, email, password, argc, argv: كائن إعداد أو محول تشغيل أو نقل أو طلب، للتكامل المتقدم فقط.

القيمة المعادة

int

يفشل دائمًا؛ انتقل إلى تبادل هوية الحساب.

launch_sign_out(launch_account *account, int clear_cache) → void

الغرض

يوقف هذه النسخة ومهام الخلفية مع الاحتفاظ بالدخول المحفوظ وربط الجهاز.

المعاملات

• account, clear_cache: كائن إعداد أو محول تشغيل أو نقل أو طلب، للتكامل المتقدم فقط.

القيمة المعادة

void

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

ln_free_string(char *value) → void

الغرض

يوقف هذه النسخة ومهام الخلفية مع الاحتفاظ بالدخول المحفوظ وربط الجهاز.

المعاملات

• value: يعيد نص JSON مملوكًا؛ حرره باستخدام ln_free_string. دون محرك تكون الحالة login_required وallowed=false.

القيمة المعادة

void

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

load(void *context, const char *scope, char **record) → int

الغرض

يحمل سجل الحساب بمفتاح معزول؛ يتضمن أسرارًا مخصصة لـ SDK فقط.

المعاملات

• context: كائن إعداد أو محول تشغيل أو نقل أو طلب، للتكامل المتقدم فقط.
• scope, record: مفاتيح العزل والسجلات السرية لـ SDK؛ يجب أن يدعم التخزين المخصص مفاتيح متعددة واستبدالًا ذريًا.

القيمة المعادة

int

1 موجود، 0 غائب، -1 فشل قراءة. يخصص load ذاكرة record ويحررها المستدعي.

save(void *context, const char *scope, const char *record) → int (1: success, 0: failure)

الغرض

يحفظ سجل الحساب ذريًا باستخدام مفتاحه المعزول.

المعاملات

• context: كائن إعداد أو محول تشغيل أو نقل أو طلب، للتكامل المتقدم فقط.
• scope, record: مفاتيح العزل والسجلات السرية لـ SDK؛ يجب أن يدعم التخزين المخصص مفاتيح متعددة واستبدالًا ذريًا.

القيمة المعادة

int (1: success, 0: failure)

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

remove(void *context, const char *scope) → int (1: success, 0: failure)

الغرض

يحذف سجل الحساب مع إبقاء ذاكرة تفويض SDK الرسمي وسجل الخروج.

المعاملات

• context: كائن إعداد أو محول تشغيل أو نقل أو طلب، للتكامل المتقدم فقط.
• scope: مفاتيح العزل والسجلات السرية لـ SDK؛ يجب أن يدعم التخزين المخصص مفاتيح متعددة واستبدالًا ذريًا.

القيمة المعادة

int (1: success, 0: failure)

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

Application::Connect(origin, product, licentivo_product, trusted_keys_json, environment="live", remember=false, store=nullptr) → Application

الغرض

يتحقق من الإعدادات العامة وينشئ التطبيق، دون تسجيل الدخول أو السماح بالوظائف المحمية.

المعاملات

• merchantOrigin / origin: عنوان أصل المتجر الحالي كاملًا بالبروتوكول والمنفذ اللازم؛ استخدم HTTPS في الإنتاج.
• productID / product_id: معرف منتج متجر Launch، يملؤه كود التكامل الإداري تلقائيًا.
• licentivoProductID / licentivo_product_id: معرف منتج ترخيص Licentivo، ويجب أن يطابق إعداد التوقيع العام.
• trustedKeys / trusted_keys: ربط معرفات مفاتيح التوقيع بالمفاتيح العامة للتحقق من أذونات SDK الرسمي الموقعة.
• environment: sandbox أو live؛ يجب توحيد البيئة للحساب والمنتجات والذاكرة المؤقتة.
• remember, store: خيارات تخزين الجلسة والدليل الخاص والإلغاء والمحاولات أو المكونات المتقدمة.

القيمة المعادة

Application

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

Login(const char *email, const char *password) → void

الغرض

يسجل الدخول بحساب المتجر ويحصل على إثبات هوية قصير العمر ويشغل SDK الرسمي للتفويض.

المعاملات

• email, password: بريد العميل وكلمة مروره في هذا المتجر؛ تستخدم كلمة المرور لهذا الدخول فقط.

القيمة المعادة

void

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

Restore() → bool

الغرض

يقرأ الجلسة المحفوظة ويؤكد الحساب عبر الإنترنت ويحصل على إثبات جديد ويشغل SDK الرسمي.

القيمة المعادة

bool

تعني true نجاح الاستعادة وfalse عدم وجود جلسة قابلة للاستعادة. الرفض والانتهاء وفشل الشبكة أخطاء.

RunFeature(const char *feature, Action action) → void

الغرض

يتحقق SDK الرسمي من الإذن عند كل تنفيذ، ولا يشغل الاستدعاء إلا عند السماح.

المعاملات

• feature / name, action / block: اسم الوظيفة يطابق السياسة؛ يحتوي الاستدعاء على العمل المحمي الفعلي.

القيمة المعادة

void

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

Logout() → void

الغرض

يوقف التفويض المحلي ويخرج من SDK الرسمي ثم يلغي جلسة Launch. يحتفظ بالمهام البعيدة غير المكتملة لإعادة المحاولة.

القيمة المعادة

void

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

ReleaseDevice() → void

الغرض

مدخل توافق للخروج الصريح ينفذ مسار خروج الحساب والجهاز نفسه الذي ينفذه Logout.

القيمة المعادة

void

لا يعيد قيمة عمل؛ الإكمال الطبيعي نجاح، والخطأ أو الاستثناء فشل.

Status() → std::string (JSON)

الغرض

يقرأ حالة التفويض الحالية في SDK الرسمي، دون تسجيل دخول أو استبدال فحص الوظيفة.

القيمة المعادة

std::string (JSON)

يقرأ حالة التفويض الحالية في SDK الرسمي، دون تسجيل دخول أو استبدال فحص الوظيفة.

~Application() → void

الغرض

يوقف هذه النسخة ومهام الخلفية مع الاحتفاظ بالدخول المحفوظ وربط الجهاز.

القيمة المعادة

void

لا يعيد قيمة عمل؛ الإغلاق العادي لا يؤكد خروج الحساب أو تحرير الجهاز.

Application(origin, product, config, environment="live", remember=false, store=nullptr) → Application

الغرض

يقرأ ملفي إعدادات عامة موجودين ويتحقق من ربط المنتجات وينشئ التطبيق. الاتصال المباشر لا يتطلب ملفات.

المعاملات

• origin: عنوان أصل المتجر الحالي كاملًا بالبروتوكول والمنفذ اللازم؛ استخدم HTTPS في الإنتاج.
• product: معرف منتج متجر Launch، يملؤه كود التكامل الإداري تلقائيًا.
• config: مسارات الإعدادات المختارة أو دليل الذاكرة والتخزين الخاص بالمستخدم الحالي.
• environment: sandbox أو live؛ يجب توحيد البيئة للحساب والمنتجات والذاكرة المؤقتة.
• remember, store: خيارات تخزين الجلسة والدليل الخاص والإلغاء والمحاولات أو المكونات المتقدمة.

القيمة المعادة

Application

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

explicit Application(launch_application *app) → Application

الغرض

يتحقق من الإعدادات العامة وينشئ التطبيق، دون تسجيل الدخول أو السماح بالوظائف المحمية.

المعاملات

• app: يعيد مؤشر تطبيق مملوكًا؛ تعني NULL فشل التهيئة. حرره باستخدام close.

القيمة المعادة

Application

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

Application::FromFiles(launch, product, remember=false, store=nullptr) → Application

الغرض

يقرأ ملفي إعدادات عامة موجودين ويتحقق من ربط المنتجات وينشئ التطبيق. الاتصال المباشر لا يتطلب ملفات.

المعاملات

• launch, product: مسارات الإعدادات المختارة أو دليل الذاكرة والتخزين الخاص بالمستخدم الحالي.
• remember, store: خيارات تخزين الجلسة والدليل الخاص والإلغاء والمحاولات أو المكونات المتقدمة.

القيمة المعادة

Application

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.

Application(Application&& other) / operator=(Application&& other) → Application / Application&

الغرض

ينقل ملكية التطبيق الأصلي. النسخ معطل والكائن السابق لم يعد يملك المؤشر.

المعاملات

• other: كائن إعداد أو محول تشغيل أو نقل أو طلب، للتكامل المتقدم فقط.

القيمة المعادة

Application / Application&

يعيد الكائن المنشأ؛ التهيئة وحدها لا تعني نجاح التفويض.