مقدمة لإجرَاء العَمليَات العمومية باستخدَام كَائن API Xrm الخَاص بالعميل

  • 8 دقائق

توفر Client API كَائن Xrm، والتي تتوفر عَالميًا فِي التعليمة البرمجية الخَاصة بك، مَا يتيح القيَام بأنشطة مختلفة دون الاعتمَاد عَلى سيَاق التنفيذ. وعلى مستوى عَالٍ، يوضح الرسم البيَاني التَالي كلًا من الخصَائص والطرق المتَاحة. للحصول عَلى نظرة عَامة متعمقة حول هذا الكَائن، رَاجع كَائن Client API Xrm.

لقطة شَاشة لمسَاحَات الاسم فِي نموذج كَائن API لبرنَامج العميل النصي وXrm وApp وdevice وEncoding وNavigation وPanel و‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫Utility وWebAPI.

كَائن التطبيق

باستخدَام addGlobalNotification من كَائن التطبيق، يمكنك عرض خطأ أو معلومَات أو تحذير أو إشعَارَات نجَاح لأحد التطبيقَات وتحديد الإجرَاءَات المطلوب تنفيذهَا بنَاءً عَلى الإشعَار. يشبه هذا الإشعَار إشعَارَات النمَاذج، لكن يمكنك استخدَامه خَارج سيَاق النموذج. على سبيل المثَال، يمكن لبرنَامج نصي لشريط الأوامر إعلام المستخدم بإتمَام الإجرَاء. استخدم طريقة ClearGlobalNotification لمسح إشعَار فِي التطبيق.

كَائن الجهَاز

يكشف كَائن Xrm.Device عن إمكَانيَات الجهَاز الأصلية المرتبطة بتفاعلات الجهَاز المحمول، باستثنَاء طريقة pickFile، والتي يمكن الوصول إليهَا أيضًا من خلال عملاء الويب. توفر تطبيقَات اللوحة أيضًا إطَار عمل موسع لتطوير الأجهزة المحمولة ويجب أيضًا أخذهَا فِي الاعتبار فِي هذه السينَاريوهَات. الجدول التَالي هو ‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫مُلخَّص‬ للطرق المتوفرة دَاخل كَائن Xrm.Device.

الطريقة ‏‫‏‫الوَصف‏‎‏‎‏‎‏‎‏‎
captureAudio يستدعي ميكروفون الجهَاز لتسجيل الصوت.
captureImage يستدعي كَاميرَا الجهَاز لالتقَاط صورة.
captureVideo يستدعي كَاميرَا الجهَاز لتسجيل مقطع فيديو.
getBarcodeValue يستدعي كَاميرَا الجهَاز لمسح معلومَات الرمز الشريطي، مثل رقم المنتج.
getCurrentPosition إرجَاع الموقع الحَالي باستخدَام إمكَانية تحديد الموقع الجغرَافِي للجهَاز.
pickFile يفتح مربع حوار لتحديد الملفات من جهَاز الكمبيوتر (عميل الويب) أو الجهَاز المحمول (عملاء الأجهزة المحمولة).

اعتمَادًا عَلى تكوين الجهَاز، لا تتوفر بعض الوظَائف. قد تكون موافقة المستخدم مطلوبة أيضًا حتى يتمكن التطبيق من الوصول إلى إمكَانَات جهَاز معينة. على سبيل المثَال، ربمَا قَام المستخدم بتعطيل إمكَانَات موقع الجهَاز عَالميًا أو رفض الوصول إلى كَاميرَا التطبيق. عند تطوير أحد التطبيقَات، احذر من أن هذه الأسَاليب قد تفشل بسبب إمكَانيَات الجهَاز أو تكوينه أو نقص الأذونَات أو الموافقة.

كَائن الترميز

يمكنك استخدَام كَائن Xrm.Encoding لترميز وفك تشفير سلاسل XML وHTML. يمكن أن يكون هذا التشفير وفك التشفير ذا قيمة عندمَا تكون:

  • التفاعل مع موارد ويب HTML،

  • تشفير وفك تشفير معلمَات سلسلة الاستعلام،

  • التفاعل مع FetchXML الذي يحتوي عَلى أحرف خَاصة مثل '&' أو '<' فِي سلسلة البحث.

يوفر كَائن التنقل أسَاليب متعلقة بالتنقل يمكنك استخدَامهَا دَاخل تطبيق يستند إلى نموذج. نظرًا لطبيعتهَا المحظورة، فإن الأنشطة مثل عرض التنبيهَات والتأكيد ومربعَات حوار الأخطَاء لا تعتبر تجربة مستخدم مثَالية ولكنهَا تظل متَاحة. فِي هذه السينَاريوهَات، نوصي بالنظر فِي إشعَارَات النمَاذج أو الآليَات الأخرى غير المحظورة لتحذير المستخدمين من مشكلة مَا. فيمَا يلي ‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫مُلخَّص‬ للأسَاليب المتوفرة دَاخل كَائن Xrm.Navigation.

الطريقة ‏‫‏‫الوَصف‏‎‏‎‏‎‏‎‏‎
openAlertDialog يعرض مربع حوار التنبيه الذي يحتوي عَلى رسَالة وزر.
openConfirmDialog يعرض مربع حوار للتأكيد الذي يحتوي عَلى رسَالة وزرين.
openErrorDialog يعرض مربع حوار الخطأ.
openFile فتح ملف.
openForm فتح نموذج جدول أو نموذج إنشَاء سريع.
openUrl فتح عنوان URL، بمَا فِي ذلك عنَاوين URL للملف.
openWebResource فتح مورد ويب بتنسيق HTML.

كَائن لوحة

يوفر كَائن Xrm.Panel طريقة لعرض صفحة ويب عَلى الجُزء الجَانبي لنموذج تطبيق يستند إلى نموذج. هذه الميزة قيد المعَاينة حَاليًا ولم يتم تنَاولهَا بالتفصيل هنَا. لمزيد من المعلومَات، رَاجع Xrm.Panel.

كَائن ‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫أدَاة المسَاعدة

يعد كَائن Xrm.Utility حَاوية للعديد من الأسَاليب المفيدة. الجدول التَالي هو ‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫مُلخَّص‬ للطرق المتوفرة دَاخل كَائن Xrm.Utility. لمزيد من المعلومَات، رَاجع Xrm.Utility (مرجع API الخَاص بالعميل)

الطريقة ‏‫‏‫الوَصف‏‎‏‎‏‎‏‎‏‎
closeProgressIndicator يقوم المؤشر بإغلاق مربع حوار التقدم الذي تم فتحه باستخدَام showProgressIndicator.
getAllowedStatusTransitions إرجَاع انتقَالات الحَالة الصَالحة للجدول ورمز الحَالة المحددين.
getEntityMetadata يعيد بيَانَات تعريف الكيَان للكيَان المحدد.
getGlobalContext يسترجع السيَاق العَالمي، ويوفر معلومَات وقت التَشغيل مثل إعدَادَات المؤسسة، وإعدَادَات المستخدم، وتفاصيل التطبيق، ومعلومَات العميل.
getLearningPathAttributeName إرجَاع اسم سمة DOM المتوقعة من مصمم محتوى مسَار التعليم (التعليمَات الإرشَادية) لتحديد عنَاصر تحكم واجهة المستخدم فِي نمَاذج التطبيقَات المستندة إلى النموذج.
getResourceString إرجَاع السلسلة المترجمة لمفتَاح محدد مقترن مع مورد الويب المحدد.
invokeProcessAction يستدعي إجرَاءً بنَاءً عَلى المعلمَات المحددة. يمكن أيضًا استخدَام هذه الطريقة لاستدعَاء واجهَات برمجة التطبيقَات المخصصة التي أنشأهَا المطورون لديك.
lookupObjects يستخدم هذا الزر فِي فتح عنصر تحكم بحث لتحديد صنف واحد أو أكثر.
refreshParentGrid تحديث الشبكة الأصل التي تحتوي عَلى السجل المحدد.
showProgressIndicator يعرض مربع حوار التقدم مع الرسَالة المحددة.

هنَاك أيضًا العديد من الطرق غير المدرجة هنَا والتي قد تصَادفهَا فِي التعليمَات البرمجية القديمة التي تم إهمَالهَا الآن لأنهَا انتقلت إلى مسَاحة الاسم Xrm.Navigation. فِي حَالة العثور عَلى هذه الأسَاليب يجب تحديث الكود لاستخدَام أسَاليب Xrm.Navigation الجديدة.

كَائن Xrm.WebApi

يوفر كَائن Xrm.WebApi خصَائص وأسَاليب لاستخدَام Web API لعمليَات CRUD التقليدية ضمن البرنَامج النصي للعميل. عند استخدَام Xrm.WebAPI فِي البرنَامج النصي الخَاص بك، يتم تنفيذ العَمليَات تلقَائيًا فِي سيَاق مستخدم التطبيق الحَالي. يمكنك استخدَام Web API عندمَا يكون التطبيق متصلاً وغير متصل (إذا قمت بتكوين البيئة للعمل دون اتصَال). تتضمن مسَاحة الاسم مجموعة محددة من الأسَاليب المتصلة بالإنترنت وغير المتصلة بالإنترنت؛ ومع ذلك، يتطلب استخدَام هذه الأسَاليب تتبع حَالة العميل. إذا كنت تستخدم Xrm.WebAPI، Xrm.WebAPI.createRecord، فإن واجهة برمجة التطبيقَات (API) تحدد مَا إذا كَان يجب أن تستخدم أسَاليب مسَاحة الاسم عبر الإنترنت أو دون اتصَال نيَابةً عنك.

الجدول التَالي هو ‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫‏‫مُلخَّص‬ للطرق المتوفرة دَاخل كَائن Xrm.WebApi. لمزيد من المعلومَات، رَاجع Xrm.WebApi (مرجع API الخَاص بالعميل).

الطريقة ‏‫‏‫الوَصف‏‎‏‎‏‎‏‎‏‎
createRecord إنشَاء صف جدول.
deleteRecord يتيح حذف صف جدول باستخدَام معرف الصف.
retrieveRecord يتيح استرجَاع صف باستخدَام معرف الصف.
retrieveMultipleRecords استردَاد مجموعة من صفوف الجدول المطَابقة لخيَارَات الاستعلام أو إحضَار XML المتوفر.
updateRecord تحديث صف جدول.
isAvailableOffline إرجَاع القيمة المنطقية التي تشير إلى مَا إذا كَان الجدول موجودًا فِي ملف تعريف المستخدم ومتَاحًا فِي وَضع عدم الاتصَال.
تنفيذ تَشغيل اجرَاء أو وظيفة واحدة أو عملية CRUD.
executeMultiple تَشغيل مجموعة من الإجرَاءَات أو الوظَائف أو عمليَات CRUD.

باستخدَام خصَائص وأسَاليب كَائن Xrm، يمكنك تنفيذ دورات العمل تلقَائيًا وتحسين تجربة المستخدم الكلية.