Pushwoosh Outsystems प्लगइन क्लाइंट एक्शन

यह प्लगइन पुश नोटिफिकेशन प्रबंधन को सुविधाजनक बनाने के लिए क्लाइंट एक्शन का एक सेट प्रदान करता है। ये एक्शन आपको डिवाइस को रजिस्टर और अनरजिस्टर करने, टैग सेट करने और प्राप्त करने, इनबॉक्स संदेशों का प्रबंधन करने और बहुत कुछ करने की अनुमति देते हैं।

Pushwoosh प्लगइन क्लाइंट एक्शन

CheckPushwooshPlugin

यह जाँचता है कि Pushwoosh प्लगइन वर्तमान में उपलब्ध है या नहीं।

आउटपुट पैरामीटर

IsAvailable	यदि प्लगइन उपयोग के लिए उपलब्ध है तो true लौटाता है, अन्यथा false
Error	एक त्रुटि जिसमें त्रुटि कोड और त्रुटि संदेश होता है जिसमें किसी भी त्रुटि के बारे में विवरण होता है जो हो सकती है। केवल तभी सेट करें जब Success आउटपुट पैरामीटर false हो।

उपयोग का उदाहरण

RegisterDevice

पुश नोटिफिकेशन के लिए एक डिवाइस को रजिस्टर करता है और एक Push Token प्राप्त करता है।

इनपुट पैरामीटर

ApplicationCode	टेक्स्ट, आपके अकाउंट सेटिंग्स से प्राप्त Pushwoosh एप्लीकेशन कोड।

आउटपुट पैरामीटर

RegisterToken	डिवाइस के लिए Google या Apple से प्राप्त टोकन
Success	यदि सब कुछ अपेक्षा के अनुरूप होता है तो true लौटाता है, यदि कोई त्रुटि है तो false।
Error	एक त्रुटि जिसमें त्रुटि कोड और त्रुटि संदेश होता है जिसमें किसी भी त्रुटि के बारे में विवरण होता है जो हो सकती है। केवल तभी सेट करें जब Success आउटपुट पैरामीटर false हो।

UnregisterDevice

एक डिवाइस को पुश नोटिफिकेशन प्राप्त करने से अनरजिस्टर करता है।

आउटपुट पैरामीटर

Success	यदि सब कुछ अपेक्षा के अनुरूप होता है तो true लौटाता है, यदि कोई त्रुटि है तो false।
Error	एक त्रुटि जिसमें त्रुटि कोड और त्रुटि संदेश होता है जिसमें किसी भी त्रुटि के बारे में विवरण होता है जो हो सकती है। केवल तभी सेट करें जब Success आउटपुट पैरामीटर false हो।

GetDeviceID

डिवाइस आईडी प्राप्त करता है, जो एक अद्वितीय पहचानकर्ता होना चाहिए।

आउटपुट पैरामीटर

DeviceHwid	डिवाइस का अद्वितीय पहचानकर्ता।
Error	एक त्रुटि जिसमें त्रुटि कोड और त्रुटि संदेश होता है जिसमें किसी भी त्रुटि के बारे में विवरण होता है जो हो सकती है। केवल तभी सेट करें जब कोई त्रुटि हुई हो।

GetDeviceType

डिवाइस का प्रकार (Android, iOS, या Windows) प्राप्त करता है।

आउटपुट पैरामीटर

DeviceTypeId	इस डिवाइस प्रकार का पहचानकर्ता।

GetTags

Pushwoosh से टैग डेटा प्राप्त करता है।

आउटपुट पैरामीटर

Success	यदि सब कुछ अपेक्षा के अनुरूप होता है तो true लौटाता है, यदि कोई त्रुटि है तो false।
Error	एक त्रुटि जिसमें त्रुटि कोड और त्रुटि संदेश होता है जिसमें किसी भी त्रुटि के बारे में विवरण होता है जो हो सकती है। केवल तभी सेट करें जब Success आउटपुट पैरामीटर false हो।
Tags	कुंजी, मान रिकॉर्ड सूची लौटाता है जिसमें इस डिवाइस को सौंपे गए सभी टैग होते हैं।

उपयोग का उदाहरण

1. Pushwoosh से टैग डेटा लाने के लिए GetTags एक्शन को लागू करें।
2. लौटाए गए टैग GetTags.Tags सूची के माध्यम से सुलभ हैं।

3. प्रत्येक टैग की कुंजी और मान को लॉग करने के लिए LogMessage एक्शन का उपयोग करें।

PostEvent

जब आपके एप्लिकेशन में कोई विशेष ईवेंट होता है तो Pushwoosh को एक संदेश भेजता है।

इनपुट पैरामीटर

EventName	टेक्स्ट, ईवेंट का नाम
EventAttributes	कुंजी, मान रिकॉर्ड सूची, Pushwoosh को अतिरिक्त ईवेंट डेटा भेजने के लिए उपयोग किया जाता है (यानी “UserLogin” एक्शन के लिए आप लॉगिन डेटा भेजना चाह सकते हैं, जैसे - {"username":"John"})

आउटपुट पैरामीटर

Success	यदि सब कुछ अपेक्षा के अनुरूप होता है तो true लौटाता है, यदि कोई त्रुटि है तो false।
Error	एक त्रुटि जिसमें त्रुटि कोड और त्रुटि संदेश होता है जिसमें किसी भी त्रुटि के बारे में विवरण होता है जो हो सकती है। केवल तभी सेट करें जब Success आउटपुट पैरामीटर false हो।

उपयोग का उदाहरण

1. असाइन करें

ईवेंट के लिए डेटा को परिभाषित करने के लिए कुंजी-मान जोड़े सेट करें। उदाहरण के लिए, KeyValue1.AttributeName को “test1” और KeyValue1.Value को “test1value” के रूप में। इसी तरह, KeyValue2 को उपयुक्त विशेषता नाम और मान के साथ परिभाषित करें।

2. ईवेंट से जुड़ी होने वाली विशेषताओं की सूचियाँ बनाएँ।

3. अंत में, PostEvent एक्शन को कॉन्फ़िगर करें।

SetBadgeNumber

एप्लिकेशन आइकन बैज नंबर सेट करता है।

इनपुट पैरामीटर

BadgeNumber	पूर्णांक, आइकन बैज नंबर।

आउटपुट पैरामीटर

Success	यदि सब कुछ अपेक्षा के अनुरूप होता है तो true लौटाता है, यदि कोई त्रुटि है तो false।
Error	एक त्रुटि जिसमें त्रुटि कोड और त्रुटि संदेश होता है जिसमें किसी भी त्रुटि के बारे में विवरण होता है जो हो सकती है। केवल तभी सेट करें जब Success आउटपुट पैरामीटर false हो।

SetLanguage

डिफ़ॉल्ट सिस्टम भाषा के बजाय कस्टम एप्लिकेशन भाषा सेट करता है।

इनपुट पैरामीटर

Language	टेक्स्ट, 2-अक्षर ISO प्रारूप में कस्टम एप्लिकेशन भाषा (जैसे, “en”, “es”, “fr”)

SetTags

Pushwoosh को टैग और उनके मान भेजता है।

इनपुट पैरामीटर

Tags	TagName, TagValue रिकॉर्ड सूची जिसमें वे सभी टैग होते हैं जिन्हें आप भेजना चाहते हैं। TagName प्रकार हमेशा टेक्स्ट होना चाहिए, जबकि TagValue टेक्स्ट, पूर्णांक, बूलियन, दिनांक, आदि हो सकता है।

आउटपुट पैरामीटर

Success	यदि सब कुछ अपेक्षा के अनुरूप होता है तो true लौटाता है, यदि कोई त्रुटि है तो false।
Error	एक त्रुटि जिसमें त्रुटि कोड और त्रुटि संदेश होता है जिसमें किसी भी त्रुटि के बारे में विवरण होता है जो हो सकती है। केवल तभी सेट करें जब Success आउटपुट पैरामीटर false हो।

उपयोग का उदाहरण

1. टैग मान असाइन करें। नीचे दिए गए उदाहरण में, दो टैग हैं:

• Tag1 जिसका नाम testTag है और इसका मान वर्तमान तिथि पर सेट है।
• Tag2 जिसका नाम testTag2 है और इसका मान True पर सेट है।

2. फिर, एक सूची में टैग जोड़ें। इस उदाहरण में:

• ListAppend3, Tag1 को LocalTag सूची में जोड़ता है।
• ListAppend4, Tag2 को LocalTag सूची में जोड़ता है।

3. आवश्यक टैग के साथ सूची को भरने के बाद, इस सूची को Pushwoosh पर भेजने के लिए SetTags क्लाइंट एक्शन का उपयोग करें।

SetUserId

इस डिवाइस को एक कस्टम User ID असाइन करता है।

इनपुट पैरामीटर

UserID	टेक्स्ट, कस्टम User ID।

आउटपुट पैरामीटर

Success	यदि सब कुछ अपेक्षा के अनुरूप होता है तो true लौटाता है, यदि कोई त्रुटि है तो false।
Error	एक त्रुटि जिसमें त्रुटि कोड और त्रुटि संदेश होता है जिसमें किसी भी त्रुटि के बारे में विवरण होता है जो हो सकती है। केवल तभी सेट करें जब Success आउटपुट पैरामीटर false हो।

SetApiToken

SDK द्वारा उपयोग किए जाने वाले Pushwoosh Device API टोकन को सेट करता है। इसे RegisterDevice से पहले कॉल करें। टोकन को PW_API_TOKEN वरीयता के साथ बिल्ड समय पर भी सेट किया जा सकता है — एकीकरण गाइड देखें।

इनपुट पैरामीटर

Token	टेक्स्ट, Pushwoosh कंट्रोल पैनल (API एक्सेस सेक्शन) से Device API टोकन।

EnableHuaweiPushNotifications

पुश ट्रांसपोर्ट को Huawei Push Kit (HMS) में स्विच करता है। इसे Huawei डिवाइस पर RegisterDevice से पहले कॉल करें। इसके लिए Huawei कॉन्फ़िगरेशन की आवश्यकता है — Outsystems के लिए Huawei देखें।

एक्शन में कोई आउटपुट पैरामीटर नहीं है और यह सफलता या विफलता की रिपोर्ट नहीं करता है। यह सत्यापित करने के लिए कि डिवाइस वास्तव में किस ट्रांसपोर्ट के साथ पंजीकृत हुआ है, GetDiagnostics का उपयोग करें।

SetMultiNotificationMode

Pushwoosh प्लगइन कंपोनेंट संस्करण 4.7.0 से उपलब्ध। केवल Android — प्रत्येक पुश को पिछले वाले को बदलने के बजाय एक अलग नोटिफिकेशन के रूप में दिखाता है। इसे इनिशियलाइज़ेशन के बाद एक बार कॉल करें — उदाहरण के लिए, OnInitializeOver ईवेंट के हैंडलर में, RegisterDevice के बाद। सेटिंग SDK द्वारा संग्रहीत की जाती है और ऐप पुनरारंभ होने पर भी बनी रहती है। Android नोटिफिकेशन को एक विस्तारणीय स्टैक में समूहित करता है — यह मानक सिस्टम व्यवहार है। कोई iOS कार्यान्वयन नहीं है (iOS कभी भी नोटिफिकेशन को प्रतिस्थापित नहीं करता है) — कॉल को GetDeviceType के साथ सुरक्षित करें बजाय इसके कि इसे एक ऐसे प्रवाह में डालें जो iOS पर भी चलता है।

GetDiagnostics

Pushwoosh प्लगइन कंपोनेंट संस्करण 4.7.0 से उपलब्ध। एकीकरण स्थिति को JSON स्ट्रिंग के रूप में लौटाता है: प्रभावी और अंतर्निहित एप्लीकेशन कोड और यह कहाँ से आया, API टोकन की उपस्थिति, HWID, पुश टोकन, नोटिफिकेशन अनुमति स्थिति, और प्लगइन और नेटिव SDK संस्करण। Android पर यह अतिरिक्त रूप से User ID और FCM/HMS मैसेजिंग ईवेंट के लिए पंजीकृत सेवाओं की सूची शामिल करता है (ये दो फ़ील्ड iOS पर मौजूद नहीं हैं)। डिवाइस लॉग एकत्र करने के बजाय इसके आउटपुट को समर्थन टिकटों से संलग्न करें।

आउटपुट पैरामीटर

DiagnosticsJSON	टेक्स्ट, एकीकरण स्थिति JSON स्ट्रिंग के रूप में।
Error	एक त्रुटि जिसमें त्रुटि कोड और त्रुटि संदेश होता है जिसमें किसी भी त्रुटि के बारे में विवरण होता है जो हो सकती है।

उदाहरण आउटपुट (Android):

{
  "platform": "android",
  "packageName": "com.example.app",
  "appIdEffective": "XXXXX-XXXXX",
  "appIdManifest": "XXXXX-XXXXX",
  "appIdSource": "manifest",
  "apiTokenInManifest": false,
  "hwid": "d3ba13b6-…",
  "pushToken": "eAvqvOE0…",
  "userId": "d3ba13b6-…",
  "notificationsEnabled": true,
  "messagingServices": [
    { "action": "com.google.firebase.MESSAGING_EVENT", "class": "com.pushwoosh.firebase.PushFcmIntentService", "priority": 0 }
  ],
  "pluginVersion": "8.3.72-OS.1",
  "nativeSdkVersion": "6.11.1"
}

Pushwoosh इनबॉक्स क्लाइंट एक्शन

इनबॉक्स के साथ काम करने की प्रक्रिया निम्नलिखित है:

1. InboxMessage ऑब्जेक्ट्स की एक सूची लोड करें।
2. इनबॉक्स व्यू को रेंडर करने के लिए इन ऑब्जेक्ट्स का उपयोग करें।
3. नीचे सूचीबद्ध एक्शन करें, या नीचे वर्णित एक्शन का उपयोग करके इन ऑब्जेक्ट्स को हटा दें।

code	टेक्स्ट	इनबॉक्स नोटिफिकेशन की अद्वितीय आईडी।
title	टेक्स्ट	नोटिफिकेशन शीर्षक।
message	टेक्स्ट	नोटिफिकेशन संदेश।
imageUrl	टेक्स्ट	एक नोटिफिकेशन से जुड़ी कस्टम छवि का URL।
sendDate	दिनांक समय	उस समय का प्रतिनिधित्व करता है जब एक नोटिफिकेशन भेजा गया था।
type	पूर्णांक	नोटिफिकेशन का प्रकार। संभावित मान: 0 - नियमित नोटिफिकेशन 1 - रिच मीडिया नोटिफिकेशन 2 - URL नोटिफिकेशन 3 - डीप लिंक नोटिफिकेशन
bannerUrl	टेक्स्ट	एक Android बैनर का URL शामिल है।
customData	कुंजी, मान रिकॉर्ड सूची	कस्टम डेटा के रूप में पारित मापदंडों की एक सूची शामिल है।
isRead	बूलियन	यदि इनबॉक्स नोटिफिकेशन पढ़ा गया है तो True।
isActionPerformed	बूलियन	True यदि नोटिफिकेशन एक्शन किया गया है। नियमित नोटिफिकेशन के लिए, true यदि नोटिफिकेशन पढ़ा गया है। रिच मीडिया के लिए, true यदि रिच मीडिया प्रस्तुत किया गया था। URL और डीप लिंक के लिए, true यदि URL/डीप लिंक खोला गया था।

LoadMessages

Pushwoosh से इनबॉक्स नोटिफिकेशन प्राप्त करता है।

आउटपुट पैरामीटर

InboxMessages	InboxMessage सूची, सभी इनबॉक्स संदेशों की सूची।
Success	यदि सब कुछ अपेक्षा के अनुरूप होता है तो true लौटाता है, false यदि कोई त्रुटि है।
Error	एक त्रुटि जिसमें त्रुटि कोड और त्रुटि संदेश होता है जिसमें किसी भी त्रुटि के बारे में विवरण होता है जो हो सकती है। केवल तभी सेट करें जब Success आउटपुट पैरामीटर false हो।

ReadMessage

इनबॉक्स संदेश को पढ़े हुए के रूप में चिह्नित करता है।

इनपुट पैरामीटर

MessageCode	टेक्स्ट, एक InboxMessage का कोड (LoadMessages में एक InboxMessage के पैरामीटर के रूप में प्राप्त)

आउटपुट पैरामीटर

Success	यदि सब कुछ अपेक्षा के अनुरूप होता है तो True, यदि कोई त्रुटि है तो false।
Error	एक त्रुटि जिसमें त्रुटि कोड और त्रुटि संदेश होता है जिसमें किसी भी त्रुटि के बारे में विवरण होता है जो हो सकती है। केवल तभी सेट करें जब Success आउटपुट पैरामीटर false हो।

PerformAction

निर्दिष्ट इनबॉक्स संदेशों के लिए एक्शन करता है (जैसे, ब्राउज़र में URL खोलना)।

इनपुट पैरामीटर

MessageCode	टेक्स्ट, एक InboxMessage का कोड (LoadMessages में एक InboxMessage के पैरामीटर के रूप में प्राप्त)

आउटपुट पैरामीटर

Success	यदि सब कुछ अपेक्षा के अनुरूप होता है तो true लौटाता है, यदि कोई त्रुटि है तो false।
Error	एक त्रुटि जिसमें त्रुटि कोड और त्रुटि संदेश होता है जिसमें किसी भी त्रुटि के बारे में विवरण होता है जो हो सकती है। केवल तभी सेट करें जब Success आउटपुट पैरामीटर false हो।

DeleteMessage

इनबॉक्स से एक संदेश हटाता है।

इनपुट पैरामीटर

MessageCode	टेक्स्ट, एक InboxMessage का कोड (LoadMessages में एक InboxMessage के पैरामीटर के रूप में प्राप्त)

आउटपुट पैरामीटर

Success	यदि सब कुछ अपेक्षा के अनुरूप होता है तो true लौटाता है, यदि कोई त्रुटि है तो false।
Error	एक त्रुटि जिसमें त्रुटि कोड और त्रुटि संदेश होता है जिसमें किसी भी त्रुटि के बारे में विवरण होता है जो हो सकती है। केवल तभी सेट करें जब Success आउटपुट पैरामीटर false हो।

TotalMessagesCount

इनबॉक्स संदेशों की कुल संख्या लौटाता है।

आउटपुट पैरामीटर

MessagesCount	पूर्णांक, इनबॉक्स संदेशों की कुल संख्या।
Success	यदि सब कुछ अपेक्षा के अनुरूप होता है तो true लौटाता है, यदि कोई त्रुटि है तो false।
Error	एक त्रुटि जिसमें त्रुटि कोड और त्रुटि संदेश होता है जिसमें किसी भी त्रुटि के बारे में विवरण होता है जो हो सकती है। केवल तभी सेट करें जब Success आउटपुट पैरामीटर false हो।

UnreadMessagesCount

अपठित इनबॉक्स संदेशों की संख्या लौटाता है।

आउटपुट पैरामीटर

UnreadMessagesCount	पूर्णांक, अपठित इनबॉक्स संदेशों की संख्या।
Success	यदि सब कुछ अपेक्षा के अनुरूप होता है तो true लौटाता है, यदि कोई त्रुटि है तो false।
Error	एक त्रुटि जिसमें त्रुटि कोड और त्रुटि संदेश होता है जिसमें किसी भी त्रुटि के बारे में विवरण होता है जो हो सकती है। केवल तभी सेट करें जब Success आउटपुट पैरामीटर false हो।

MessagesWithNoActionPerformedCount

बिना किसी एक्शन के इनबॉक्स संदेशों की संख्या लौटाता है।

आउटपुट पैरामीटर

MessagesWithNoActionPerformedCount	पूर्णांक, बिना किसी एक्शन के इनबॉक्स संदेशों की संख्या।
Success	यदि सब कुछ अपेक्षा के अनुरूप होता है तो true लौटाता है, यदि कोई त्रुटि है तो false।
Error	एक त्रुटि जिसमें त्रुटि कोड और त्रुटि संदेश होता है जिसमें किसी भी त्रुटि के बारे में विवरण होता है जो हो सकती है। केवल तभी सेट करें जब Success आउटपुट पैरामीटर false हो।