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

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

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

### CheckPushwooshPlugin

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

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

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

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

<img src="/outsystems-pushwoosh-outsystems-plugin-client-actions-1.webp" alt="CheckPushwooshPlugin एक्शन"/>

### 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** सूची के माध्यम से सुलभ हैं।

<img src="/outsystems-pushwoosh-outsystems-plugin-client-actions-2.webp" alt=""/>

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

<img src="/outsystems-pushwoosh-outsystems-plugin-client-actions-3.webp" alt=""/>

<img src="/outsystems-pushwoosh-outsystems-plugin-client-actions-4.webp" alt=""/>

### PostEvent

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

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

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

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

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

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

<img src="/outsystems-pushwoosh-outsystems-plugin-client-actions-5.webp" alt=""/>

**1. असाइन करें**

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

<img src="/outsystems-pushwoosh-outsystems-plugin-client-actions-6.webp" alt=""/>

2. ईवेंट के साथ संबद्ध होने वाले एट्रिब्यूट्स की सूचियाँ बनाएँ।

<img src="/outsystems-pushwoosh-outsystems-plugin-client-actions-7.webp" alt=""/>

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

<img src="/outsystems-pushwoosh-outsystems-plugin-client-actions-8.webp" alt=""/>

### 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 हो। |

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

<img src="/outsystems-pushwoosh-outsystems-plugin-client-actions-9.webp" alt=""/>

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

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

<img src="/outsystems-pushwoosh-outsystems-plugin-client-actions-10.webp" alt=""/>

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

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

<img src="/outsystems-pushwoosh-outsystems-plugin-client-actions-11.webp" alt=""/>

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

<img src="/outsystems-pushwoosh-outsystems-plugin-client-actions-12.webp" alt=""/>

### SetUserId

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

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

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

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

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

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

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

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

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

### 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 हो। |