Skip to content

Cozy Device Helper

NPM Licence shield npm npm

This library allows to know more information about the device platform

API

Platforms

import { getPlatform, isWebApp, isMobileApp, isIOSApp, isAndroidApp, isFlagshipApp } from 'cozy-device-helper'

To know the platform:

  • isFlagshipApp(): return boolean if inside the flagship app.
  • getPlatform(): return ios, android or web
  • isWebApp(): return boolean
  • isMobileApp(): return boolean. True if its a cordova App. False for others.
  • isIOSApp(): return boolean. True if its a cordova App on iOS.
  • isAndroidApp(): return boolean. True if its a cordova App on Android.
  • isAndroid(): return boolean (check if the user is on an android smartphone (native & browser))
  • isOS(): return boolean (check if the user is on an iOS smartphone (native & browser))
  • isMobile(): return boolean (check if the user is on an android or iOS smartphone (native & browser))

Device Name

import { getDeviceName } from 'cozy-device-helper'

To know device name getDeviceName().

Cordova Plugins

import { hasDevicePlugin, hasInAppBrowserPlugin, hasSafariPlugin, checkApp, startApp } from 'cozy-device-helper'
  • hasDevicePlugin: return boolean
  • hasInAppBrowserPlugin: return boolean
  • hasSafariPlugin: return a promise which resolve by a boolean
  • checkApp: return a promise that resolves with informations about the application (if installed) or false (if not installed)
  • startApp: Start an Application. Return a promise - False if the application was not able to be started