InputDevice API

Methods

getSupportedKeys

Retrieves the list of keys can be registered with the registerKey() method.

InputDeviceKey[] getSupportedKeys();

Since: 2.4

Mandatory keys will not be retrieved by this method.

Return value:

InputDeviceKey[]: List of supported keys.

Exceptions:

• WebAPIException

  • with error type UnknownError in case of any error.

Code example:

var i, keyCode = {}, supportedKeys;
supportedKeys = tizen.inputdevice.getSupportedKeys();
for (i = 0; i < supportedKeys.length; i++)
{
  keyCode[supportedKeys[i].name] = supportedKeys[i].code;
}
if (keyCode.hasOwnProperty("VolumeUp"))
{
  tizen.inputdevice.registerKey("VolumeUp");
}
window.addEventListener("keydown", function(keyEvent)
{
  /* Identify the key by the numeric code from the keyEvent. */
  if (keyEvent.keyCode === keyCode.VolumeUp)
  {
    console.log("The VOLUME UP was pressed");
  }
});

getKey

Returns information about the key which has the given name.

InputDeviceKey? getKey(InputDeviceKeyName keyName);

Since: 2.4

Parameters:

• keyName: The name of the key to retrieve.

Return value:

InputDeviceKey [nullable]: InputDeviceKey object for the given key name or null if the key is not supported.

Exceptions:

• WebAPIException

  • with error type InvalidValuesError if the given keyName is invalid (e.g. name is empty string)

  • with error type UnknownError in any other error case.

registerKey

Registers an input device key to receive DOM keyboard event when it is pressed or released

void registerKey(InputDeviceKeyName keyName);

Since: 2.4

When an application wants to react to the Input Device keys being pressed, it should register this key.

An application can not register the mandatory keys (ArrowLeft, ArrowRight, ArrowUp, ArrowDown, Enter, Back).

Parameters:

• keyName: The name of the key which should generate DOM key events when pressed.

Exceptions:

• WebAPIException

  • with error type InvalidValuesError, if the given keyName is invalid or not supported (e.g. name is empty string).

  • with error type UnknownError in any other error case.

Code example:

var keys = ["VolumeUp", "VolumeDown"], i;
for (i = 0; i < keys.length; i++)
{
  try
  {
    tizen.inputdevice.registerKey(keys[i]);
  }
  catch (error)
  {
    console.log("Failed to register " + keys[i] + ": " + error);
  }
}

unregisterKey

Unregisters an input device key

void unregisterKey(InputDeviceKeyName keyName);

Since: 2.4

Parameters:

• keyName: The name of the key which should not be monitored any longer.

Exceptions:

• WebAPIException

  • with error type InvalidValuesError, if the given keyName is invalid or not supported (e.g. name is empty string).

  • with error type UnknownError in any error case.

Code example:

tizen.inputdevice.unregisterKey("VolumeDown");

registerKeyBatch

Registers a batch of input device keys to receive DOM keyboard event when any of them is pressed or released

void registerKeyBatch(InputDeviceKeyName[] keyNames, optional SuccessCallback? successCallback,
                      optional ErrorCallback? errorCallback);

Since: 2.4

The errorCallback is launched with this error type:

• InvalidValuesError: If any of the given keyNames is invalid or not supported
• UnknownError: In case of any other error

When an application wants to react to the input device keys being pressed, it should register those keys.

An application can not register the mandatory keys (ArrowLeft, ArrowRight, ArrowUp, ArrowDown, Enter, Back).

Parameters:

• keyNames: The array with key names of keys which should generate DOM key events when pressed.
• successCallback [optional] [nullable]: Callback method to be invoked when keys are registered.
• errorCallback [optional] [nullable]: Callback method to be invoked when an error has occurred.

Exceptions:

• WebAPIException

  • with error type InvalidValuesError, if any of the given keyNames is invalid or not supported (e.g. name is empty string).

  • with error type TypeMismatchError, if any input parameter is not compatible with the expected type for that parameter.

  • with error type UnknownError in any other error case.

Code example:

function errorCB(err)
{
  console.log("The following error occurred: " + err.name);
}

function successCB()
{
  console.log("Registered successfully");
}

var keys = ["VolumeUp", "VolumeDown"];
tizen.inputdevice.registerKeyBatch(keys, successCB, errorCB);

unregisterKeyBatch

Unregisters a batch of input device keys

void unregisterKeyBatch(InputDeviceKeyName[] keyNames, optional SuccessCallback? successCallback,
                        optional ErrorCallback? errorCallback);

Since: 2.4

The errorCallback is launched with this error type:

• InvalidValuesError: If any of the given keyNames is invalid or not supported
• UnknownError: In case of any other error

Parameters:

• keyNames: The array containing names of keys which should not be monitored any longer.
• successCallback [optional] [nullable]: Callback method to be invoked when keys are unregistered.
• errorCallback [optional] [nullable]: Callback method to be invoked when an error has occurred.

Exceptions:

• WebAPIException

  • with error type InvalidValuesError, if any of the given keyNames is invalid or not supported (e.g. name is empty string).

  • with error type TypeMismatchError, if any input parameter is not compatible with the expected type for that parameter.

  • with error type UnknownError in any error case.

Code example:

function errorCB(err)
{
  console.log("The following error occurred: " + err.name);
}

function successCB()
{
  console.log("Unregistered successfully");
}

var keys = ["VolumeUp", "VolumeDown"];
tizen.inputdevice.unregisterKeyBatch(keys, successCB, errorCB);