Pushwoosh Outsystems 플러그인 클라이언트 액션

이 플러그인은 푸시 알림 관리를 용이하게 하는 클라이언트 액션 세트를 제공합니다. 이 액션들을 사용하여 기기를 등록 및 등록 해제하고, 태그를 설정 및 가져오며, 받은 편지함 메시지를 관리하는 등의 작업을 수행할 수 있습니다.

Pushwoosh 플러그인 클라이언트 액션

CheckPushwooshPlugin

Pushwoosh 플러그인이 현재 사용 가능한지 확인합니다.

출력 매개변수

IsAvailable	플러그인을 사용할 수 있으면 true를, 그렇지 않으면 false를 반환합니다.
Error	발생할 수 있는 모든 오류에 대한 세부 정보가 포함된 오류 코드와 오류 메시지를 포함하는 오류입니다. Success 출력 매개변수가 false일 때만 설정됩니다.

사용 예시

RegisterDevice

푸시 알림을 위해 기기를 등록하고 Push Token을 검색합니다.

입력 매개변수

ApplicationCode	텍스트, 계정 설정에서 얻은 Pushwoosh 애플리케이션 코드입니다.

출력 매개변수

RegisterToken	기기에 대해 Google 또는 Apple에서 받은 토큰입니다.
Success	모든 것이 예상대로 진행되면 true를, 오류가 있으면 false를 반환합니다.
Error	발생할 수 있는 모든 오류에 대한 세부 정보가 포함된 오류 코드와 오류 메시지를 포함하는 오류입니다. Success 출력 매개변수가 false일 때만 설정됩니다.

UnregisterDevice

푸시 알림 수신에서 기기를 등록 해제합니다.

출력 매개변수

Success	모든 것이 예상대로 진행되면 true를, 오류가 있으면 false를 반환합니다.
Error	발생할 수 있는 모든 오류에 대한 세부 정보가 포함된 오류 코드와 오류 메시지를 포함하는 오류입니다. Success 출력 매개변수가 false일 때만 설정됩니다.

GetDeviceID

고유 식별자여야 하는 기기 ID를 검색합니다.

출력 매개변수

DeviceHwid	기기의 고유 식별자입니다.
Error	발생할 수 있는 모든 오류에 대한 세부 정보가 포함된 오류 코드와 오류 메시지를 포함하는 오류입니다. 오류가 발생했을 때만 설정됩니다.

GetDeviceType

기기 유형(Android, iOS 또는 Windows)을 가져옵니다.

출력 매개변수

DeviceTypeId	이 기기 유형의 식별자입니다.

GetTags

Pushwoosh에서 태그 데이터를 가져옵니다.

출력 매개변수

Success	모든 것이 예상대로 진행되면 true를, 오류가 있으면 false를 반환합니다.
Error	발생할 수 있는 모든 오류에 대한 세부 정보가 포함된 오류 코드와 오류 메시지를 포함하는 오류입니다. Success 출력 매개변수가 false일 때만 설정됩니다.
Tags	이 기기에 할당된 모든 태그를 포함하는 Key, Value 레코드 목록을 반환합니다.

사용 예시

GetTags 액션을 호출하여 Pushwoosh에서 태그 데이터를 가져옵니다.
반환된 태그는 GetTags.Tags 목록을 통해 접근할 수 있습니다.

LogMessage 액션을 사용하여 각 태그의 키와 값을 기록합니다.

PostEvent

애플리케이션에서 특정 이벤트가 발생했을 때 Pushwoosh로 메시지를 보냅니다.

입력 매개변수

EventName	텍스트, 이벤트의 이름
EventAttributes	Key, Value 레코드 목록, 추가 이벤트 데이터를 Pushwoosh로 보내는 데 사용됩니다 (예: “UserLogin” 액션의 경우 `{"username":"John"}`와 같은 로그인 데이터를 보낼 수 있습니다).

출력 매개변수

Success	모든 것이 예상대로 진행되면 true를, 오류가 있으면 false를 반환합니다.
Error	발생할 수 있는 모든 오류에 대한 세부 정보가 포함된 오류 코드와 오류 메시지를 포함하는 오류입니다. Success 출력 매개변수가 false일 때만 설정됩니다.

사용 예시

1. 할당

이벤트 데이터를 정의하기 위해 키-값 쌍을 설정합니다. 예를 들어, KeyValue1.AttributeName을 “test1”로, KeyValue1.Value를 “test1value”로 설정합니다. 마찬가지로, 적절한 속성 이름과 값으로 KeyValue2를 정의합니다.

이벤트와 연관될 속성 목록을 생성합니다.

마지막으로, PostEvent 액션을 구성합니다.

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일 때만 설정됩니다.

사용 예시

태그 값을 할당합니다. 아래 예시에는 두 개의 태그가 있습니다:

이름이 testTag이고 값이 현재 날짜로 설정된 Tag1.
이름이 testTag2이고 값이 True로 설정된 Tag2.

그런 다음, 태그를 목록에 추가합니다. 이 예시에서는:

ListAppend3은 Tag1을 LocalTag 목록에 추가합니다.
ListAppend4는 Tag2를 LocalTag 목록에 추가합니다.

필요한 태그로 목록을 채운 후, SetTags 클라이언트 액션을 사용하여 이 목록을 Pushwoosh로 보냅니다.

SetUserId

이 기기에 사용자 정의 User ID를 할당합니다.

입력 매개변수

UserID	텍스트, 사용자 정의 User ID입니다.

출력 매개변수

Success	모든 것이 예상대로 진행되면 true를, 오류가 있으면 false를 반환합니다.
Error	발생할 수 있는 모든 오류에 대한 세부 정보가 포함된 오류 코드와 오류 메시지를 포함하는 오류입니다. Success 출력 매개변수가 false일 때만 설정됩니다.

SetApiToken

SDK에서 사용하는 Pushwoosh Device API 토큰을 설정합니다. RegisterDevice 전에 호출하십시오. 토큰은 PW_API_TOKEN 환경설정을 사용하여 빌드 시에도 설정할 수 있습니다 — 통합 가이드를 참조하십시오.

입력 매개변수

Token	텍스트, Pushwoosh Control Panel(API Access 섹션)의 Device API 토큰입니다.

EnableHuaweiPushNotifications

푸시 전송을 Huawei Push Kit (HMS)로 전환합니다. Huawei 기기에서 RegisterDevice 전에 호출하십시오. Huawei 구성이 필요합니다 — Outsystems용 Huawei를 참조하십시오.

이 액션은 출력 매개변수가 없으며 성공 또는 실패를 보고하지 않습니다. 기기가 실제로 어떤 전송으로 등록되었는지 확인하려면 GetDiagnostics를 사용하십시오.

SetMultiNotificationMode

Pushwoosh Plugin 컴포넌트 버전 4.7.0부터 사용 가능. Android 전용 — 이전 알림을 대체하는 대신 모든 푸시가 별도의 알림으로 표시되도록 합니다. 초기화 후 한 번 호출하십시오 — 예를 들어, OnInitializeOver 이벤트 핸들러에서 RegisterDevice 이후에 호출합니다. 이 설정은 SDK에 의해 저장되며 앱 재시작 후에도 유지됩니다. Android는 알림을 하나의 확장 가능한 스택으로 그룹화합니다 — 이는 표준 시스템 동작입니다. iOS 구현은 없습니다 (iOS는 알림을 대체하지 않음) — iOS에서도 실행되는 플로우에 넣기보다는 GetDeviceType으로 호출을 보호하십시오.

GetDiagnostics

Pushwoosh Plugin 컴포넌트 버전 4.7.0부터 사용 가능. 통합 상태를 JSON 문자열로 반환합니다: 유효하고 내장된 Application Code와 그 출처, API 토큰 존재 여부, HWID, 푸시 토큰, 알림 권한 상태, 플러그인 및 네이티브 SDK 버전. Android에서는 추가로 User ID와 FCM/HMS 메시징 이벤트를 위해 등록된 서비스 목록을 포함합니다 (이 두 필드는 iOS에는 없음). 기기 로그를 수집하는 대신 지원 티켓에 이 출력을 첨부하십시오.

출력 매개변수

DiagnosticsJSON	텍스트, 통합 상태를 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 받은 편지함 클라이언트 액션

받은 편지함 작업 과정은 다음과 같습니다:

InboxMessage 객체 목록을 로드합니다.
이 객체들을 사용하여 받은 편지함 뷰를 렌더링합니다.
아래 나열된 액션을 수행하거나, 아래 설명된 액션을 사용하여 이 객체들을 삭제합니다.

code	텍스트	받은 편지함 알림의 고유 ID입니다.
title	텍스트	알림 제목입니다.
message	텍스트	알림 메시지입니다.
imageUrl	텍스트	알림에 첨부된 사용자 정의 이미지의 URL입니다.
sendDate	날짜 시간	알림이 전송된 시간을 나타냅니다.
type	정수	알림 유형입니다. 가능한 값: 0 - 일반 알림 1 - 리치 미디어 알림 2 - URL 알림 3 - 딥 링크 알림
bannerUrl	텍스트	Android 배너의 URL을 포함합니다.
customData	Key, Value 레코드 목록	사용자 정의 데이터로 전달된 매개변수 목록을 포함합니다.
isRead	불리언	받은 편지함 알림이 읽혔으면 True입니다.
isActionPerformed	불리언	알림 액션이 수행되면 True입니다. 일반 알림의 경우, 알림을 읽으면 true입니다. 리치 미디어의 경우, 리치 미디어가 표시되면 true입니다. URL 및 딥 링크의 경우, URL/딥 링크가 열리면 true입니다.

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일 때만 설정됩니다.