PostalPortal/PostalPoint_Plugins
PostalPortal/PostalPoint_Plugins
2
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

Compare commits

base: PostalPortal:b6f3607dc714f59744fa7dc622dfccd9a8f272c8
Branches Tags
PostalPortal:master
PostalPortal:public
...
compare: PostalPortal:718b24e6be61760e9f23e85ec5593427b8210583
Branches Tags
PostalPortal:public
PostalPortal:master

2 Commits
b6f3607dc7 ... 718b24e6be

Author SHA1 Message Date
Skylar Ittner
718b24e6be Update events list 2026-01-14 22:51:45 -07:00
Skylar Ittner
bc98bc9e1d Add note about testing builds 2026-01-14 22:49:44 -07:00
2 changed files with 6 additions and 0 deletions
Show Stats Expand all files Collapse all files

4
README.md
View File

@ -73,6 +73,10 @@ The PostalPoint plugin API is a globally-available object named `global.apis`.
### API List ### API List
Note: API functions shown here are available in the
[latest testing build](https://build.netsyms.net/job/PostalPoint_Retail/),
but may not yet be present in the most recent release.
#### Core #### Core
`global.apis.`: `global.apis.`:

2
docs/Events.md
View File

@ -11,6 +11,8 @@ Plugins can use `global.apis.eventbus` to receive events when certain actions ha
* `transactionFinished`: Contains a receipt object of a transaction that was just finalized. * `transactionFinished`: Contains a receipt object of a transaction that was just finalized.
* `receiveFromCustomerScreen`: Contains the event sent from the customer-facing display's custom HTML interface via `window.parent.postMessage` * `receiveFromCustomerScreen`: Contains the event sent from the customer-facing display's custom HTML interface via `window.parent.postMessage`
* `customerSignatureCollected`: Contains a signature image from the customer-facing display, in the structure `{"svg": "data:image/svg+xml;base64,...", "png": "data:image/png;base64,..."}`. * `customerSignatureCollected`: Contains a signature image from the customer-facing display, in the structure `{"svg": "data:image/svg+xml;base64,...", "png": "data:image/png;base64,..."}`.
* `settingsSaved`: Emitted when PostalPoint's settings are saved. Usually this means the user changed a setting in the UI.
* `pluginSettingsSaved`: Emitted when the user saves a plugin's settings. The plugin ID is sent as the event data.
## Example Code ## Example Code