Trigger: User Input

API 13.0

You can trigger a popup message for users by using this call. This will popup an user input message and when the users is done, the result is send back.

Sending a piece of data (a message) to Touch Portal should always end with a newline character. This will indicate Touch Portal that it is the whole message.

{
  "type":"requestUserInput",
  "id":"userNameRequest",
  "message":"Please enter your username:"
}

This will trigger a popup message which is blocking for the user with the given ID. This ID is send back with the result of this call. The message will be shown to the user on the popup message.

Key Type Req. API Description
type Text yes 13.0 The "requestUserInput" corresponts to a message type to trigger a user input popup window.
id Text yes 13.0 The ID as a reference for when you receive the result.
message Text yes 13.0 The message to show the user for requesting input from the user.