Pushwoosh Mendix मॉड्यूल एक्शन

Mendix के लिए Pushwoosh मॉड्यूल अपनी कार्यक्षमता को दो स्थानों पर उजागर करता है: Pushwoosh इवेंट्स विजेट, जो SDK शुरू करता है और आने वाले नोटिफिकेशन को नैनोफ्लो इवेंट्स में बदलता है, और JavaScript एक्शन जिन्हें आप नेटिव मोबाइल नेविगेशन प्रोफाइल पर किसी भी नैनोफ्लो से कॉल करते हैं। यह पेज दोनों को सूचीबद्ध करता है।

Pushwoosh इवेंट्स विजेट प्रॉपर्टीज़

विजेट कुछ भी रेंडर नहीं करता है। इसे एक बार उस पेज पर रखें जो नेटिव मोबाइल नेविगेशन प्रोफाइल में सबसे पहले लोड होता है। यह SDK को इनिशियलाइज़ करता है, वैकल्पिक रूप से डिवाइस को रजिस्टर करता है, और प्रत्येक पुश नोटिफिकेशन इवेंट के लिए एक नैनोफ्लो को ट्रिगर करता है।

सेटअप

ये प्रॉपर्टीज़ SDK शुरू करती हैं और रिपोर्ट करती हैं कि यह कब तैयार है।

प्रॉपर्टी	यह क्या करता है
एप्लीकेशन कोड	आपके ऐप का Pushwoosh एप्लीकेशन कोड, उदाहरण के लिए XXXXX-XXXXX। आवश्यक।
लोड पर रजिस्टर करें	विजेट लोड होते ही डिवाइस को रजिस्टर करता है। iOS पर यह सिस्टम अनुमति प्रॉम्प्ट दिखाता है, इसलिए यदि आप बाद में RegisterForPushNotifications एक्शन के साथ पूछना चाहते हैं तो इसे बंद कर दें।
इनिशियलाइज़ होने पर	एक नैनोफ्लो जो SDK शुरू होने के बाद एक बार चलता है।
रजिस्टर होने पर	एक नैनोफ्लो जो तब चलता है जब डिवाइस में पुश टोकन होता है।
पुश टोकन	स्ट्रिंग एट्रिब्यूट जिसमें रजिस्टर होने पर चलने से पहले पुश टोकन लिखा जाता है।

पुश इवेंट्स

ये प्रॉपर्टीज़ आपके मॉडल में एक आने वाले नोटिफिकेशन को डिलीवर करती हैं और एक नैनोफ्लो को ट्रिगर करती हैं।

प्रॉपर्टी	यह क्या करता है
पेलोड	स्ट्रिंग एट्रिब्यूट जो JSON के रूप में पूरा नोटिफिकेशन पेलोड प्राप्त करता है।
संदेश	स्ट्रिंग एट्रिब्यूट जो नोटिफिकेशन टेक्स्ट प्राप्त करता है।
पुश प्राप्त होने पर	एक नैनोफ्लो जो तब चलता है जब ऐप फोरग्राउंड में होने पर एक नोटिफिकेशन आता है।
पुश खोले जाने पर	एक नैनोफ्लो जो तब चलता है जब उपयोगकर्ता एक नोटिफिकेशन पर टैप करता है।

डीप लिंक्स

ये प्रॉपर्टीज़ एक ऐसे नोटिफिकेशन को संभालती हैं जिसमें ऐप के एक विशिष्ट पेज का लिंक होता है।

प्रॉपर्टी	यह क्या करता है
डीप लिंक	स्ट्रिंग एट्रिब्यूट जो नोटिफिकेशन से डीप लिंक URL प्राप्त करता है।
डीप लिंक पर	एक नैनोफ्लो जो तब चलता है जब एक खोले गए नोटिफिकेशन में एक लिंक होता है। यह पुश खोले जाने पर के अतिरिक्त चलता है।

नैनोफ्लो चलने से पहले एट्रिब्यूट्स भर दिए जाते हैं, इसलिए नैनोफ्लो उन्हें तुरंत पढ़ सकता है।

सेटअप एक्शन

इन एक्शन का उपयोग तब करें जब आप विजेट का उपयोग करने के बजाय SDK को स्वयं शुरू करते हैं।

इनिशियलाइज़

Pushwoosh SDK को इनिशियलाइज़ करता है। इसे किसी भी अन्य Pushwoosh एक्शन से पहले एक बार कॉल करें, आमतौर पर होम पेज के ऑन-लोड नैनोफ्लो से। जब पेज पर Pushwoosh इवेंट्स विजेट होता है तो आपको इसकी आवश्यकता नहीं होती है, क्योंकि विजेट SDK को स्वयं इनिशियलाइज़ करता है।

Android पर, FCM सेंडर आईडी google-services.json से आती है, जिसे नेटिव बिल्ड उठाता है। यह इस एक्शन को पास नहीं किया जाता है।

पैरामीटर	प्रकार	विवरण
applicationCode	स्ट्रिंग	Pushwoosh एप्लीकेशन कोड, उदाहरण के लिए XXXXX-XXXXX। आवश्यक।
notificationHandling	स्ट्रिंग	वैकल्पिक। default या manual। डिफ़ॉल्ट व्यवहार के लिए इसे खाली छोड़ दें।

एक बूलियन लौटाता है जो SDK शुरू होने पर सही होता है।

रजिस्ट्रेशन एक्शन

ये एक्शन नियंत्रित करते हैं कि यह डिवाइस नोटिफिकेशन प्राप्त करता है या नहीं, और उन पहचानकर्ताओं को उजागर करता है जो इसे संबोधित करते हैं।

RegisterForPushNotifications

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

पुश टोकन के साथ एक स्ट्रिंग लौटाता है।

UnregisterForPushNotifications

डिवाइस को अनरजिस्टर करता है। यह नोटिफिकेशन प्राप्त करना बंद कर देता है जब तक कि RegisterForPushNotifications को फिर से कॉल नहीं किया जाता है।

एक स्ट्रिंग लौटाता है जिसमें वह टोकन होता है जिसके साथ डिवाइस को अनरजिस्टर किया गया था।

GetPushToken

वर्तमान पुश टोकन लौटाता है, या यदि डिवाइस अभी तक पंजीकृत नहीं है तो एक खाली स्ट्रिंग लौटाता है।

एक स्ट्रिंग लौटाता है।

GetHwid

डिवाइस का HWID लौटाता है, वह पहचानकर्ता जिसके द्वारा Pushwoosh इसे संबोधित करता है। इसका उपयोग Pushwoosh कंट्रोल पैनल या सर्वर API से एक ही डिवाइस को लक्षित करने के लिए करें।

एक स्ट्रिंग लौटाता है।

यूज़र आइडेंटिटी एक्शन

ये एक्शन एक डिवाइस को एक व्यक्ति से जोड़ते हैं, ताकि एक संदेश उस व्यक्ति द्वारा उपयोग किए जाने वाले हर डिवाइस तक पहुंचे।

SetUserId

डिवाइस को एक उपयोगकर्ता के साथ संबद्ध करता है। इसे लॉगिन के बाद कॉल करें।

पैरामीटर	प्रकार	विवरण
userId	स्ट्रिंग	उपयोगकर्ता के लिए आपका अपना पहचानकर्ता। आवश्यक।

एक बूलियन लौटाता है।

GetUserId

डिवाइस के साथ वर्तमान में संबद्ध उपयोगकर्ता आईडी लौटाता है, या यदि कोई सेट नहीं है तो एक खाली स्ट्रिंग लौटाता है।

एक स्ट्रिंग लौटाता है।

SetEmails

उपयोगकर्ता के ईमेल पते Pushwoosh के साथ पंजीकृत करता है, ताकि उन तक ईमेल के साथ-साथ पुश द्वारा भी पहुंचा जा सके।

पैरामीटर	प्रकार	विवरण
emails	स्ट्रिंग	एक पता, या अल्पविराम से अलग किए गए कई पते। आवश्यक।

एक बूलियन लौटाता है।

टैग एक्शन

टैग डिवाइस की वे प्रॉपर्टीज़ हैं जिनसे Pushwoosh कंट्रोल पैनल में सेगमेंट बनाए जाते हैं।

SetTags

डिवाइस पर टैग सेट करता है।

पैरामीटर	प्रकार	विवरण
tagsJson	स्ट्रिंग	एक JSON ऑब्जेक्ट, उदाहरण के लिए {"Language":"en","Level":7,"Premium":true}। आवश्यक।

एक बूलियन लौटाता है।

Mendix एक्सप्रेशन में कोट्स

Mendix एक्सप्रेशन में एक स्ट्रिंग सिंगल कोट्स में लिखी जाती है, इसलिए इसके अंदर का JSON अपने डबल कोट्स को अनएस्केप रखता है: '{"Language":"en"}'। एक्सप्रेशन के अंदर "" या \" लिखने से एक ऐसी स्ट्रिंग बनती है जिसे एक्शन पार्स नहीं कर सकता।

GetTags

डिवाइस पर वर्तमान में सेट किए गए टैग को JSON स्ट्रिंग के रूप में लौटाता है।

एक स्ट्रिंग लौटाता है।

इवेंट एक्शन

इवेंट वे हैं जिनसे ट्रिगर किए गए अभियान और इन-ऐप संदेश शुरू किए जाते हैं।

PostEvent

Pushwoosh पर एक इवेंट पोस्ट करता है।

पैरामीटर	प्रकार	विवरण
eventName	स्ट्रिंग	कंट्रोल पैनल में कॉन्फ़िगर किया गया इवेंट नाम। आवश्यक।
attributesJson	स्ट्रिंग	वैकल्पिक। इवेंट एट्रिब्यूट्स का एक JSON ऑब्जेक्ट।

एक बूलियन लौटाता है।

अंतर्निहित SDK कॉल न तो सफलता और न ही विफलता की रिपोर्ट करता है, इसलिए एक्शन जैसे ही कॉल SDK को सौंप दिया जाता है, सही लौटाता है।

लोकल नोटिफिकेशन एक्शन

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

ScheduleLocalNotification

डिवाइस पर एक लोकल नोटिफिकेशन शेड्यूल करता है।

पैरामीटर	प्रकार	विवरण
message	स्ट्रिंग	नोटिफिकेशन टेक्स्ट। आवश्यक।
afterSeconds	Integer/Long	इसे दिखाने से पहले कितना इंतजार करना है, सेकंड में। आवश्यक, और शून्य या अधिक।
customDataJson	स्ट्रिंग	वैकल्पिक। एक JSON ऑब्जेक्ट जो नोटिफिकेशन के साथ वापस डिलीवर किया जाता है।

जैसे ही कॉल SDK को सौंप दिया जाता है, एक बूलियन लौटाता है। SDK यह रिपोर्ट नहीं करता है कि नोटिफिकेशन वास्तव में शेड्यूल किया गया था या नहीं।

ClearLocalNotifications

उन लोकल नोटिफिकेशन को रद्द करता है जो शेड्यूल किए गए थे लेकिन अभी तक फायर नहीं हुए हैं।

जैसे ही कॉल SDK को सौंप दिया जाता है, एक बूलियन लौटाता है।

ClearNotificationCenter

ऐप के पहले से डिलीवर किए गए नोटिफिकेशन को नोटिफिकेशन सेंटर से हटाता है।

जैसे ही कॉल SDK को सौंप दिया जाता है, एक बूलियन लौटाता है।

प्राइवेसी एक्शन

ये एक्शन आपके ऐप में एक सहमति टॉगल का समर्थन करते हैं, और डिवाइस के लिए सभी Pushwoosh मैसेजिंग को चालू या बंद करते हैं।

IsCommunicationEnabled

बताता है कि क्या डिवाइस को वर्तमान में Pushwoosh से संचार प्राप्त करने की अनुमति है। इसका उपयोग प्राइवेसी टॉगल की स्थिति को रेंडर करने के लिए करें।

एक बूलियन लौटाता है।

SetCommunicationEnabled

डिवाइस के लिए Pushwoosh के साथ संचार को चालू या बंद करता है। इसे बंद करने से सभी मैसेजिंग बंद हो जाती है, जो इसे “मुझसे संपर्क न करें” टॉगल से जोड़ने के लिए एक्शन बनाता है।

पैरामीटर	प्रकार	विवरण
enabled	बूलियन	मैसेजिंग की अनुमति देने के लिए सही, इसे रोकने के लिए गलत। आवश्यक।

एक बूलियन लौटाता है।

सेटिंग्स एक्शन

ये एक्शन बदलते हैं कि SDK इस डिवाइस के लिए कैसे व्यवहार करता है।

SetLanguage

उस भाषा को ओवरराइड करता है जिसका उपयोग Pushwoosh डिवाइस के लिए संदेशों को स्थानीयकृत करने के लिए करता है। डिफ़ॉल्ट रूप से डिवाइस की भाषा का उपयोग किया जाता है।

पैरामीटर	प्रकार	विवरण
language	स्ट्रिंग	एक दो-अक्षर का कोड जैसे en, de, nl। आवश्यक।

जैसे ही कॉल SDK को सौंप दिया जाता है, एक बूलियन लौटाता है।

SetReverseProxy

सभी Pushwoosh ट्रैफिक को आपके अपने एंडपॉइंट के माध्यम से रूट करता है। इसे Initialize से पहले कॉल करें, अन्यथा शुरुआती अनुरोध अभी भी सीधे Pushwoosh पर जाएंगे।

पैरामीटर	प्रकार	विवरण
url	स्ट्रिंग	प्रॉक्सी बेस URL। आवश्यक।
headersJson	स्ट्रिंग	वैकल्पिक। अतिरिक्त HTTP हेडर का एक JSON ऑब्जेक्ट।

जैसे ही कॉल SDK को सौंप दिया जाता है, एक बूलियन लौटाता है।

SetShowForegroundAlert

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

पैरामीटर	प्रकार	विवरण
showAlert	बूलियन	सिस्टम अलर्ट दिखाने के लिए सही। आवश्यक।

जैसे ही कॉल SDK को सौंप दिया जाता है, एक बूलियन लौटाता है।

केवल iOS

Android SDK इस सेटिंग को एक्सपोज़ नहीं करता है, और Android पर एक्शन को कॉल करने से एक एरर आता है। इसे केवल iOS पर कॉल करें।

GetShowForegroundAlert

बताता है कि ऐप खुला होने पर आने वाला नोटिफिकेशन सिस्टम अलर्ट के रूप में दिखाया जाएगा या नहीं। यह डिफ़ॉल्ट रूप से चालू होता है।

एक बूलियन लौटाता है।

केवल iOS

Android SDK इस सेटिंग को एक्सपोज़ नहीं करता है, और Android पर एक्शन को कॉल करने से एक एरर आता है। इसे केवल iOS पर कॉल करें।

अन्य चैनल एक्शन

ये एक्शन उपयोगकर्ता को उन मैसेजिंग चैनलों के लिए पंजीकृत करते हैं जिन्हें Pushwoosh पुश से परे समर्थन करता है।

RegisterSmsNumber

उपयोगकर्ता का फ़ोन नंबर पंजीकृत करता है ताकि Pushwoosh उन तक SMS के माध्यम से पहुंच सके।

पैरामीटर	प्रकार	विवरण
phoneNumber	स्ट्रिंग	अंतर्राष्ट्रीय प्रारूप में, उदाहरण के लिए +31201234567। आवश्यक।

जैसे ही कॉल SDK को सौंप दिया जाता है, एक बूलियन लौटाता है।

RegisterWhatsappNumber

उपयोगकर्ता का फ़ोन नंबर पंजीकृत करता है ताकि Pushwoosh उन तक WhatsApp के माध्यम से पहुंच सके।

पैरामीटर	प्रकार	विवरण
phoneNumber	स्ट्रिंग	अंतर्राष्ट्रीय प्रारूप में, उदाहरण के लिए +31201234567। आवश्यक।

जैसे ही कॉल SDK को सौंप दिया जाता है, एक बूलियन लौटाता है।