ข้ามไปยังเนื้อหา
คู่มือผู้ใช้การสนับสนุน ขอสาธิต เข้าสู่ระบบ
Pushwoosh.com

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

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

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

Anchor link to

CheckPushwooshPlugin

Anchor link to

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

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

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

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

Anchor link to
การดำเนินการ CheckPushwooshPlugin

RegisterDevice

Anchor link to

ลงทะเบียนอุปกรณ์สำหรับการแจ้งเตือนแบบพุชและดึงข้อมูล Push Token

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

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

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

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

UnregisterDevice

Anchor link to

ยกเลิกการลงทะเบียนอุปกรณ์จากการรับการแจ้งเตือนแบบพุช

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

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

GetDeviceID

Anchor link to

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

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

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

GetDeviceType

Anchor link to

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

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

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

GetTags

Anchor link to

ดึงข้อมูลแท็กจาก Pushwoosh

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

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

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

Anchor link to
  1. เรียกใช้การดำเนินการ GetTags เพื่อดึงข้อมูลแท็กจาก Pushwoosh
  2. แท็กที่ส่งคืนมาสามารถเข้าถึงได้ผ่านรายการ GetTags.Tags
  1. ใช้การดำเนินการ LogMessage เพื่อบันทึกคีย์และค่าของแต่ละแท็ก

PostEvent

Anchor link to

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

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

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

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

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

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

Anchor link to

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

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

2. สร้างรายการแอตทริบิวต์ที่จะเชื่อมโยงกับเหตุการณ์

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

SetBadgeNumber

Anchor link to

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

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

Anchor link to
BadgeNumberInteger, หมายเลขบนป้ายไอคอน

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

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

SetLanguage

Anchor link to

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

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

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

SetTags

Anchor link to

ส่งแท็กและค่าของแท็กไปยัง Pushwoosh

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

Anchor link to
TagsTagName, TagValue Record List ที่มีแท็กทั้งหมดที่คุณต้องการส่ง ประเภทของ TagName ควรเป็น Text เสมอ ในขณะที่ TagValue สามารถเป็น Text, Integer, Boolean, Date และอื่นๆ

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

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

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

Anchor link to
  1. กำหนดค่าแท็ก ในตัวอย่างด้านล่าง มีสองแท็ก:
  • Tag1 ที่มีชื่อ testTag และค่าของมันถูกตั้งค่าเป็นวันที่ปัจจุบัน
  • Tag2 ที่มีชื่อ testTag2 และค่าของมันถูกตั้งค่าเป็น True

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

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

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

SetUserId

Anchor link to

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

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

Anchor link to
UserIDText, User ID แบบกำหนดเอง

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

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

การดำเนินการฝั่งไคลเอ็นต์ของ Pushwoosh Inbox

Anchor link to

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

  1. โหลดรายการของอ็อบเจ็กต์ InboxMessage
  2. ใช้อ็อบเจ็กต์เหล่านี้เพื่อแสดงผลมุมมองกล่องข้อความ
  3. ดำเนินการตามที่ระบุไว้ด้านล่าง หรือลบอ็อบเจ็กต์เหล่านี้โดยใช้การดำเนินการที่อธิบายไว้ด้านล่าง
codeTextID ที่ไม่ซ้ำกันของการแจ้งเตือนในกล่องข้อความ
titleTextชื่อหัวข้อการแจ้งเตือน
messageTextข้อความการแจ้งเตือน
imageUrlTextURL ของรูปภาพแบบกำหนดเองที่แนบมากับการแจ้งเตือน
sendDate

Date

Time

แสดงเวลาที่ส่งการแจ้งเตือน
typeInteger

ประเภทของการแจ้งเตือน

ค่าที่เป็นไปได้:

  • 0 - การแจ้งเตือนปกติ
  • 1 - การแจ้งเตือนแบบ Rich Media
  • 2 - การแจ้งเตือนแบบ URL
  • 3 - การแจ้งเตือนแบบ Deep Link
bannerUrlTextมี URL ของแบนเนอร์ Android
customDataKey, Value Record Listมีรายการพารามิเตอร์ที่ส่งเป็นข้อมูลแบบกำหนดเอง
isReadBooleanTrue หากการแจ้งเตือนในกล่องข้อความถูกอ่านแล้ว
isActionPerformedBoolean
  • True หากการดำเนินการแจ้งเตือนถูกกระทำแล้ว
  • สำหรับการแจ้งเตือนทั่วไป true หากการแจ้งเตือนถูกอ่านแล้ว
  • สำหรับ Rich Media true หาก rich media ถูกนำเสนอแล้ว
  • สำหรับ URL และ deep links true หาก URL/deep link ถูกเปิดแล้ว

LoadMessages

Anchor link to

ดึงข้อมูลการแจ้งเตือนในกล่องข้อความจาก Pushwoosh

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

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

ReadMessage

Anchor link to

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

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

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

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

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

PerformAction

Anchor link to

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

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

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

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

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

DeleteMessage

Anchor link to

ลบข้อความออกจากกล่องข้อความ

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

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

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

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

TotalMessagesCount

Anchor link to

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

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

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

UnreadMessagesCount

Anchor link to

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

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

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

MessagesWithNoActionPerformedCount

Anchor link to

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

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

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