mirror of
https://github.com/keymanapp/keyman.git
synced 2026-08-16 05:39:24 +00:00
1f82507730
Deprecate the following obsolete functions and properties: * `keyman.helpURL` * `keyman.util.rgba` * `keyman.util.toFloat` * `keyman.util.toNumber` * `keyman.util.toNzString` Use correct language for code blocks in Keyman Engine for Web documentation. Test-bot: skip
62 lines
1.3 KiB
Markdown
62 lines
1.3 KiB
Markdown
---
|
|
title: ifStore (KIFS)
|
|
---
|
|
|
|
## Summary
|
|
|
|
`ifStore` compares the content of a [system `store`](/developer/language/guide/stores#toc-system-stores) with a string value.
|
|
|
|
## Syntax
|
|
|
|
```js
|
|
keyman.interface.ifStore(systemId, strValue, Pelem);
|
|
```
|
|
|
|
or
|
|
|
|
```js
|
|
KeymanWeb.KIFS(systemId, strValue, Pelem);
|
|
```
|
|
|
|
### Parameters
|
|
|
|
`systemId`
|
|
: Type: `number`
|
|
: The ID of the system store to test.
|
|
|
|
`strValue`
|
|
: Type: `string`
|
|
: The string value to be used for comparison.
|
|
|
|
`Pelem`
|
|
: Type: `Element`
|
|
: The page element currently active. (This parameter exists for use by possible future extensions.)
|
|
|
|
### Return Value
|
|
|
|
`boolean`
|
|
: `true` if the value matches that of the system store, otherwise `false`.
|
|
|
|
## Description
|
|
|
|
Only system IDs `31` (`platform`) and `33` (`layer`) are currently supported.
|
|
|
|
For `platform`, any combination of the following may be tested against the current device and browser:
|
|
|
|
- Input method:
|
|
: `['touch', 'hardware']`
|
|
|
|
- any combination of OS:
|
|
: `['windows', 'android', 'ios', 'macosx', 'linux']`
|
|
|
|
- form factor:
|
|
: `['desktop', 'tablet', 'phone']`
|
|
|
|
- browser:
|
|
: `['native', 'web', 'ie', 'chrome', 'firefox', 'safari', 'opera']`
|
|
|
|
Only one of each category may be matched at a time.
|
|
|
|
## See also
|
|
|
|
- [`keyman.interface.setStore()`](setStore)
|