ScriptX

Appearance

Device ​

Get device information

Device provides information about the current iOS device, including hardware, screen, battery, and locale.

Use Device to:

Examples ​

javascript
console.log(Device.name());
console.log(Device.systemVersion());
console.log(Device.isPhone() ? "iPhone" : "iPad");
javascript
let level = Device.batteryLevel();
let charging = Device.isCharging();
console.log(`Battery: ${level * 100}%`);

Methods ​

name ​

Get device name

typescript
static name(): string

Returns: User-assigned device name

Example:

javascript
Device.name()

systemName ​

Get operating system name

typescript
static systemName(): string

Returns: "iOS" or "iPadOS"

Example:

javascript
Device.systemName()

systemVersion ​

Get operating system version

typescript
static systemVersion(): string

Returns: Version string like "17.0"

Example:

javascript
Device.systemVersion()

model ​

Get device model

typescript
static model(): string

Returns: "iPhone" or "iPad"

Example:

javascript
Device.model()

isPhone ​

Check if device is iPhone

typescript
static isPhone(): boolean

Returns: true if running on iPhone

Example:

javascript
Device.isPhone()

isPad ​

Check if device is iPad

typescript
static isPad(): boolean

Returns: true if running on iPad

Example:

javascript
Device.isPad()

screenSize ​

Get screen size in points

typescript
static screenSize(): object

Returns: Object with width and height

Example:

javascript
let size = Device.screenSize()

screenResolution ​

Get screen resolution in pixels

typescript
static screenResolution(): object

Returns: Object with width and height in pixels

Example:

javascript
let res = Device.screenResolution()

screenScale ​

Get screen scale factor

typescript
static screenScale(): number

Returns: Scale factor (2.0 or 3.0)

Example:

javascript
Device.screenScale()

screenBrightness ​

Get current screen brightness

typescript
static screenBrightness(): number

Returns: Brightness from 0.0 to 1.0

Example:

javascript
Device.screenBrightness()

setScreenBrightness ​

Set screen brightness

typescript
static setScreenBrightness(percentage): void
  • percentage - Brightness from 0.0 to 1.0

Example:

javascript
Device.setScreenBrightness(0.5)

isInPortrait ​

Check if device is in portrait orientation

typescript
static isInPortrait(): boolean

Example:

javascript
Device.isInPortrait()

isInPortraitUpsideDown ​

Check if device is upside down

typescript
static isInPortraitUpsideDown(): boolean

Example:

javascript
Device.isInPortraitUpsideDown()

isInLandscapeLeft ​

Check if device is in landscape left

typescript
static isInLandscapeLeft(): boolean

Example:

javascript
Device.isInLandscapeLeft()

isInLandscapeRight ​

Check if device is in landscape right

typescript
static isInLandscapeRight(): boolean

Example:

javascript
Device.isInLandscapeRight()

isFaceUp ​

Check if device is face up

typescript
static isFaceUp(): boolean

Example:

javascript
Device.isFaceUp()

isFaceDown ​

Check if device is face down

typescript
static isFaceDown(): boolean

Example:

javascript
Device.isFaceDown()

batteryLevel ​

Get battery level

typescript
static batteryLevel(): number

Returns: Battery level from 0.0 to 1.0

Example:

javascript
Device.batteryLevel()

isDischarging ​

Check if device is discharging

typescript
static isDischarging(): boolean

Example:

javascript
Device.isDischarging()

isCharging ​

Check if device is charging

typescript
static isCharging(): boolean

Example:

javascript
Device.isCharging()

isFullyCharged ​

Check if battery is fully charged

typescript
static isFullyCharged(): boolean

Example:

javascript
Device.isFullyCharged()

preferredLanguages ​

Get preferred languages

typescript
static preferredLanguages(): string[]

Returns: Array of language codes in order of preference

Example:

javascript
Device.preferredLanguages()

locale ​

Get current locale identifier

typescript
static locale(): string

Returns: Locale like "en_US" or "zh_CN"

Example:

javascript
Device.locale()

language ​

Get current language code

typescript
static language(): string

Returns: Language code like "en" or "zh"

Example:

javascript
Device.language()

isUsingDarkAppearance ​

Check if using dark mode

typescript
static isUsingDarkAppearance(): boolean

Returns: true if dark mode is enabled

Example:

javascript
Device.isUsingDarkAppearance()

volume ​

Get current system volume

typescript
static volume(): number

Returns: Volume from 0.0 to 1.0

Example:

javascript
Device.volume()