عرض مصدر ReactNative/appregistry

<noinclude>{{DISPLAYTITLE:الواجهة AppRegistry في ReactNative}}</noinclude><blockquote>'''ملاحظة''': إذا كنت تستخدم <code>expo-cli</code> فلا يوجد سوى مكوّن إدخال واحد مسجل مسبقًا في <code>AppRegistry</code> ويُتعامل معه تلقائيًا، لذلك فلا حاجة لاستخدام واجهة برمجة التطبيقات (API) هذه.</blockquote>

تمثل الواجهة <code>AppRegistry</code> نقطة دخول [[JavaScript|جافاسكربت]] لتشغيل جميع تطبيقات [[ReactNative|React Native]]. ويجب تسجيل جميع مكونات التطبيق الجذرية مع <code>AppRegistry.registerComponent</code>، ومن ثم يتمكن النظام الأصلي من تحميل التطبيق وتشغيله عن طريق استدعاء الدالة <code>AppRegistry.runApplication</code>.<syntaxhighlight class="react" lang="javascript">import { Text, AppRegistry } from 'react-native';

const App = (props) => (
  <View>
    <Text>App1</Text>
  </View>
);

AppRegistry.registerComponent('Appname', () => App);</syntaxhighlight>

لإيقاف التطبيق عند ازالة واجهة معيّنة <code>[[ReactNative/view|View]]</code>، استدعي الدالة <code>AppRegistry.unmountApplicationComponenetAtRootTag</code> على الوسم الذي مُرّرت سابقًا للدالة <code>runApplication</code>.

يجب أن يكون <code>AppRegistry</code> مطلوبًا في بداية سلسلة المطلوبات <code>require</code> للتأكد من إعداد بيئة التنفيذ إعدادًا صحيحًا قبل أن تكون هناك حاجة لوحدات أخرى.

__toc__

== التوابع ==

=== <code>‎cancelHeadlessTask()‎</code> ===
<syntaxhighlight class="" lang="javascript">static cancelHeadlessTask(taskId, taskKey)</syntaxhighlight>
تُستدعى من الشيفرة الأصلية، وتلغي تنفيذ عملية خلفية بلا واجهة (headless task).

المعامل <code>taskId</code> هو المُعرِّف الخاص بالمهمة المُراد إلغاء تنفيذها (وهي المهمة التي بدأت عند استدعاء الدالة <code>startHeadlessTask</code>، والمعامل <code>taskKey</code> هو المفتاح الخاص بها.

'''المعاملات''' 

{| class="wikitable"
! الاسم
! النوع
! مطلوب
|-
|<code>taskId</code>
| عدد (number)
| نعم
|-
|<code>taskKey</code>
| سلسلة نصية (string)
| نعم
|-
|<code>data</code>
| any
| نعم
|}

===<code>enableArchitectureIndicator()‎</code>===

<syntaxhighlight class="react" lang="javascript">static enableArchitectureIndicator(enabled)</syntaxhighlight>
'''المعاملات'''

{| class="wikitable"
! الاسم
! النوع
! مطلوب
|-
|<code>enabled</code>
| قيمة منطقية (boolean)
| نعم
|}

=== <code>getAppKeys()‎</code> ===
<syntaxhighlight class="react" lang="javascript">static getAppKeys()</syntaxhighlight>
تُرجع مصفوفة من <code>AppKeys</code>.
===<code>‎getSectionKeys()‎</code>===

<syntaxhighlight class="react" lang="javascript">static getSectionKeys()</syntaxhighlight>
تُرجع مصفوفة من سلاسل نصية.
===<code>‎getSections()‎</code>===

<syntaxhighlight class="react" lang="javascript">static getSections()</syntaxhighlight>
تُرجع كائنًا من النوع <code>Runnables</code>.

===<code>‎getRunnable()‎</code>===

<syntaxhighlight class="react" lang="javascript">static getRunnable(appKey)</syntaxhighlight>
تُرجع كائنًا من النوع <code>Runnable</code>.

===<code>‎getRegistry()‎</code>===

<syntaxhighlight class="react" lang="javascript">static getRegistry()</syntaxhighlight>
تُرجع كائنًا من النوع <code>Registry</code> (انظر تعريفات النوع في الأسفل).

=== <code>‎registerCancellableHeadlessTask()‎</code> ===
<syntaxhighlight class="react" lang="javascript">static registerCancellableHeadlessTask(taskKey, taskProvider, taskCancelProvider)</syntaxhighlight>
تسجل عملية في الخلفية بلا واجهة (تدعى headless task) قابلة للإلغاء، وتلك العملية هي شيفرة تُنفّد بدون واجهة مستخدِم، حيث يعد المعامل <code>taskKey</code> المفتاح المرتبط بتلك العملية ويعد المعامل <code>taskProvider</code> و<nowiki/>[[JavaScript/Promise|عدًا]] (promise) يُرجع دالة تأخذ بيانات من الطرف الأصيل من الهاتف (native side) على أنه الوسيط الوحيد. وبعد أن [[JavaScript/Promise/reject|يرفض الوعد]] أو [[JavaScript/Promise/resolve|يُحَل]]، يُرسل إشعار للجانب الأصيل وقد يقرر تدمير سياق جافاسكربت الحالي (JS context). أما المعامل <code>taskCancelProvider</code> فهو دالة تُرجع دالة لا تأخذ معاملات، يغلفها <code>taskProvider</code> ثم يعيدها مباشرةً عندما يُرسل طلب الإلغاء وذلك لتنفيذها.



'''المعاملات'''

{| class="wikitable"
! الاسم
! النوع
! مطلوب
|-
|<code>taskKey</code>
| سلسلة نصية (string)
| نعم
|-
|<code>taskProvider</code>
|<code>TaskProvider</code>
| نعم
|-
|<code>taskCancelProvider</code>
|<code>TaskCancelProvider</code>
| نعم
|}
===<code>registerConfig()‎</code>===

<syntaxhighlight class="react" lang="javascript">static registerConfig([config])</syntaxhighlight>'''المعاملات'''
{| class="wikitable"
! الاسم
! النوع
! مطلوب
|-
|<code>config</code>
|<code>AppConfig</code>
| نعم
|}

===<code>‎registerComponent()‎</code>===

<syntaxhighlight class="react" lang="javascript">static registerComponent(appKey, componentProvider, section?)</syntaxhighlight>
'''المعاملات'''

{| class="wikitable"
! الاسم
! النوع
! مطلوب
|-
|<code>appKey</code>
| سلسلة نصية (string)
| نعم
|-
|<code>componenetProvider</code>
|<code>[[ReactNative/components and apis|ComponentProvider]]</code>
| نعم
|-
|<code>section</code>
| قيمة منطقية (bool)
| لا
|}

=== <code>‎registerHeadlessTask()‎</code> ===
<syntaxhighlight class="react" lang="javascript">static registerHeadlessTask(taskKey, taskProvider)</syntaxhighlight>
تسجل عملية في الخلفية بلا واجهة (تدعى headless task) هي شيفرة تُنفَّذ دون واجهة مستخدم. يعد المعامل <code>taskKey</code> المفتاح المرتبط بتلك العملية، ويعد المعامل <code>taskProvider</code> و<nowiki/>[[JavaScript/Promise|عدًا]] (promise) يُرجع دالة تأخذ بيانات من الطرف الأصيل من الهاتف (native side) على أنه الوسيط الوحيد. وبعد أن [[JavaScript/Promise/reject|يرفض الوعد]] أو [[JavaScript/Promise/resolve|يُحَل]]، يُرسل إشعار للجانب الأصيل وقد يقرر تدمير سياق جافاسكريبت الحالي (JS context).



تُستعمل هذه الدالة لتشغيل بعض المهام في التطبيق أثناء عمله في الخلفية، لمزامنة البيانات أو التعامل مع الإشعارات الفورية أو تشغيل الموسيقى مثلًا.

'''المعاملات'''

{| class="wikitable"
! الاسم
! النوع
! مطلوب
|-
|<code>taskKey</code>
| سلسلة نصية (string)
| نعم
|-
|<code>taskProvider</code>
|<code>TaskProvider</code>
| نعم
|}

===<code>‎registerRunnable()‎</code>===

<syntaxhighlight class="react" lang="javascript">static registerRunnable(appKey, run)</syntaxhighlight>
'''المعاملات:'''

{| class="wikitable"
! الاسم
! النوع
! مطلوب
|-
|<code>appKey</code>
| سلسلة نصية (string)
| نعم
|-
|<code>run</code>
| دالة (function)
| نعم
|}
===<code>registerSection()‎</code>===

<syntaxhighlight class="react" lang="javascript">static registerSection(appKey, component)</syntaxhighlight>
'''المعاملات:'''

{| class="wikitable"
! الاسم
! النوع
! مطلوب
|-
|<code>appKey</code>
| سلسلة نصية (string)
| نعم
|-
|<code>component</code>
|<code>[[ReactNative/components and apis|ComponentProvider]]</code>
| نعم
|}
===<code>runApplication()‎</code>===

<syntaxhighlight class="react" lang="javascript">static runApplication(appKey, appParameters)</syntaxhighlight>
تُحمِّل حزمة تشغيل [[JavaScript|جافاسكربت]] للتطبيق ثم تشغِّله.

'''المعاملات'''

{| class="wikitable"
! الاسم
! النوع
! مطلوب
|-
|<code>appKey</code>
| سلسلة نصية (string)
| نعم
|-
|<code>appParameters</code>
| any
| نعم
|}
===<code>‎setComponentProviderInstrumentationHook()‎</code>===

<syntaxhighlight class="react" lang="javascript">static setComponentProviderInstrumentationHook(hook)</syntaxhighlight>
'''المعاملات:'''

{| class="wikitable"
! الاسم
! النوع
! مطلوب
|-
|<code>hook</code>
| دالة (function)
| نعم
|}

يحتوي الخطاف <code>hook</code> على المكونات التالية:

*<code>component</code> من النوع <code>ComponentProvider</code> (مطلوب).
*<code>ScopedPerformanceLogger</code>من النوع <code>IPerformanceLogger</code> (مطلوب).

تُرجع الدالة <code>hook</code> مكوِّن <code>[[React]]</code>.

=== <code>setWrapperComponentProvider()‎</code> ===
<syntaxhighlight class="react" lang="javascript">static setWrapperComponenetProvider(provider)</syntaxhighlight>
'''المعاملات'''

{| class="wikitable"
! الاسم
! النوع
! مطلوب
|-
| <code>provider</code>
| [[ReactNative/components and apis|<code>ComponentProvider</code>]]
| نعم
|}
=== <code>startHeadlessTask()‎</code> ===

<syntaxhighlight class="react" lang="javascript">static startHeadlessTask(taskId, taskKey, data)</syntaxhighlight>
تُستدعى من الشيفرة الأصلية (native code)، وتبدأ تنفيذ <code>headless task</code>.

المعامل <code>taskId</code> هو المُعرِّف الخاص بالمهمة المُراد بدؤها، والمعامل <code>taskKey</code> هو المفتاح الخاص بها، أمّا المعامل <code>data</code> فهو البيانات التي يجب إرسالها للمهمة المراد تنفيذها.

'''المعاملات:'''

{| class="wikitable"
! الاسم
! النوع
! مطلوب
|-
| <code>taskId</code>
| عدد (number)
| نعم
|-
| <code>taskKey</code>
| سلسلة نصية (string)
| نعم
|-
| <code>data</code>
| any
| نعم
|}
=== <code>unmountApplicationComponentAtRootTag()‎</code> ===

<syntaxhighlight class="react" lang="javascript">static unmountApplicationComponentAtRootTag(rootTag)</syntaxhighlight>
توقِف التطبيق عند وجوب تدمير واجهة معينة.

'''المعاملات:'''

{| class="wikitable"
! الاسم
! النوع
! مطلوب
|-
| <code>rootTag</code>
| عدد (number)
| نعم
|}

== تعريفات الواجهة ==

=== <code>AppConfig</code> ===
كائنٌ يمثل ضبط التطبيق للتابع <code>registerConfig</code>.

المفاتيح (الخاصيات) الصالحة للاستخدام مع الكائن <code>AppConfig</code>:
{| class="wikitable"
! الاسم
! النوع
! مطلوب
|-
|<code>appKey</code>
| سلسلة نصية (string)
| نعم
|-
|<code>component</code>
|<code>ComponentProvider</code>
| لا
|-
|<code>run</code>
| دالة (function)
| لا
|-
|<code>section</code>
| قيمة منطقية (bool)
| لا
|}
'''ملاحظة''': يُتوقع من كل كائن ضبط أن يحوي إما <code>component</code> أو <code>run</code>.

=== <code>Registry</code> ===
كائن والذي يحتوي على الخاصيات التالية:
{| class="wikitable"
! الاسم
! النوع
|-
|<code>runnables</code>
| مصفوفة من النوع Runnables
|-
|<code>sections</code>
| مصفوفة من سلاسل نصية
|}

=== <code>Runnable</code> ===
كائن والذي يحتوي على الخاصيات التالية:
{| class="wikitable"
! الاسم
! النوع
|-
|<code>component</code>
| النوع <code>ComponentProvider</code>
|-
|<code>run</code>
| دالة
|}

=== <code>Runnables</code> ===
كائن يحتوي على مفتاح <code>appKey</code> وقيمة من نوع <code>Runnable</code>.

=== <code>Task</code> ===
الدالة <code>Task</code> تأخذ بيانات وسيطة وتُرجع وعدًا <code>[[JavaScript/Promise|Promise]]</code> يتم استيفاؤه (قبوله أو حله) على أنه <code>undefined</code>.

=== <code>TaskCanceller</code> ===
الدالة <code>TaskCanceller</code> لا تأخذ معاملات ولا ترجع شيئًا.

=== <code>TaskCancelProvider</code> ===
الدالة <code>TaskCancelProvider</code> هي دالة صالحة ترجع الدالة <code>TaskCanceller</code>.

=== <code>TaskProvider</code> ===
يعد <code>TaskProvider</code> دالة تُرجع الدالة <code>Task</code>.

== المصادر ==

[https://reactnative.dev/docs/appregistry صفحة AppRegistry في توثيق React Native الرسمي].
[[تصنيف: ReactNative]]
[[تصنيف:React Native API]]