إجراءات العميل لإضافة Pushwoosh Outsystems
يوفر المكون الإضافي (Plugin) مجموعة من إجراءات العميل لتسهيل إدارة إشعارات الدفع. تتيح لك هذه الإجراءات تسجيل وإلغاء تسجيل الأجهزة، وتعيين العلامات (tags) والحصول عليها، وإدارة رسائل البريد الوارد (inbox)، والمزيد.
إجراءات العميل لإضافة Pushwoosh
Anchor link toCheckPushwooshPlugin
Anchor link toيتحقق مما إذا كان المكون الإضافي Pushwoosh متاحًا حاليًا للاستخدام.
معلمات الإخراج
Anchor link to| IsAvailable | تُرجع true إذا كان المكون الإضافي متاحًا للاستخدام، وإلا فتُرجع false. |
|---|---|
| Error | خطأ يحتوي على رمز الخطأ ورسالة الخطأ مع تفاصيل حول أي خطأ قد يكون قد حدث. يتم تعيينه فقط عندما تكون قيمة معلمة الإخراج Success هي false. |
مثال على الاستخدام
Anchor link to
RegisterDevice
Anchor link toيسجل جهازًا لتلقي إشعارات الدفع ويسترد رمز الدفع (Push Token).
معلمات الإدخال
Anchor link to| ApplicationCode | نص، رمز تطبيق Pushwoosh الذي تم الحصول عليه من إعدادات حسابك. |
|---|
معلمات الإخراج
Anchor link to| RegisterToken | الرمز الذي تم استلامه من Google أو Apple للجهاز. |
|---|---|
| Success | تُرجع true إذا سار كل شيء كما هو متوقع، وfalse إذا كان هناك خطأ. |
| Error | خطأ يحتوي على رمز الخطأ ورسالة الخطأ مع تفاصيل حول أي خطأ قد يكون قد حدث. يتم تعيينه فقط عندما تكون قيمة معلمة الإخراج Success هي false. |
UnregisterDevice
Anchor link toيلغي تسجيل جهاز من تلقي إشعارات الدفع.
معلمات الإخراج
Anchor link to| Success | تُرجع true إذا سار كل شيء كما هو متوقع، وfalse إذا كان هناك خطأ. |
|---|---|
| Error | خطأ يحتوي على رمز الخطأ ورسالة الخطأ مع تفاصيل حول أي خطأ قد يكون قد حدث. يتم تعيينه فقط عندما تكون قيمة معلمة الإخراج Success هي false. |
GetDeviceID
Anchor link toيسترد معرف الجهاز (device ID)، الذي يجب أن يكون معرفًا فريدًا.
معلمات الإخراج
Anchor link to| DeviceHwid | المعرف الفريد للجهاز. |
|---|---|
| Error | خطأ يحتوي على رمز الخطأ ورسالة الخطأ مع تفاصيل حول أي خطأ قد يكون قد حدث. يتم تعيينه فقط عند وجود خطأ. |
GetDeviceType
Anchor link toيحصل على نوع الجهاز (Android أو iOS أو Windows).
معلمات الإخراج
Anchor link to| DeviceTypeId | معرف نوع هذا الجهاز. |
|---|
GetTags
Anchor link toيجلب بيانات العلامات (tags) من Pushwoosh.
معلمات الإخراج
Anchor link to| Success | تُرجع true إذا سار كل شيء كما هو متوقع، وfalse إذا كان هناك خطأ. |
|---|---|
| Error | خطأ يحتوي على رمز الخطأ ورسالة الخطأ مع تفاصيل حول أي خطأ قد يكون قد حدث. يتم تعيينه فقط عندما تكون قيمة معلمة الإخراج Success هي false. |
| Tags | تُرجع قائمة سجلات Key, Value تحتوي على جميع العلامات المخصصة لهذا الجهاز. |
مثال على الاستخدام
Anchor link to- استدعِ الإجراء GetTags لجلب بيانات العلامات من Pushwoosh.
- يمكن الوصول إلى العلامات المُرجعة عبر قائمة GetTags.Tags.
- استخدم الإجراء LogMessage لتسجيل مفتاح وقيمة كل علامة.
PostEvent
Anchor link toيرسل رسالة إلى Pushwoosh عند وقوع حدث معين في تطبيقك.
معلمات الإدخال
Anchor link to| EventName | نص، اسم الحدث. |
|---|---|
| EventAttributes | قائمة سجلات Key, Value، تُستخدم لإرسال بيانات حدث إضافية إلى Pushwoosh (على سبيل المثال، لإجراء “UserLogin” قد ترغب في إرسال بيانات تسجيل الدخول، مثل - {"username":"John"}). |
معلمات الإخراج
| Success | تُرجع true إذا سار كل شيء كما هو متوقع، وfalse إذا كان هناك خطأ. |
|---|---|
| Error | خطأ يحتوي على رمز الخطأ ورسالة الخطأ مع تفاصيل حول أي خطأ قد يكون قد حدث. يتم تعيينه فقط عندما تكون قيمة معلمة الإخراج Success هي false. |
مثال على الاستخدام
Anchor link to
1. تعيين (Assign)
قم بإعداد أزواج المفتاح-القيمة لتعريف بيانات الحدث. على سبيل المثال، KeyValue1.AttributeName كـ “test1” و KeyValue1.Value كـ “test1value”. وبالمثل، قم بتعريف KeyValue2 باسم السمة والقيمة المناسبين.
- أنشئ قوائم بالسمات التي سيتم ربطها بالحدث.
- أخيرًا، قم بتكوين الإجراء PostEvent.
SetBadgeNumber
Anchor link toيضبط رقم شارة أيقونة التطبيق.
معلمات الإدخال
Anchor link to| BadgeNumber | عدد صحيح، رقم شارة الأيقونة. |
|---|
معلمات الإخراج
Anchor link to| Success | تُرجع true إذا سار كل شيء كما هو متوقع، وfalse إذا كان هناك خطأ. |
|---|---|
| Error | خطأ يحتوي على رمز الخطأ ورسالة الخطأ مع تفاصيل حول أي خطأ قد يكون قد حدث. يتم تعيينه فقط عندما تكون قيمة معلمة الإخراج Success هي false. |
SetLanguage
Anchor link toيضبط لغة تطبيق مخصصة بدلاً من لغة النظام الافتراضية.
معلمات الإدخال
Anchor link to| Language | نص، لغة تطبيق مخصصة بتنسيق ISO المكون من حرفين (مثل “en”، “es”، “fr”). |
|---|
SetTags
Anchor link toيرسل العلامات (tags) وقيمها إلى Pushwoosh.
معلمات الإدخال
Anchor link to| Tags | قائمة سجلات TagName, TagValue تحتوي على جميع العلامات التي تريد إرسالها. يجب أن يكون نوع TagName دائمًا نصًا، بينما يمكن أن يكون TagValue نصًا أو عددًا صحيحًا أو قيمة منطقية أو تاريخًا، إلخ. |
|---|
معلمات الإخراج
Anchor link to| Success | تُرجع true إذا سار كل شيء كما هو متوقع، وfalse إذا كان هناك خطأ. |
|---|---|
| Error | خطأ يحتوي على رمز الخطأ ورسالة الخطأ مع تفاصيل حول أي خطأ قد يكون قد حدث. يتم تعيينه فقط عندما تكون قيمة معلمة الإخراج Success هي false. |
مثال على الاستخدام
Anchor link to
- عيّن قيم العلامات. في المثال أدناه، هناك علامتان:
Tag1باسمtestTagوقيمتها محددة بالتاريخ الحالي.Tag2باسمtestTag2وقيمتها محددة بـTrue.
- بعد ذلك، أضف العلامات إلى قائمة. في هذا المثال:
ListAppend3يضيفTag1إلى قائمةLocalTag.ListAppend4يضيفTag2إلى قائمةLocalTag.
- بعد ملء القائمة بالعلامات اللازمة، استخدم إجراء العميل SetTags لإرسال هذه القائمة إلى Pushwoosh.
SetUserId
Anchor link toيعيّن معرف مستخدم (User ID) مخصصًا لهذا الجهاز.
معلمات الإدخال
Anchor link to| UserID | نص، معرف مستخدم مخصص. |
|---|
معلمات الإخراج
Anchor link to| Success | تُرجع true إذا سار كل شيء كما هو متوقع، وfalse إذا كان هناك خطأ. |
|---|---|
| Error | خطأ يحتوي على رمز الخطأ ورسالة الخطأ مع تفاصيل حول أي خطأ قد يكون قد حدث. يتم تعيينه فقط عندما تكون قيمة معلمة الإخراج Success هي false. |
إجراءات العميل لبريد Pushwoosh الوارد (Inbox)
Anchor link toعملية التعامل مع البريد الوارد (Inbox) هي كالتالي:
- حمّل قائمة بكائنات
InboxMessage. - استخدم هذه الكائنات لعرض واجهة البريد الوارد.
- قم بتنفيذ الإجراءات المذكورة أدناه، أو احذف هذه الكائنات باستخدام الإجراءات الموضحة أدناه.
| code | نص | المعرف الفريد لإشعار البريد الوارد. |
|---|---|---|
| title | نص | عنوان الإشعار. |
| message | نص | رسالة الإشعار. |
| imageUrl | نص | عنوان URL لصورة مخصصة مرفقة بالإشعار. |
| sendDate | تاريخ وقت | يمثل الوقت الذي تم فيه إرسال الإشعار. |
| type | عدد صحيح | نوع الإشعار. القيم الممكنة:
|
| bannerUrl | نص | يحتوي على عنوان URL لشعار Android. |
| customData | قائمة سجلات Key, Value | تحتوي على قائمة بالمعلمات التي تم تمريرها كبيانات مخصصة. |
| isRead | قيمة منطقية | True إذا تمت قراءة إشعار البريد الوارد. |
| isActionPerformed | قيمة منطقية |
|
LoadMessages
Anchor link toيجلب إشعارات البريد الوارد من Pushwoosh.
معلمات الإخراج
Anchor link to| InboxMessages | قائمة InboxMessage، قائمة بجميع رسائل البريد الوارد. |
|---|---|
| Success | تُرجع true إذا سار كل شيء كما هو متوقع، و**false** إذا كان هناك خطأ. |
| Error | خطأ يحتوي على رمز الخطأ ورسالة الخطأ مع تفاصيل حول أي خطأ قد يكون قد حدث. يتم تعيينه فقط عندما تكون قيمة معلمة الإخراج Success هي false. |
ReadMessage
Anchor link toيضع علامة “مقروء” على رسالة البريد الوارد.
معلمات الإدخال
Anchor link to| MessageCode | نص، رمز InboxMessage (يتم استلامه كمعلمة لـ InboxMessage في LoadMessages). |
|---|
معلمات الإخراج
Anchor link to| Success | True إذا سار كل شيء كما هو متوقع، وfalse إذا كان هناك خطأ. |
|---|---|
| Error | خطأ يحتوي على رمز الخطأ ورسالة الخطأ مع تفاصيل حول أي خطأ قد يكون قد حدث. يتم تعيينه فقط عندما تكون قيمة معلمة الإخراج Success هي false. |
PerformAction
Anchor link toينفذ إجراءً لرسائل البريد الوارد المحددة (على سبيل المثال، فتح عنوان URL في متصفح).
معلمات الإدخال
Anchor link to| MessageCode | نص، رمز InboxMessage (يتم استلامه كمعلمة لـ InboxMessage في LoadMessages). |
|---|
معلمات الإخراج
Anchor link to| Success | تُرجع true إذا سار كل شيء كما هو متوقع، وfalse إذا كان هناك خطأ. |
|---|---|
| Error | خطأ يحتوي على رمز الخطأ ورسالة الخطأ مع تفاصيل حول أي خطأ قد يكون قد حدث. يتم تعيينه فقط عندما تكون قيمة معلمة الإخراج Success هي false. |
DeleteMessage
Anchor link toيزيل رسالة من البريد الوارد.
معلمات الإدخال
Anchor link to| MessageCode | نص، رمز InboxMessage (يتم استلامه كمعلمة لـ InboxMessage في LoadMessages). |
|---|
معلمات الإخراج
Anchor link to| Success | تُرجع true إذا سار كل شيء كما هو متوقع، وfalse إذا كان هناك خطأ. |
|---|---|
| Error | خطأ يحتوي على رمز الخطأ ورسالة الخطأ مع تفاصيل حول أي خطأ قد يكون قد حدث. يتم تعيينه فقط عندما تكون قيمة معلمة الإخراج Success هي false. |
TotalMessagesCount
Anchor link toيُرجع العدد الإجمالي لرسائل البريد الوارد.
معلمات الإخراج
Anchor link to| MessagesCount | عدد صحيح، العدد الإجمالي لرسائل البريد الوارد. |
|---|---|
| Success | تُرجع true إذا سار كل شيء كما هو متوقع، وfalse إذا كان هناك خطأ. |
| Error | خطأ يحتوي على رمز الخطأ ورسالة الخطأ مع تفاصيل حول أي خطأ قد يكون قد حدث. يتم تعيينه فقط عندما تكون قيمة معلمة الإخراج Success هي false. |
UnreadMessagesCount
Anchor link toيُرجع عدد رسائل البريد الوارد غير المقروءة.
معلمات الإخراج
Anchor link to| UnreadMessagesCount | عدد صحيح، عدد رسائل البريد الوارد غير المقروءة. |
|---|---|
| Success | تُرجع true إذا سار كل شيء كما هو متوقع، وfalse إذا كان هناك خطأ. |
| Error | خطأ يحتوي على رمز الخطأ ورسالة الخطأ مع تفاصيل حول أي خطأ قد يكون قد حدث. يتم تعيينه فقط عندما تكون قيمة معلمة الإخراج Success هي false. |
MessagesWithNoActionPerformedCount
Anchor link toيُرجع عدد رسائل البريد الوارد التي لم يتم تنفيذ أي إجراء عليها.
معلمات الإخراج
Anchor link to| MessagesWithNoActionPerformedCount | عدد صحيح، عدد رسائل البريد الوارد التي لم يتم تنفيذ أي إجراء عليها. |
|---|---|
| Success | تُرجع true إذا سار كل شيء كما هو متوقع، وfalse إذا كان هناك خطأ. |
| Error | خطأ يحتوي على رمز الخطأ ورسالة الخطأ مع تفاصيل حول أي خطأ قد يكون قد حدث. يتم تعيينه فقط عندما تكون قيمة معلمة الإخراج Success هي false. |