Keyboard Support

Contact and Search

Keyman.com Homepage

Header bottom

Keyman.com

Other versions
Version 18.0 (current version)Version 16.0Version 15.0Version 14.0Version 13.0Version 12.0Version 11.0Version 10.0

On this page

Manager.stateForKeyboard()

Summary

The stateForKeyboard() method returns the current state of availability for a keyboard.

Deprecated, as keyboards and lexical models are no longer directly downloaded in favor of packages. Refer to ResourceFileManager.shared.installState()

Syntax

Manager.stateForKeyboard(keyboardID: String)

Parameters

keyboardID
ID of the keyboard.

Returns

Returns the keyboard state: downloading, needsDownload, needsUpdate, or upToDate.

Description

This syntax can be used for getting the state of a keyboard.

Examples

Example: Using stateForKeyboard()

The following script illustrates the use of stateForKeyboard():

let kbState = Manager.shared.stateForKeyboard(withID: kb.id)
if kbState == .needsUpdate {
  if !kbIDs.contains(kb.id) {
    kbIDs.insert(kb.id)
    updateQueue!.append(kb)
  }
}

History

Deprecated in Keyman Engine for iPhone and iPad 14.0.