PKDEVICE.formFactorOverride

(part of PKDEVICE)

Type: boolean/string

Default: false

Determines if the form factor returned by PKDEVICE.formFactor should be overridden. If this value is false, the value returned will be the actual form factor. If this value is anything other than false, that value will be returned.

For example:

PKDEVICE.formFactor();
// returns "phone"
PKDEVICE.formFactorOverride = "tablet";
PKDEVICE.formFactor();
// returns "tablet"

There are rarely any good reasons to override the value returned by PKDEVICE.formFactor(). One potentially good reason is if the value returned is not correct for the given device you are running on.

Version

0.1 Introduced

0.2 Docs Valid