LogoLogo
What's NewDeveloper CommunitySupportStatus
  • 🚀Get Started
    • What is JourneyApps Platform?
    • Tutorial: Build your First App
      • 1. Introduction
      • 2. Create a new App
      • 3. OXIDE IDE Overview
      • 4. Hello World app
      • 5. The Data Model
      • 6. View Components
      • 7. Queries and Data Sync
      • 8. Simple Navigation
      • 9. View Stack
      • 10. Input Validation
      • 11. View Parameters
      • 12. Data Manipulation
      • 13. Responsive Apps
      • 14. Styling
      • 15. Lists
      • 16. GPS Capturing
      • 17. Relationships
      • 18. Multiple User Roles
      • 19. Deployment and Users
      • 20. Version Control
      • 21. CSV and APIs
      • 22. Conclusion
    • JourneyApps Platform Fundamentals
      • Creating a New App
        • Git-enabled Apps
      • What are Views?
      • What is the Data Model?
      • JourneyApps Syntax Basics
      • Access the Database (DB)
        • Manipulate DB Objects
        • Query DB Objects
      • View Navigation
        • Deep Linking
      • CloudCode Overview
      • OXIDE (Online IDE)
  • 💻Build your App
    • JourneyApps Syntax
      • Syntax Basics
      • Access the DB
      • View Navigation
      • Async & Await
      • TypeScript Apps (Beta)
        • runtime-build package
        • TypeScript App Troubleshooting
      • What's New in V4
        • Updating to the V4 API
    • Configure your Data Model
      • What is the data model?
      • Reference: model
        • field
        • belongs-to
        • has-many
        • index
      • Data Rules
        • Data Buckets
        • Sync Rules - Limit data synced to devices
        • Data ACLs - Limit access to data
        • Real-world example for Data Rules
        • ❔FAQs
        • Migrate to Data Rules
      • App Indexes
      • Webhooks
    • UI Components
      • All UI Components
        • actionSheet
        • Attachments
        • button
        • button-group
        • capture-coordinates
          • marker
          • marker-query
        • capture-file
        • capture-photo
        • capture-signature
        • card
          • accent
          • action
        • columns
          • column
        • component
        • context-menu
          • divider
          • item
        • CSV
        • date-input
        • datetime-input
        • dialog
          • body
        • display-3d-model
          • 📖display-3d-model Guides
            • Guide 1: Initialize and layout a 3D model in a view
            • Guide 2: Control playback position
            • Guide 3: Troubleshooting controls
        • display-coordinates
        • display-file
        • display-image
        • display-photo
        • display-signature
        • heading
        • html
          • HTML Advanced Topics
          • ❔HTML FAQs
          • 📖Guide: HTML & JourneyApps iFrame Client
        • icons
        • info
        • info-table
          • row
        • journey.photos (capture multiple photos)
        • JourneyPrinter (print PDFs)
        • grid
          • cell
          • 📖grid Examples
        • list
          • list-item
            • accent
            • asset
            • pills
              • pill
            • action
        • multiple-choice-checklist
        • navigation (Navigation drawer)
          • general-section
            • item
          • section
            • item
              • item
          • ❔navigation FAQs
        • notification
        • object-dropdown
        • object-list
          • action
        • object-repeat
        • object-table
          • action
          • column
            • action
            • edit-boolean
            • edit-date
            • edit-datetime
            • edit-integer
            • edit-number
            • edit-select
            • edit-text
            • edit-time
            • edit-typeahead
              • action
            • header-action
          • column-group
          • empty-action
          • 📖object-table Guides
            • Actions
            • Cell callouts
            • Column groups
            • Columns
            • Controlled object-table
            • Controls
            • Copy & paste data
            • Edit cells
            • Filters
            • Frozen columns
            • Fullscreen object-table
            • Mode
            • State
            • Styles
        • optionList
        • PhotonSync (transfer data offline)
        • power-bi
          • 📖Guide: PowerBI Embedding
        • scan-barcode
        • shortcut
        • sidebar
        • single-choice-dropdown
        • single-choice-radio
        • template
        • text-input
        • time-input
        • toggle
        • view
      • JS/TS Events
      • Show / Hide UI Components
      • View Templates
      • XML Fields (Attributes)
        • align-content
        • align-controls
        • align-label
        • bind
        • clear-button-visibility
        • control-order
        • disabled
        • error-message
        • icon-position
        • id
        • hide-if
        • modifier-text
        • label
        • label-case
        • label-color
        • on-change
        • on-press
        • placeholder
        • required
        • show-if
    • JS / TS APIs
      • Attachment
      • Bluetooth (Beta)
      • Broadcast
      • component
      • CSV
      • DB
      • HardwareBarcode
      • journey
        • journey.config
        • journey.container
        • journey.device
        • journey.diagnostics
        • journey.dialog
        • journey.files
        • journey.hardware
        • journey.photos
        • journey.runtime
        • journey.sensors
        • journey.viewStack
      • JourneyPrinter
      • KeyboardBarcode
      • LocalDB
      • NFC
      • OnlineDB
      • PhotonSync
      • SerialPort
      • ShortcutManager
      • TCPSocket
      • user
    • Extend your App with Custom Code
      • App packages
        • App packages overview
        • PDF report package
        • TypeScript library & unit tests
        • Manage External Dependencies
      • Custom HTML
    • Style & Customize your App
      • Style & configure UI components
        • Overview
        • Understand extendable themes
        • Use themes on a view
        • Theme specific components on a view
        • Examples
        • Debugging
        • ❔FAQs
      • Change your App Font
      • Custom Branding
        • Custom Container Features
        • Special Requirements for iOS Containers
    • Integrate your App
      • Backend integrations with CloudCode
      • Barcode Scanning
        • Barcode Scanning using Keyboard Emulation
        • Hardware Barcode Scanning
        • scan-barcode
      • Bluetooth Low Energy (BLE)
      • Broadcast API
      • HTTP requests (Fetch API)
      • JourneyApps Print (Android)
      • Maps and navigation
      • NFC
      • Opening external links/apps
      • Serial Port
      • TCP Sockets
    • Design Intuitive Apps
      • UX Guidelines
      • Write Effective Copy
  • 📱App Features
    • RealWear® Voice Control
      • Automatic Voice Commands
        • Automatic Voice Commands - Advanced
      • Manual Voice Commands
    • App, Runtime and Container Updates
    • Batch Operations (App)
    • Call JS/TS Functions from XML
    • Capture GPS Locations
    • Push Notifications
    • Translations
    • XML Format Strings
    • Webhooks (External)
  • 🌐CloudCode
    • CloudCode Overview
    • Trigger a CloudCode Task
      • Trigger CC with a Schedule
      • Trigger CC via a Webhook
      • Trigger CC from an App
      • Trigger CC from Another Task
      • Trigger CC via HTTP
    • Attachments in CloudCode
    • Timezones
    • Advanced CloudCode Topics
      • Access Multiple DBs in CloudCode Tasks
      • Batch API (CloudCode)
      • CloudCode Dependencies
      • Configure HTTPS in CloudCode
      • Deployment environment variables
      • Local CloudCode Development
      • PDF Reports using CloudCode
      • Shared CloudCode Tasks
      • Translations in CloudCode
  • 📥Backend API
    • Introduction
    • API Reference
      • Retrieve All Objects
      • Query Objects
      • Sort Results
      • Limit and Skip
      • Count Objects
      • Create a New Object
      • Retrieve a Single Object
      • Update a Single Object
      • Delete a Single Object
      • Batch Operations (v4 API)
      • Oplog API
      • Retrieve the App Data Model
      • Manage App Users and Sessions
      • Field Representation
      • Error Responses
    • API Limits
    • Update to the V4 API
  • ⚙️Technical
    • Data Synchronization Priority
    • Device Diagnostics
    • JSON1 Query Engine
    • Improve App Performance
    • Security Measures
    • Supported Platforms
      • Web Container
      • Windows Installer
    • Domain Whitelist
  • 🖥️OXIDE
    • Get started with OXIDE
      • OXIDE Overview
      • Components of OXIDE
    • Configure Testing Deployments
    • Edit and Manage Files
      • How to Navigate to a Function
      • Manage External Dependencies
    • Create and Manage App Containers
    • Debugging & Troubleshooting
      • Common Troubleshooting Pointers
      • App Diagnostics Reports
      • Build Logs
    • OXIDE Workspaces
      • OXIDE Trees
  • ❕Deprecated Features
    • Deprecated Features and Components
Powered by GitBook
On this page
  • Introduction
  • Configuration
  • Example 1: Job Assignment Notification
  • Example 2: General Message Notification
  • Example 3: Badge Count
  • Push Notification Behavior
  1. App Features

Push Notifications

PreviousCapture GPS LocationsNextTranslations

Last updated 2 years ago

Introduction

JourneyApps supports sending push notifications addressed to specific users of a JourneyApps application. This is particularly useful for notifying users of certain events, such as when a job is assigned to them.

The recipient of the push notification is determined by a "belongs to user" relationship on the object.

Configuration

Push notifications are configured in the Data Model of your app, in OXIDE.

To configure push notifications to be sent when a specific type of object is created, add a <notify-user message="" received-field="" recipient-field=""/> element at the end of a <model/> definition.

The configuration options in the <notify-user/> tag are as follows:

Configuration Option
Description

message=""

received-field=""

recipient-field=""

badge-count-field=""

Badge Count Support

If the default messages behavior is used with the badge count feature, then the number on the app badge will not be an accurate reflection of unread messages because the state is tracked on-device.

This feature is only supported on iOS -- the property has no effect on other platforms.

Example 1: Job Assignment Notification

In the example below, we send a push notification to a user whenever a job_card object is created. Each job card belongs to the user to which it is assigned, so we notify the assigned user that they have received a new job card.

schema.xml
<model name="job_card" label="Job Card">
    <field name="job_number" label="Job Number" type="text:number" />
    <!-- ...snipped... -->
    <field name="customer_name" label="Customer Name" type="text" />
    <!-- ...snipped... -->
    <field name="received_at" label="Received At" type="datetime" />

    <belongs-to model="user" />
    <!-- ...snipped... -->

    <display>[{status}] {job_number} - {customer_name}</display>

    <notify-user message="A new job (#{job_number}) has been assigned to you: {customer_name}" received-field="received_at" recipient-field="user"/>
</model>

Example 2: General Message Notification

A more flexible way to use push notifications is to create a dedicated model for the notifications. In this way, any message can be sent to any user simply by creating such a "notification" object. You could also send the same message to multiple users by looping through your users and creating a "notification" object for each user.

schema.xml
<model name="notification" label="Notification">
    <field name="message" label="Message" type="text" />
    <field name="received_at" label="Received At" type="datetime" />
    <belongs-to model="user" />
    <display>{message}</display>

    <notify-user message="{message}" received-field="received_at" recipient-field="user"/>
</model>

Note that you can choose any name for the "notification" model. It does not have to be called notification — the <notify-user/> element is the only aspect of the above example that determines that the object will trigger push notifications.

Example 3: Badge Count

schema.xml
<model name="notification" label="Notification">
    <field name="message" label="Message" type="text" />
    <field name="received_at" label="Received At" type="datetime" />
    <field name="badge_count" label="Badge Count" type="integer" />
    <belongs-to model="user" />
    <display>{message}</display>

    <notify-user message="{message}" received-field="received_at" recipient-field="user" badge-count-field="badge_count"/>
</model>

A push notification will be sent when a notification object is created. The app badge count on iOS will be equal to the value of the badge_count field on the object.

Push Notification Behavior

If the user taps on a Push Notification, the JourneyApps Container will be opened, and a data sync will be triggered automatically.

Limitations & Cautions

Please be aware of the limitations to Push Notification inherent to Android, iOS and Desktop.

The Apple Push Notification Service (Apple's service used on iOS) and Google Cloud Messaging (Google's push notification service used on Android) do not guarantee delivery of push notifications, and there may be delays in the delivery of notifications due to external factors, including network connectivity.

Push notifications can be configured for a specific model in your , and a notification is created whenever an object of that type is created in any way on JourneyApps (e.g. from the mobile device, on the JourneyApps App Backend, or via the )

The message that will be displayed to the user in the push notification. It is an , so field values from the object can be dynamically interpolated into the message (see below).

The name of a where JourneyApps will automatically store a timestamp indicating when the push notification message was received.

The name of a relationship on the same object that indicates who the recipient of the push notification should be. The model of the relationship must be the mobile user type ( by default).

[Optional] The name of an where JourneyApps will pull the badge count from when sending push notifications on iOS. This allows the developer to keep track of the unread message count to display on the app badge.

Setting a custom badge count value by using the badge-count-field option is intended to be used in conjunction with custom messages and the notifications indicator functionality described in the .

If the app was running in the background, it will be opened on the same where it was open before. If the app was not running, it will be opened on the main view.

📱
Data Model
JourneyApps API
Navigation component documentation
view
belongs to
user
XML Format String
Example 1
datetime field
integer field