setTextForm (v1.1)

Estimated reading time: 1 minute

This API provides the function to input text on the field of the software keyboard. This version supports encrypted text data transmission.

Note

Please find more details about encryption here.

Syntax

http://<Base URL>/appControl

Authentication Level

generic

Request

params' Elements
An object composed of the following pair(s).
name type multiplicity default description
encKey string ? "" Encryption key encrypted by the public key. The default value is "", which means the data is not encrypted.
text string 1 Text data encoded by UTF8. If encKey is set, this must be encrypted.
JSON Example
{
    "method": "setTextForm",
    "id": 601,
    "params": [{
        "encKey": "AAAAB3NzaC1yc2EAAAABIwAAAQEA3p6TmGYDRtnnmzckD5leg7lHIUY9cuV6vFvacew1uZ7Bmx2MF9a7SqmtiLDkLS3P9y9eobRjuWriSfgmqDPRFRU2mdwAmRm2aIvYa6WkzvnrfUhGR+SCT/Z62j7V9ps6Mt5HB8mFQj3494p4StTPVS1nFqvEUazEx13EJnJyHsdYqsV6UJV169e43oLSSccb3lr8BzeMUnGEfY+NKlAxDpEycr5jJYyTkLfrbX0lyAPs+vLwLRYhm+h2qJYAZUwknus4vD7aki4G69S+gnENClglh/e9ut9Q5BrtxiBQCEikn9V9rlnVkbp1eEUf89XFiHRWMVrRAINtJyQFvvoPOQ==",
        "text": "dtA6UNsMnahxCkfGdrc8AFhisnFZg8FnKTl7Sk4Wg9J8gYK8+Dv6Io7Ssef7ZPTo"
    }],
    "version": "1.1"
}

Response

result's Elements
Not necessary.
JSON Example
{
    "result": [],
    "id": 601
}
Error Code
The following error codes are important for this API. Refer to error code for other errors.
code Explanation
7 Software keyboard is not active.
40002 Encryption error.

Appendix

Guide about Request

  • “encKey” must always be set.
  • Otherwise, error #3 “Illegal Argument” is returned.
Last modified: 4 Sep 2019