Type Function Library system.* Return value various Revision 2017.3060 Keywords system info
Returns information about the system on which the application is running.
system.getInfo( property )
String. The name of the property corresponding to the desired information — see the reference lists below.
"appName"
returns the application's name that is displayed to the end user.
"appVersionString"
returns the application's version as a string.
"architectureInfo"
returns a string describing the underlying CPU architecture of the device you are running on. This API is mostly for internal debugging but may have uses. Strings may be subject to changes in the future depending on the changing landscape of devices and CPUs.
ARM
ARM Neon
(ARMv7)iPhone6,1
or iPad5,3
.i386
, x86_64
, ppc
, or ppc64
(currently only i386
is available).x86
, x64
, IA64
, or ARM
."build"
returns the Corona build string as it appears in the About box of the Corona Simulator.
"deviceID"
returns a "unique" ID for the device, with the following caveats:
On iOS, returns a MD5 hash of the device's "identifierForVendor"
.
On Android, if your app uses the "android.permission.READ_PHONE_STATE"
permission, this will return IMEI
for GSM phones, MEID
or ESN
for CDMA phones, or the operating system's unique ID for devices that are not phones. If your Android app does not use the "android.permission.READ_PHONE_STATE"
permission, the operating system's unique ID will be returned for all devices. Note that the operating system's unique ID may change after
On Android devices running Android 6 and higher, if your app uses the READ_PHONE_STATE
permission and your device is a phone, it's possible for the user to change the value returned from system.getInfo( "deviceID" )
PHONE
permission. The first value that's retrieved from system.getInfo( "deviceID" )
PHONE
permission is granted and, if it's not, request permission. See the example below for more details.
On Windows Phone, this will return Not Supported Yet
.
"environment"
returns the environment that the app is running in. These include:
simulator
for the Corona Simulator.device
for iOS, the Xcode iOS Simulator, Android devices, the Android emulator, Windows Phone devices, the Windows Phone emulator, macOS desktop apps, and Windows desktop apps."maxTextureSize"
returns the maximum texture width or height supported by the device.
"textureMemoryUsed"
returns the texture memory usage (in bytes). Texture memory for graphics/images tends to be the most sharply limited resource in mobile development since it runs out before normal memory.
"manufacturer"
returns the device's manufacturer. On Android, this returns the raw value of android.os.Build.MANUFACTURER
(reference). This is currently unsupported on Windows Phone. Examples include:
Apple
— returned on all Apple devices, iOS, macOS, or tvOS.Amazon
— returned on all samsung
— returned on all samsung
)HTC
— returned on all HTC
)LENOVO
— returned on Windows laptops manufactured by Lenovo LENOVO
)"model"
returns the device model (as specified by the manufacturer). Note that most Android devices return a model number instead of a model name. This is not currently supported on Windows Phone. Examples include:
iPhone
iPad
Apple TV
AFTM
(Amazon Fire TV)iPhone Simulator
iPad Simulator
Droid
Galaxy Tab
"name"
returns the human-readable model name. On iPhone, this would be the name of the phone as it appears in iTunes, for example "Steve's iPhone"
"platform"
returns the operating system platform tag, which can be one of:
android
— all Android devices and the Android emulator.ios
— all iOS devices and the Xcode iOS Simulator.macos
— macOS desktop apps and the Corona Simulator for macOS.tvos
— Apple's tvOS (Apple TV).win32
— Win32 desktop apps and the Corona Simulator for Windows.winphone
— all Windows Phone devices and the Windows Phone emulator.In the Simulators the value returned depends on the skin selected so you can test platform dependent logic by changing skins.
This option is deprecated; use "platform"
instead (see above).
"platformVersion"
returns a string representation of the platform version. This is sometimes, but not always, a number — for example, a Droid X currently returns 2.1-update1
"targetAppStore"
returns the name of the app store that the application was built for:
apple
— always returned on iOS.amazon
— targets the Amazon app store (only returned on Android).gameStick
— targets the GameStick console's app store (only returned on Android).google
— targets Google Play (only returned on Android).ouya
— targets the Ouya game console's app store (only returned on Android).windows
— targets the Windows app store (only returned on Windows Phone).none
— indicates that the app is not targeting a specific app store. This is always returned by the Corona Simulator."androidApiLevel"
returns an integer indicating which Android OS version the app is running on. For example,
"androidAppVersionCode"
returns the application's version code as a number. Returns nil
on all other platforms.
"androidAppPackageName"
returns the application's unique dot-separated package name. Returns nil
on all other platforms.
"androidGrantedAppPermissions"
returns a table of strings representing every app permission that has been requested and granted to the app. These are in the form of standard Android permission names, such as android.permission.WRITE_EXTERNAL_STORAGE
or com.android.vending.BILLING
.
"androidDeniedAppPermissions"
returns a table of strings representing every app permission that has been requested and denied to the app. These are in the form of standard Android permission names, such as android.permission.WRITE_EXTERNAL_STORAGE
or com.android.vending.BILLING
.
"grantedAppPermissions"
returns a table of strings representing every app permission that has been requested and granted to this app. This may contain a mix of Calendars
, and standard Android permission names, like android.permission.INTERNET
.
"deniedAppPermissions"
returns a table of strings representing every app permission that has been requested and denied to the app. This may contain a mix of Calendars
, and standard Android permission names, like android.permission.INTERNET
.
"androidDisplayApproximateDpi"
returns the approximate DPI (dots per inch) of the screen as a number. This DPI value is based on the device's assigned density name, such as hdpi
or xhdpi
, which provide standardized DPI values on Android. This value is typically not the actual DPI of the display, which you can fetch using "androidDisplayXDpi"
and "androidDisplayYDpi"
.
The following table lists the DPI values that will be returned for each display density type. Returns nil
on all other platforms.
Density | DPI |
---|---|
ldpi |
120 |
mdpi |
160 |
hdpi |
240 |
xhdpi |
320 |
xxhdpi |
480 |
xxxhdpi |
640 |
tvdpi |
213 |
"androidDisplayDensityName"
returns the device's screen density as a string, which can be ldpi
, mdpi
, hdpi
, xhdpi
, xxhdpi
, xxxhdpi
, tvdpi
, or unknown
. Returns nil
on all other platforms.
"androidDisplayWidthInInches"
returns the width of the application window in inches, relative to the orientation of the application. Returns nil
on all other platforms.
"androidDisplayHeightInInches"
returns the height of the application window in inches, relative to the orientation of the application. Returns nil
on all other platforms.
"androidDisplayXDpi"
returns the DPI (dots per inch) of the screen along the x axis, relative to the orientation of the application. This can be used to convert pixels to inches and vice-versa. Returns nil
on all other platforms.
"androidDisplayYDpi"
returns the DPI (dots per inch) of the screen along the y axis, relative to the orientation of the application. This can be used to convert pixels to inches and vice-versa. Returns nil
on all other platforms.
"iosIdentifierForVendor"
returns the value of "identifierForVendor"
(see here).
"gpuSupportsHighPrecisionFragmentShaders"
returns a boolean indicating whether HIGHP
is supported in fragment shaders on this device.
"GL_VENDOR"
returns the company responsible for the GL implementation on this device. See here for details.
"GL_RENDERER"
returns the name of the GL renderer. See here for details.
"GL_VERSION"
returns the GL version. See here for details.
"GL_SHADING_LANGUAGE_VERSION"
returns the GL version or release number for the GLSL shading language. See here for details.
"GL_EXTENSIONS"
returns the list of extensions supported on this device. See here for details.
if ( system.getInfo( "environment" ) == "simulator" ) then print( "You're in the Corona Simulator." ) end
local storedDeviceID = "" local function hasPhonePermission() -- Check to see if the user has previouslly granted permissions local grantedPermissions = system.getInfo( "grantedAppPermissions" ) local hasPhonePermission = false -- Check for the "Phone" group permission for i = 1,#grantedPermissions do if ( "Phone" == grantedPermissions[i] ) then hasPhonePermission = true break end end return hasPhonePermission end local function appPermissionsListener( event ) local phonePermissionGranted = hasPhonePermission() if not phonePermissionGranted then -- We can't continue, exit the app native.requestExit() else -- Safe to get the device ID storedDeviceID = system.getInfo( "deviceID" ) end end -- This only matters for Android 6 or later if ( system.getInfo( "platform" ) == "android" and system.getInfo( "androidApiLevel" ) >= 23 ) then local phonePermissionGranted = hasPhonePermission() if not phonePermissionGranted then -- If phone permission is not yet granted, prompt for it local permissionOptions = { appPermission = "Phone", urgency = "Critical", listener = appPermissionsListener, rationaleTitle = "Read phone state required", rationaleDescription = "This app needs this state to retrieve previously saved data. Re-request now?", settingsRedirectTitle = "Alert", settingsRedirectDescription = "Without the ability to access your device's unique ID, it can't function properly. Please grant phone access within Settings." } native.showPopup( "requestAppPermission", permissionOptions ) else -- We already have the needed permission storedDeviceID = system.getInfo( "deviceID" ) end end