PWEngagement SDK for iOS

This is Phunware's Mobile Engagement SDK for use with its Multiscreen-as-a-Service platform. It provides location and notification-based capabilities. Visit https://maas.phunware.com for more details and to sign up.

Requirements

• PWCore 3.11.x
• iOS 13.0 or greater
• Xcode 12 or greater

Installation

CocoaPods

It is required to use CocoaPods 1.10 or greater to integrate the framework. Simply add the following to your Podfile:

pod 'PWEngagement'

To enable support for Mist virtual beacons, add the MistBeaconProvider subspec:

pod 'PWEngagement/MistBeaconProvider'

Documentation

Framework documentation is included in the the repository's Documents folder in both HTML and Docset formats.

• API Reference
• Documentation can be found at developer.phunware.com

Important Note: To align with best practices, PWEngagement no longer prompts for notification nor location permissions, leaving control to the app developer. For PWEngagement to fully function as designed, both permissions must be granted.

• Notification permission: We recommend following Apple's best practices. If permission is not granted the app will not receive push notifications.

• Location permission: To perform optimally, PWEngagement needs the user to “Always Allow” location in order to properly search for Geofences activity in the background. We recommend following Apple's best practices when asking for this permission. If “Only when in use” or “Don’t allow” is chosen, the app will not monitor for regions in the background. Therefore it will not receive geofence notifications or range on beacons in the background.

  • PWEngagement supports "Only when in use" for limited functionality as of PWEngagement 3.6.0. When the application is in the foreground with "Only when in use" permission, PWEngagement will deliver geofence and beacon campaigns as intended.

• Background modes: PWEngagement requires several different background capabilities, which may be enabled by navigating to your project's target's settings under Capabilities then Background Modes.

  • Location Updates: Required for region monitoring in background.
  • Uses Bluetooth LE accessories: Required to receive beacon campaigns.
  • Background fetch: Required to react to background location updates appropriately.
  • Remote notifications: Required to receive APNs notifications in background.

Steps to run the sample app

1. Create a new iOS Engagement application in MaaS portal.

2. Go to the directory of sample app and do a pod install.

3. Add the following key/value pairs to Info.plist:

• MaaSAppId: The application ID from MaaS Portal.
• MaaSAccessKey: The access key from MaaS Portal.

4. Configure your app for push notifications.

   • Go to developer.apple.com and create a push notification certificate (tutorial link).

   • Once it's created, download the push production certificate and add it to Keychain Access. Then, from Keychain Access, export both the certificate and key. (Right click to view the Export option) as a .p12 and set a password.

   • Now, log on to the MaaS Portal, navigate to the app created for your application and update the following.

     • Certificate (.p12): Click the grey ellipses button to upload the Production Push Certificate you created on developer.apple.com.
     • Password: The password you setup for the push certificate.
     • Environment: Use Production environment for production apps.

Attribution

PWEngagement uses the following third-party dependencies:

Privacy

You understand and consent to Phunware’s Privacy Policy located at www.phunware.com/privacy. If your use of Phunware’s software requires a Privacy Policy of your own, you also agree to include the terms of Phunware’s Privacy Policy in your Privacy Policy to your end users.

Terms

Use of this software requires review and acceptance of our terms and conditions for developer use located at http://www.phunware.com/terms