Wondering what’s next for npm?Check out our public roadmap! »

cordova-privacyscreen-plugin

0.5.0 • Public • Published

PrivacyScreenPlugin

Both iOS (as of iOS 7) and Android have app switchers that display a screenshot of your app.

This is a lovely feature for most apps, but if your app displays sensitive information this is a possible privacy risk.

This plugin flags your app so that it doesn't show your users' sensitive data in the task switcher. It sets the FLAG_SECURE flag in Android (which also prevents manual screenshots from being taken) and hides the window in iOS.

On iOS this plugin will try to show your splashscreen in the app switcher. It will search for splashscreens prefixed by Default or the value of the key UILaunchImageFile in your .plist file. If it fails to find a splashscreen for a specific device or orientation (portrait or landscape), a black screen is shown instead.

Installation

For Cordova 3.x.x:

  1. To add this plugin just type: cordova plugin add cordova-plugin-privacyscreen or phonegap local plugin add cordova-plugin-privacyscreen
  2. To remove this plugin type: cordova plugin remove cordova-plugin-privacyscreen or phonegap local plugin remove cordova-plugin-privacyscreen

Usage:

This plugin exposes no interface in Android, it simply sets your app to be private. You don't need to do anything except install the plugin.

In iOS the privacy screen fades on page load or in a set time interval, if you want more control you have the following functions:

  • setTimer(successCallback, errorCallback, timeInterval) : sets timer to make privacy screen fade away (default is 3 seconds and can be set through preference).
  • hidePrivacyScreen(successCallback, errorCallback) : Explicitely hides the privacy screen.
  • showPrivacyScreen(successCallback, errorCallback) : Explicitely shows the privacy screen (respects timer interval to fade)

For iOS there are 3 preferences that can be set in config.xml:

  • "PrivacyOnBackground": If set to "true" allows splashscreen to be shown only when app enters background (i.e. switched to another app or pressed the home button)
  • "PrivacyOverrideLaunchImage": If set to "true" allows privacy screen to be the Default image even if LaunchImage is set in the info-plist
  • "PrivacyImageName": String for image name, images should be in the app bundle and follow the size naming convention (i.e. for app name "Test", there should be a "Test-667h.png" in the bundle for iPhone 6)
  • "PrivacyTimer": accepts a value in seconds for the privacy screen timer

When using splash storyboard add images to the config xml. (i.e )

Test this plugin on a real device because the iOS simulator (7.1 at least) does a poor job hiding your app.

License

The MIT License

Copyright (c) 2016 Tommy-Carlos Williams (http://github.com/devgeeks)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Install

npm i cordova-privacyscreen-plugin

DownloadsWeekly Downloads

2

Version

0.5.0

License

MIT

Unpacked Size

54.1 kB

Total Files

14

Last publish

Collaborators

  • avatar