การดำเนินการของไคลเอ็นต์ปลั๊กอิน Pushwoosh Outsystems

ปลั๊กอินมีชุดการดำเนินการของไคลเอ็นต์เพื่ออำนวยความสะดวกในการจัดการ push notification การดำเนินการเหล่านี้ช่วยให้คุณสามารถลงทะเบียนและยกเลิกการลงทะเบียนอุปกรณ์, ตั้งค่าและรับ tags, จัดการข้อความใน inbox และอื่นๆ

การดำเนินการของไคลเอ็นต์ปลั๊กอิน Pushwoosh

CheckPushwooshPlugin

ตรวจสอบว่าปลั๊กอิน Pushwoosh พร้อมใช้งานในปัจจุบันหรือไม่

พารามิเตอร์เอาต์พุต

IsAvailable	คืนค่า true หากปลั๊กอินพร้อมใช้งาน, มิฉะนั้นคืนค่า false
Error	ข้อผิดพลาดที่มีรหัสข้อผิดพลาดและข้อความแสดงข้อผิดพลาดพร้อมรายละเอียดเกี่ยวกับข้อผิดพลาดที่อาจเกิดขึ้น จะถูกตั้งค่าเมื่อพารามิเตอร์เอาต์พุต Success เป็น false เท่านั้น

ตัวอย่างการใช้งาน

RegisterDevice

ลงทะเบียนอุปกรณ์สำหรับ push notifications และดึง Push Token

พารามิเตอร์อินพุต

ApplicationCode	Text, รหัสแอปพลิเคชัน Pushwoosh ที่ได้รับจากการตั้งค่าบัญชีของคุณ

พารามิเตอร์เอาต์พุต

RegisterToken	Token ที่ได้รับจาก Google หรือ Apple สำหรับอุปกรณ์
Success	คืนค่า true หากทุกอย่างเป็นไปตามที่คาดไว้, false หากมีข้อผิดพลาด
Error	ข้อผิดพลาดที่มีรหัสข้อผิดพลาดและข้อความแสดงข้อผิดพลาดพร้อมรายละเอียดเกี่ยวกับข้อผิดพลาดที่อาจเกิดขึ้น จะถูกตั้งค่าเมื่อพารามิเตอร์เอาต์พุต Success เป็น false เท่านั้น

UnregisterDevice

ยกเลิกการลงทะเบียนอุปกรณ์จากการรับ push notifications

พารามิเตอร์เอาต์พุต

Success	คืนค่า true หากทุกอย่างเป็นไปตามที่คาดไว้, false หากมีข้อผิดพลาด
Error	ข้อผิดพลาดที่มีรหัสข้อผิดพลาดและข้อความแสดงข้อผิดพลาดพร้อมรายละเอียดเกี่ยวกับข้อผิดพลาดที่อาจเกิดขึ้น จะถูกตั้งค่าเมื่อพารามิเตอร์เอาต์พุต Success เป็น false เท่านั้น

GetDeviceID

ดึง ID ของอุปกรณ์ ซึ่งควรเป็นตัวระบุที่ไม่ซ้ำกัน

พารามิเตอร์เอาต์พุต

DeviceHwid	ตัวระบุที่ไม่ซ้ำกันของอุปกรณ์
Error	ข้อผิดพลาดที่มีรหัสข้อผิดพลาดและข้อความแสดงข้อผิดพลาดพร้อมรายละเอียดเกี่ยวกับข้อผิดพลาดที่อาจเกิดขึ้น จะถูกตั้งค่าเมื่อมีข้อผิดพลาดเท่านั้น

GetDeviceType

รับประเภทของอุปกรณ์ (Android, iOS หรือ Windows)

พารามิเตอร์เอาต์พุต

DeviceTypeId	ตัวระบุของประเภทอุปกรณ์นี้

GetTags

ดึงข้อมูล tags จาก Pushwoosh

พารามิเตอร์เอาต์พุต

Success	คืนค่า true หากทุกอย่างเป็นไปตามที่คาดไว้, false หากมีข้อผิดพลาด
Error	ข้อผิดพลาดที่มีรหัสข้อผิดพลาดและข้อความแสดงข้อผิดพลาดพร้อมรายละเอียดเกี่ยวกับข้อผิดพลาดที่อาจเกิดขึ้น จะถูกตั้งค่าเมื่อพารามิเตอร์เอาต์พุต Success เป็น false เท่านั้น
Tags	คืนค่า Key, Value Record List ที่มี tags ทั้งหมดที่กำหนดให้กับอุปกรณ์นี้

ตัวอย่างการใช้งาน

1. เรียกใช้การดำเนินการ GetTags เพื่อดึงข้อมูล tags จาก Pushwoosh
2. tags ที่ส่งคืนมาสามารถเข้าถึงได้ผ่านรายการ GetTags.Tags

3. ใช้การดำเนินการ LogMessage เพื่อบันทึก key และ value ของแต่ละ tag

PostEvent

ส่งข้อความไปยัง Pushwoosh เมื่อมี event เฉพาะเกิดขึ้นในแอปพลิเคชันของคุณ

พารามิเตอร์อินพุต

EventName	Text, ชื่อของ event
EventAttributes	Key, Value Record List, ใช้เพื่อส่งข้อมูล event เพิ่มเติมไปยัง Pushwoosh (เช่น สำหรับการดำเนินการ “UserLogin” คุณอาจต้องการส่งข้อมูลการเข้าสู่ระบบ เช่น - {"username":"John"})

พารามิเตอร์เอาต์พุต

Success	คืนค่า true หากทุกอย่างเป็นไปตามที่คาดไว้, false หากมีข้อผิดพลาด
Error	ข้อผิดพลาดที่มีรหัสข้อผิดพลาดและข้อความแสดงข้อผิดพลาดพร้อมรายละเอียดเกี่ยวกับข้อผิดพลาดที่อาจเกิดขึ้น จะถูกตั้งค่าเมื่อพารามิเตอร์เอาต์พุต Success เป็น false เท่านั้น

ตัวอย่างการใช้งาน

1. กำหนดค่า (Assign)

ตั้งค่าคู่ key-value เพื่อกำหนดข้อมูลสำหรับ event ตัวอย่างเช่น KeyValue1.AttributeName เป็น “test1” และ KeyValue1.Value เป็น “test1value” ในทำนองเดียวกัน กำหนด KeyValue2 ด้วยชื่อและค่า attribute ที่เหมาะสม

2. สร้างรายการของ attributes ที่จะเชื่อมโยงกับ event

3. สุดท้าย กำหนดค่าการดำเนินการ PostEvent

SetBadgeNumber

ตั้งค่าหมายเลขบนไอคอนแอปพลิเคชัน (badge)

พารามิเตอร์อินพุต

BadgeNumber	Integer, หมายเลขบนไอคอน (badge)

พารามิเตอร์เอาต์พุต

Success	คืนค่า true หากทุกอย่างเป็นไปตามที่คาดไว้, false หากมีข้อผิดพลาด
Error	ข้อผิดพลาดที่มีรหัสข้อผิดพลาดและข้อความแสดงข้อผิดพลาดพร้อมรายละเอียดเกี่ยวกับข้อผิดพลาดที่อาจเกิดขึ้น จะถูกตั้งค่าเมื่อพารามิเตอร์เอาต์พุต Success เป็น false เท่านั้น

SetLanguage

ตั้งค่าภาษาของแอปพลิเคชันเองแทนภาษาเริ่มต้นของระบบ

พารามิเตอร์อินพุต

Language	Text, ภาษาของแอปพลิเคชันที่กำหนดเองในรูปแบบ ISO 2 ตัวอักษร (เช่น “en”, “es”, “fr”)

SetTags

ส่ง tags และค่าของ tags ไปยัง Pushwoosh

พารามิเตอร์อินพุต

Tags	TagName, TagValue Record List ที่มี tags ทั้งหมดที่คุณต้องการส่ง ประเภท TagName ควรเป็น Text เสมอ ในขณะที่ TagValue สามารถเป็น Text, Integer, Boolean, Date ฯลฯ

พารามิเตอร์เอาต์พุต

Success	คืนค่า true หากทุกอย่างเป็นไปตามที่คาดไว้, false หากมีข้อผิดพลาด
Error	ข้อผิดพลาดที่มีรหัสข้อผิดพลาดและข้อความแสดงข้อผิดพลาดพร้อมรายละเอียดเกี่ยวกับข้อผิดพลาดที่อาจเกิดขึ้น จะถูกตั้งค่าเมื่อพารามิเตอร์เอาต์พุต Success เป็น false เท่านั้น

ตัวอย่างการใช้งาน

1. กำหนดค่า tag ในตัวอย่างด้านล่าง มีสอง tags:

• Tag1 ที่มีชื่อ testTag และค่าของมันถูกตั้งเป็นวันที่ปัจจุบัน
• Tag2 ที่มีชื่อ testTag2 และค่าของมันถูกตั้งเป็น True

2. จากนั้น เพิ่ม tags ไปยังรายการ ในตัวอย่างนี้:

• ListAppend3 เพิ่ม Tag1 ไปยังรายการ LocalTag
• ListAppend4 เพิ่ม Tag2 ไปยังรายการ LocalTag

3. หลังจากเติมรายการด้วย tags ที่จำเป็นแล้ว ให้ใช้การดำเนินการของไคลเอ็นต์ SetTags เพื่อส่งรายการนี้ไปยัง Pushwoosh

SetUserId

กำหนด User ID ที่กำหนดเองให้กับอุปกรณ์นี้

พารามิเตอร์อินพุต

UserID	Text, User ID ที่กำหนดเอง

พารามิเตอร์เอาต์พุต

Success	คืนค่า true หากทุกอย่างเป็นไปตามที่คาดไว้, false หากมีข้อผิดพลาด
Error	ข้อผิดพลาดที่มีรหัสข้อผิดพลาดและข้อความแสดงข้อผิดพลาดพร้อมรายละเอียดเกี่ยวกับข้อผิดพลาดที่อาจเกิดขึ้น จะถูกตั้งค่าเมื่อพารามิเตอร์เอาต์พุต Success เป็น false เท่านั้น

SetApiToken

ตั้งค่า Pushwoosh Device API token ที่ใช้โดย SDK เรียกใช้ก่อน RegisterDevice นอกจากนี้ยังสามารถตั้งค่า token ตอน build time ด้วย preference PW_API_TOKEN — ดูที่ คู่มือการผสานรวม

พารามิเตอร์อินพุต

Token	Text, Device API token จาก Pushwoosh Control Panel (ส่วน API Access)

EnableHuaweiPushNotifications

สลับการส่ง push ไปยัง Huawei Push Kit (HMS) เรียกใช้ก่อน RegisterDevice บนอุปกรณ์ Huawei ต้องมีการกำหนดค่า Huawei — ดูที่ Huawei for Outsystems

การดำเนินการนี้ไม่มีพารามิเตอร์เอาต์พุตและไม่รายงานความสำเร็จหรือความล้มเหลว หากต้องการตรวจสอบว่าอุปกรณ์ลงทะเบียนด้วยการส่งแบบใด ให้ใช้ GetDiagnostics

SetMultiNotificationMode

พร้อมใช้งานตั้งแต่ Pushwoosh Plugin component เวอร์ชัน 4.7.0 สำหรับ Android เท่านั้น — ทำให้ push ทุกอันปรากฏเป็นการแจ้งเตือนแยกกันแทนที่จะแทนที่อันก่อนหน้า เรียกใช้ครั้งเดียวหลังจากการเริ่มต้น — ตัวอย่างเช่น ใน handler ของ event OnInitializeOver หลังจาก RegisterDevice การตั้งค่านี้จะถูกเก็บไว้โดย SDK และยังคงอยู่แม้จะรีสตาร์ทแอป Android จะจัดกลุ่มการแจ้งเตือนไว้ใน stack ที่ขยายได้ — ซึ่งเป็นพฤติกรรมมาตรฐานของระบบ ไม่มีการใช้งานสำหรับ iOS (iOS ไม่เคยแทนที่การแจ้งเตือน) — ควรป้องกันการเรียกใช้ด้วย GetDeviceType แทนที่จะใส่ไว้ใน flow ที่ทำงานบน iOS ด้วย

GetDiagnostics

พร้อมใช้งานตั้งแต่ Pushwoosh Plugin component เวอร์ชัน 4.7.0 คืนค่าสถานะการผสานรวมเป็นสตริง JSON: Application Code ที่มีผลและที่มาพร้อมกับ build และที่มาของมัน, การมีอยู่ของ API token, HWID, push token, สถานะการอนุญาตการแจ้งเตือน และเวอร์ชันของปลั๊กอินและ SDK ดั้งเดิม บน Android ยังรวมถึง User ID และรายการของบริการที่ลงทะเบียนสำหรับ event การส่งข้อความ FCM/HMS (สองฟิลด์นี้ไม่มีใน iOS) แนบผลลัพธ์ของมันไปกับตั๋วสนับสนุนแทนการรวบรวมบันทึกของอุปกรณ์

พารามิเตอร์เอาต์พุต

DiagnosticsJSON	Text, สถานะการผสานรวมเป็นสตริง 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 Inbox

กระบวนการทำงานกับ Inbox มีดังนี้:

1. โหลดรายการของอ็อบเจกต์ InboxMessage
2. ใช้อ็อบเจกต์เหล่านี้เพื่อแสดงผลมุมมอง inbox
3. ดำเนินการตามที่ระบุไว้ด้านล่าง หรือลบอ็อบเจกต์เหล่านี้โดยใช้การดำเนินการที่อธิบายไว้ด้านล่าง

code	Text	ID ที่ไม่ซ้ำกันของการแจ้งเตือนใน inbox
title	Text	ชื่อเรื่องการแจ้งเตือน
message	Text	ข้อความแจ้งเตือน
imageUrl	Text	URL ของรูปภาพที่กำหนดเองที่แนบมากับการแจ้งเตือน
sendDate	Date Time	แสดงเวลาที่ส่งการแจ้งเตือน
type	Integer	ประเภทของการแจ้งเตือน ค่าที่เป็นไปได้: 0 - การแจ้งเตือนปกติ 1 - การแจ้งเตือน rich media 2 - การแจ้งเตือน URL 3 - การแจ้งเตือน deep link
bannerUrl	Text	มี URL ของแบนเนอร์ Android
customData	Key, Value Record List	มีรายการพารามิเตอร์ที่ส่งเป็นข้อมูลที่กำหนดเอง
isRead	Boolean	True หากการแจ้งเตือนใน inbox ถูกอ่านแล้ว
isActionPerformed	Boolean	True หากการดำเนินการแจ้งเตือนได้ถูกกระทำ สำหรับการแจ้งเตือนปกติ, true หากการแจ้งเตือนถูกอ่านแล้ว สำหรับ Rich Media, true หาก rich media ถูกนำเสนอ สำหรับ URL และ deep links, true หาก URL/deep link ถูกเปิด

LoadMessages

ดึงการแจ้งเตือนใน inbox จาก Pushwoosh

พารามิเตอร์เอาต์พุต

InboxMessages	InboxMessage List, รายการของข้อความใน inbox ทั้งหมด
Success	คืนค่า true หากทุกอย่างเป็นไปตามที่คาดไว้, false หากมีข้อผิดพลาด
Error	ข้อผิดพลาดที่มีรหัสข้อผิดพลาดและข้อความแสดงข้อผิดพลาดพร้อมรายละเอียดเกี่ยวกับข้อผิดพลาดที่อาจเกิดขึ้น จะถูกตั้งค่าเมื่อพารามิเตอร์เอาต์พุต Success เป็น false เท่านั้น

ReadMessage

ทำเครื่องหมายข้อความใน inbox ว่าอ่านแล้ว

พารามิเตอร์อินพุต

MessageCode	Text, รหัสของ InboxMessage (ได้รับเป็นพารามิเตอร์ของ InboxMessage ใน LoadMessages)

พารามิเตอร์เอาต์พุต

Success	True หากทุกอย่างเป็นไปตามที่คาดไว้, false หากมีข้อผิดพลาด
Error	ข้อผิดพลาดที่มีรหัสข้อผิดพลาดและข้อความแสดงข้อผิดพลาดพร้อมรายละเอียดเกี่ยวกับข้อผิดพลาดที่อาจเกิดขึ้น จะถูกตั้งค่าเมื่อพารามิเตอร์เอาต์พุต Success เป็น false เท่านั้น

PerformAction

ดำเนินการสำหรับข้อความใน inbox ที่ระบุ (เช่น เปิด URL ในเบราว์เซอร์)

พารามิเตอร์อินพุต

MessageCode	Text, รหัสของ InboxMessage (ได้รับเป็นพารามิเตอร์ของ InboxMessage ใน LoadMessages)

พารามิเตอร์เอาต์พุต

Success	คืนค่า true หากทุกอย่างเป็นไปตามที่คาดไว้, false หากมีข้อผิดพลาด
Error	ข้อผิดพลาดที่มีรหัสข้อผิดพลาดและข้อความแสดงข้อผิดพลาดพร้อมรายละเอียดเกี่ยวกับข้อผิดพลาดที่อาจเกิดขึ้น จะถูกตั้งค่าเมื่อพารามิเตอร์เอาต์พุต Success เป็น false เท่านั้น

DeleteMessage

ลบข้อความออกจาก inbox

พารามิเตอร์อินพุต

MessageCode	Text, รหัสของ InboxMessage (ได้รับเป็นพารามิเตอร์ของ InboxMessage ใน LoadMessages)

พารามิเตอร์เอาต์พุต

Success	คืนค่า true หากทุกอย่างเป็นไปตามที่คาดไว้, false หากมีข้อผิดพลาด
Error	ข้อผิดพลาดที่มีรหัสข้อผิดพลาดและข้อความแสดงข้อผิดพลาดพร้อมรายละเอียดเกี่ยวกับข้อผิดพลาดที่อาจเกิดขึ้น จะถูกตั้งค่าเมื่อพารามิเตอร์เอาต์พุต Success เป็น false เท่านั้น

TotalMessagesCount

คืนค่าจำนวนข้อความใน inbox ทั้งหมด

พารามิเตอร์เอาต์พุต

MessagesCount	Integer, จำนวนข้อความใน inbox ทั้งหมด
Success	คืนค่า true หากทุกอย่างเป็นไปตามที่คาดไว้, false หากมีข้อผิดพลาด
Error	ข้อผิดพลาดที่มีรหัสข้อผิดพลาดและข้อความแสดงข้อผิดพลาดพร้อมรายละเอียดเกี่ยวกับข้อผิดพลาดที่อาจเกิดขึ้น จะถูกตั้งค่าเมื่อพารามิเตอร์เอาต์พุต Success เป็น false เท่านั้น

UnreadMessagesCount

คืนค่าจำนวนข้อความใน inbox ที่ยังไม่ได้อ่าน

พารามิเตอร์เอาต์พุต

UnreadMessagesCount	Integer, จำนวนข้อความใน inbox ที่ยังไม่ได้อ่าน
Success	คืนค่า true หากทุกอย่างเป็นไปตามที่คาดไว้, false หากมีข้อผิดพลาด
Error	ข้อผิดพลาดที่มีรหัสข้อผิดพลาดและข้อความแสดงข้อผิดพลาดพร้อมรายละเอียดเกี่ยวกับข้อผิดพลาดที่อาจเกิดขึ้น จะถูกตั้งค่าเมื่อพารามิเตอร์เอาต์พุต Success เป็น false เท่านั้น

MessagesWithNoActionPerformedCount

คืนค่าจำนวนข้อความใน inbox ที่ไม่มีการดำเนินการใดๆ

พารามิเตอร์เอาต์พุต

MessagesWithNoActionPerformedCount	Integer, จำนวนข้อความใน inbox ที่ไม่มีการดำเนินการใดๆ
Success	คืนค่า true หากทุกอย่างเป็นไปตามที่คาดไว้, false หากมีข้อผิดพลาด
Error	ข้อผิดพลาดที่มีรหัสข้อผิดพลาดและข้อความแสดงข้อผิดพลาดพร้อมรายละเอียดเกี่ยวกับข้อผิดพลาดที่อาจเกิดขึ้น จะถูกตั้งค่าเมื่อพารามิเตอร์เอาต์พุต Success เป็น false เท่านั้น