Permalink
Fetching contributors…
Cannot retrieve contributors at this time
100 lines (72 sloc) 3.38 KB
license title
Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Device

Device

The device object describes the device's hardware and software.

Properties

Variable Scope

Since device is assigned to the window object, it is implicitly in the global scope.

// These reference the same `device`
var phoneName = window.device.name;
var phoneName = device.name;

Accessing the Feature

As of version 3.0, Cordova implements device-level APIs as plugins. Use the CLI's plugin command, described in The Command-line Interface, to add or remove this feature for a project:

    $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-device.git
    $ cordova plugin rm org.apache.cordova.core.device

These commands apply to all targeted platforms, but modify the platform-specific configuration settings described below:

  • Android

      (in app/res/xml/config.xml)
      <feature name="Device">
          <param name="android-package" value="org.apache.cordova.Device" />
      </feature>
    
      (in app/AndroidManifest.xml)
      <uses-permission android:name="android.permission.READ_PHONE_STATE" />
    
  • BlackBerry WebWorks

      (in www/plugins.xml)
      <feature name="Device">
          <param name="blackberry-package" value="org.apache.cordova.device.Device" />
      </feature>
    
      (in www/config.xml)
      <feature id="blackberry.app" required="true" version="1.0.0.0" />
      <rim:permissions>
          <rim:permit>read_device_identifying_information</rim:permit>
      </rim:permissions>
    
  • Windows Phone (in Properties/WPAppManifest.xml)

      <Capabilities>
          <Capability Name="ID_CAP_WEBBROWSERCOMPONENT" />
          <Capability Name="ID_CAP_IDENTITY_DEVICE" />
          <Capability Name="ID_CAP_IDENTITY_USER" />
      </Capabilities>
    

    Reference: Application Manifest for Windows Phone

  • Tizen (in config.xml)

      <feature name="http://tizen.org/api/systeminfo" required="true"/>
    

    Reference: Application Manifest for Tizen Web Application

Some platforms may support this feature without requiring any special configuration. See Platform Support for an overview.