การดำเนินการของโมดูล Pushwoosh Mendix

โมดูล Pushwoosh สำหรับ Mendix เปิดเผยฟังก์ชันการทำงานในสองที่: วิดเจ็ต Pushwoosh events ซึ่งเริ่มต้น SDK และเปลี่ยนการแจ้งเตือนที่เข้ามาเป็นเหตุการณ์ nanoflow และการดำเนินการ JavaScript ที่คุณเรียกจาก nanoflow ใดๆ บนโปรไฟล์การนำทางของมือถือเนทีฟ หน้านี้จะแสดงรายการทั้งสองอย่าง

คุณสมบัติของวิดเจ็ต Pushwoosh events

วิดเจ็ตไม่ได้แสดงผลอะไร วางไว้ครั้งเดียวบนหน้าที่โหลดเป็นหน้าแรกในโปรไฟล์การนำทางของมือถือเนทีฟ มันจะเริ่มต้น SDK, ลงทะเบียนอุปกรณ์ (เป็นทางเลือก) และเรียกใช้ nanoflow สำหรับแต่ละเหตุการณ์การแจ้งเตือนแบบพุช

การตั้งค่า

คุณสมบัติเหล่านี้จะเริ่มต้น SDK และรายงานเมื่อพร้อมใช้งาน

คุณสมบัติ	หน้าที่
Application Code	Pushwoosh Application Code ของแอปของคุณ เช่น XXXXX-XXXXX จำเป็นต้องระบุ
Register on load	ลงทะเบียนอุปกรณ์ทันทีที่วิดเจ็ตโหลด บน iOS จะแสดงข้อความขออนุญาตจากระบบ ดังนั้นให้ปิดหากคุณต้องการถามในภายหลังด้วยการดำเนินการ RegisterForPushNotifications
On initialized	nanoflow ที่ทำงานเมื่อ SDK เริ่มทำงานแล้ว
On registered	nanoflow ที่ทำงานเมื่ออุปกรณ์มี push token
Push token	แอตทริบิวต์สตริงที่ push token ถูกเขียนเข้าไปก่อนที่ On registered จะทำงาน

Push events

คุณสมบัติเหล่านี้จะส่งการแจ้งเตือนที่เข้ามาไปยังโมเดลของคุณและเรียกใช้ nanoflow

คุณสมบัติ	หน้าที่
Payload	แอตทริบิวต์สตริงที่รับ payload การแจ้งเตือนทั้งหมดในรูปแบบ JSON
Message	แอตทริบิวต์สตริงที่รับข้อความการแจ้งเตือน
On push received	nanoflow ที่ทำงานเมื่อมีการแจ้งเตือนมาถึงในขณะที่แอปอยู่ในเบื้องหน้า
On push opened	nanoflow ที่ทำงานเมื่อผู้ใช้แตะที่การแจ้งเตือน

Deep links

คุณสมบัติเหล่านี้จัดการกับการแจ้งเตือนที่มีลิงก์ไปยังหน้าเฉพาะของแอป

คุณสมบัติ	หน้าที่
Deep link	แอตทริบิวต์สตริงที่รับ URL ของ deep link จากการแจ้งเตือน
On deep link	nanoflow ที่ทำงานเมื่อการแจ้งเตือนที่เปิดมีลิงก์ มันจะทำงานเพิ่มเติมจาก On push opened

แอตทริบิวต์จะถูกเติมก่อนที่ nanoflow จะทำงาน ดังนั้น nanoflow จึงสามารถอ่านได้ทันที

การดำเนินการตั้งค่า

ใช้การดำเนินการเหล่านี้เมื่อคุณเริ่มต้น SDK ด้วยตัวเองแทนที่จะใช้วิดเจ็ต

Initialize

เริ่มต้น Pushwoosh SDK เรียกใช้ครั้งเดียวก่อนการดำเนินการ Pushwoosh อื่นๆ โดยทั่วไปจะมาจาก on-load nanoflow ของหน้าแรก คุณไม่จำเป็นต้องใช้เมื่อมีวิดเจ็ต Pushwoosh events อยู่บนหน้า เพราะวิดเจ็ตจะเริ่มต้น SDK ด้วยตัวเอง

บน Android, FCM Sender ID มาจาก google-services.json ซึ่ง native build จะนำไปใช้ มันไม่ได้ถูกส่งไปยังการดำเนินการนี้

พารามิเตอร์	ประเภท	คำอธิบาย
applicationCode	String	Pushwoosh Application Code เช่น XXXXX-XXXXX จำเป็นต้องระบุ
notificationHandling	String	ไม่บังคับ default หรือ manual เว้นว่างไว้สำหรับพฤติกรรมเริ่มต้น

คืนค่าเป็น Boolean ซึ่งเป็น true เมื่อ SDK เริ่มทำงาน

การดำเนินการลงทะเบียน

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

RegisterForPushNotifications

ลงทะเบียนอุปกรณ์สำหรับการแจ้งเตือนแบบพุชและคืนค่า push token บน iOS จะเรียกใช้ข้อความขออนุญาตจากระบบ ดังนั้นให้เรียกใช้ในจุดที่การขออนุญาตมีความสมเหตุสมผลต่อผู้ใช้

คืนค่าเป็น String พร้อม push token

UnregisterForPushNotifications

ยกเลิกการลงทะเบียนอุปกรณ์ มันจะหยุดรับการแจ้งเตือนจนกว่าจะมีการเรียก RegisterForPushNotifications อีกครั้ง

คืนค่าเป็น String พร้อม token ที่อุปกรณ์ถูกยกเลิกการลงทะเบียน

GetPushToken

คืนค่า push token ปัจจุบัน หรือสตริงว่างหากอุปกรณ์ยังไม่ได้ลงทะเบียน

คืนค่าเป็น String

GetHwid

คืนค่า HWID ของอุปกรณ์ ซึ่งเป็นตัวระบุที่ Pushwoosh ใช้ในการระบุอุปกรณ์ ใช้เพื่อกำหนดเป้าหมายอุปกรณ์เดียวจาก Pushwoosh Control Panel หรือ server API

คืนค่าเป็น String

การดำเนินการระบุตัวตนผู้ใช้

การดำเนินการเหล่านี้เชื่อมต่ออุปกรณ์กับบุคคล เพื่อให้ข้อความเดียวไปถึงทุกอุปกรณ์ที่บุคคลนั้นใช้

SetUserId

เชื่อมโยงอุปกรณ์กับผู้ใช้ เรียกใช้หลังจากการเข้าสู่ระบบ

พารามิเตอร์	ประเภท	คำอธิบาย
userId	String	ตัวระบุของคุณเองสำหรับผู้ใช้ จำเป็นต้องระบุ

คืนค่าเป็น Boolean

GetUserId

คืนค่า User ID ที่เชื่อมโยงกับอุปกรณ์ในปัจจุบัน หรือสตริงว่างหากไม่มีการตั้งค่า

คืนค่าเป็น String

SetEmails

ลงทะเบียนที่อยู่อีเมลของผู้ใช้กับ Pushwoosh เพื่อให้สามารถติดต่อพวกเขาทางอีเมลได้เช่นเดียวกับทางพุช

พารามิเตอร์	ประเภท	คำอธิบาย
emails	String	ที่อยู่เดียว หรือหลายที่อยู่คั่นด้วยเครื่องหมายจุลภาค จำเป็นต้องระบุ

คืนค่าเป็น Boolean

การดำเนินการเกี่ยวกับ Tag

Tag คือคุณสมบัติของอุปกรณ์ที่ใช้สร้าง segment ใน Pushwoosh Control Panel

SetTags

ตั้งค่า Tag บนอุปกรณ์

พารามิเตอร์	ประเภท	คำอธิบาย
tagsJson	String	อ็อบเจกต์ JSON เช่น {"Language":"en","Level":7,"Premium":true} จำเป็นต้องระบุ

คืนค่าเป็น Boolean

เครื่องหมายคำพูดในนิพจน์ Mendix

สตริงในนิพจน์ Mendix จะเขียนด้วยเครื่องหมายอัญประกาศเดี่ยว ดังนั้น JSON ที่อยู่ภายในจะยังคงใช้เครื่องหมายอัญประกาศคู่โดยไม่ต้อง escape: '{"Language":"en"}' การเขียน "" หรือ \" ภายในนิพจน์จะสร้างสตริงที่การดำเนินการไม่สามารถแยกวิเคราะห์ได้

GetTags

คืนค่า Tag ที่ตั้งค่าบนอุปกรณ์ในปัจจุบัน เป็นสตริง JSON

คืนค่าเป็น String

การดำเนินการเกี่ยวกับ Event

Event คือสิ่งที่ใช้เริ่มต้นแคมเปญที่ถูกทริกเกอร์และข้อความในแอป

PostEvent

โพสต์ Event ไปยัง Pushwoosh

พารามิเตอร์	ประเภท	คำอธิบาย
eventName	String	ชื่อ Event ตามที่กำหนดค่าใน Control Panel จำเป็นต้องระบุ
attributesJson	String	ไม่บังคับ อ็อบเจกต์ JSON ของแอตทริบิวต์ Event

คืนค่าเป็น Boolean

การเรียก SDK พื้นฐานไม่ได้รายงานความสำเร็จหรือความล้มเหลว ดังนั้นการดำเนินการจะคืนค่าเป็น true ทันทีที่การเรียกถูกส่งไปยัง SDK

การดำเนินการแจ้งเตือนในเครื่อง

การแจ้งเตือนในเครื่องถูกสร้างขึ้นโดยแอปเองและไม่ต้องการเครือข่าย ซึ่งทำให้เหมาะสำหรับการเตือนความจำ

ScheduleLocalNotification

กำหนดเวลาการแจ้งเตือนในเครื่องบนอุปกรณ์

พารามิเตอร์	ประเภท	คำอธิบาย
message	String	ข้อความการแจ้งเตือน จำเป็นต้องระบุ
afterSeconds	Integer/Long	ระยะเวลาที่ต้องรอก่อนที่จะแสดง เป็นวินาที จำเป็นต้องระบุ และต้องเป็นศูนย์หรือมากกว่า
customDataJson	String	ไม่บังคับ อ็อบเจกต์ JSON ที่จะถูกส่งกลับมาพร้อมกับการแจ้งเตือน

คืนค่าเป็น Boolean ทันทีที่การเรียกถูกส่งไปยัง SDK SDK ไม่ได้รายงานกลับมาว่าการแจ้งเตือนถูกกำหนดเวลาจริงหรือไม่

ClearLocalNotifications

ยกเลิกการแจ้งเตือนในเครื่องที่ถูกกำหนดเวลาไว้แต่ยังไม่ทำงาน

คืนค่าเป็น Boolean ทันทีที่การเรียกถูกส่งไปยัง SDK

ClearNotificationCenter

ลบการแจ้งเตือนของแอปที่ส่งแล้วออกจากศูนย์การแจ้งเตือน

คืนค่าเป็น Boolean ทันทีที่การเรียกถูกส่งไปยัง SDK

การดำเนินการเกี่ยวกับความเป็นส่วนตัว

การดำเนินการเหล่านี้สนับสนุนการสลับความยินยอมในแอปของคุณ และเปิดหรือปิดการส่งข้อความ Pushwoosh ทั้งหมดสำหรับอุปกรณ์

IsCommunicationEnabled

บอกว่าอุปกรณ์ได้รับอนุญาตให้รับการสื่อสารจาก Pushwoosh ในปัจจุบันหรือไม่ ใช้เพื่อแสดงสถานะของการสลับความเป็นส่วนตัว

คืนค่าเป็น Boolean

SetCommunicationEnabled

เปิดหรือปิดการสื่อสารกับ Pushwoosh สำหรับอุปกรณ์ การปิดจะหยุดการส่งข้อความทั้งหมด ซึ่งทำให้เป็นการดำเนินการที่ต้องเชื่อมต่อกับการสลับ “อย่าติดต่อฉัน”

พารามิเตอร์	ประเภท	คำอธิบาย
enabled	Boolean	True เพื่ออนุญาตการส่งข้อความ, false เพื่อหยุด จำเป็นต้องระบุ

คืนค่าเป็น Boolean

การดำเนินการตั้งค่า

การดำเนินการเหล่านี้เปลี่ยนพฤติกรรมของ SDK สำหรับอุปกรณ์นี้

SetLanguage

แทนที่ภาษาที่ Pushwoosh ใช้ในการแปลข้อความสำหรับอุปกรณ์ โดยค่าเริ่มต้นจะใช้ภาษาของอุปกรณ์

พารามิเตอร์	ประเภท	คำอธิบาย
language	String	รหัสสองตัวอักษร เช่น en, de, nl จำเป็นต้องระบุ

คืนค่าเป็น Boolean ทันทีที่การเรียกถูกส่งไปยัง SDK

SetReverseProxy

กำหนดเส้นทางการรับส่งข้อมูล Pushwoosh ทั้งหมดผ่าน endpoint ของคุณเอง เรียกใช้ก่อน Initialize มิฉะนั้นคำขอในช่วงแรกจะยังคงส่งตรงไปยัง Pushwoosh

พารามิเตอร์	ประเภท	คำอธิบาย
url	String	URL พื้นฐานของพร็อกซี จำเป็นต้องระบุ
headersJson	String	ไม่บังคับ อ็อบเจกต์ JSON ของส่วนหัว HTTP เพิ่มเติม

คืนค่าเป็น Boolean ทันทีที่การเรียกถูกส่งไปยัง SDK

SetShowForegroundAlert

ควบคุมว่าจะแสดงการแจ้งเตือนที่มาถึงในขณะที่แอปเปิดอยู่เป็นการแจ้งเตือนของระบบหรือไม่ ค่าเริ่มต้นคือเปิด ดังนั้นให้ปิดเพื่อจัดการการแจ้งเตือนในเบื้องหน้าด้วยตัวเองผ่านเหตุการณ์ On push received ของวิดเจ็ต

พารามิเตอร์	ประเภท	คำอธิบาย
showAlert	Boolean	True เพื่อแสดงการแจ้งเตือนของระบบ จำเป็นต้องระบุ

คืนค่าเป็น Boolean ทันทีที่การเรียกถูกส่งไปยัง SDK

สำหรับ iOS เท่านั้น

Android SDK ไม่ได้เปิดเผยการตั้งค่านี้ และการเรียกการดำเนินการบน Android จะทำให้เกิดข้อผิดพลาด เรียกใช้บน iOS เท่านั้น

GetShowForegroundAlert

บอกว่าจะแสดงการแจ้งเตือนที่มาถึงในขณะที่แอปเปิดอยู่เป็นการแจ้งเตือนของระบบหรือไม่ โดยค่าเริ่มต้นจะเปิดอยู่

คืนค่าเป็น Boolean

สำหรับ iOS เท่านั้น

Android SDK ไม่ได้เปิดเผยการตั้งค่านี้ และการเรียกการดำเนินการบน Android จะทำให้เกิดข้อผิดพลาด เรียกใช้บน iOS เท่านั้น

การดำเนินการช่องทางอื่นๆ

การดำเนินการเหล่านี้ลงทะเบียนผู้ใช้สำหรับช่องทางการส่งข้อความที่ Pushwoosh รองรับนอกเหนือจากพุช

RegisterSmsNumber

ลงทะเบียนหมายเลขโทรศัพท์ของผู้ใช้เพื่อให้ Pushwoosh สามารถติดต่อพวกเขาผ่าน SMS ได้

พารามิเตอร์	ประเภท	คำอธิบาย
phoneNumber	String	ในรูปแบบสากล เช่น +31201234567 จำเป็นต้องระบุ

คืนค่าเป็น Boolean ทันทีที่การเรียกถูกส่งไปยัง SDK

RegisterWhatsappNumber

ลงทะเบียนหมายเลขโทรศัพท์ของผู้ใช้เพื่อให้ Pushwoosh สามารถติดต่อพวกเขาผ่าน WhatsApp ได้

พารามิเตอร์	ประเภท	คำอธิบาย
phoneNumber	String	ในรูปแบบสากล เช่น +31201234567 จำเป็นต้องระบุ

คืนค่าเป็น Boolean ทันทีที่การเรียกถูกส่งไปยัง SDK