{
  "specversion": 3,
  "name": "Dialogs",
  "doc": "A library providing dialogs for interacting with users.\n\n``Dialogs`` is Robot Framework's standard library that provides means\nfor pausing the test or task execution and getting input from users.\n\nLong lines in the provided messages are wrapped automatically. If you want\nto wrap lines manually, you can add newlines using the ``\\n`` character\nsequence.\n\nThe library has a known limitation that it cannot be used with timeouts.",
  "version": "7.2.dev1",
  "generated": "2024-10-02T23:00:46+00:00",
  "type": "LIBRARY",
  "scope": "GLOBAL",
  "docFormat": "ROBOT",
  "source": "/home/peke/Devel/robotframework/src/robot/libraries/Dialogs.py",
  "lineno": 1,
  "tags": [],
  "inits": [],
  "keywords": [
    {
      "name": "Execute Manual Step",
      "args": [
        {
          "name": "message",
          "type": null,
          "defaultValue": null,
          "kind": "POSITIONAL_OR_NAMED",
          "required": true,
          "repr": "message"
        },
        {
          "name": "default_error",
          "type": null,
          "defaultValue": "",
          "kind": "POSITIONAL_OR_NAMED",
          "required": false,
          "repr": "default_error="
        }
      ],
      "returnType": null,
      "doc": "Pauses execution until user sets the keyword status.\n\nUser can press either ``PASS`` or ``FAIL`` button. In the latter case execution\nfails and an additional dialog is opened for defining the error message.\n\n``message`` is the instruction shown in the initial dialog and\n``default_error`` is the default value shown in the possible error message\ndialog.",
      "shortdoc": "Pauses execution until user sets the keyword status.",
      "tags": [],
      "source": "/home/peke/Devel/robotframework/src/robot/libraries/Dialogs.py",
      "lineno": 48
    },
    {
      "name": "Get Selection From User",
      "args": [
        {
          "name": "message",
          "type": null,
          "defaultValue": null,
          "kind": "POSITIONAL_OR_NAMED",
          "required": true,
          "repr": "message"
        },
        {
          "name": "values",
          "type": null,
          "defaultValue": null,
          "kind": "VAR_POSITIONAL",
          "required": false,
          "repr": "*values"
        },
        {
          "name": "default",
          "type": null,
          "defaultValue": "None",
          "kind": "NAMED_ONLY",
          "required": false,
          "repr": "default=None"
        }
      ],
      "returnType": null,
      "doc": "Pauses execution and asks user to select a value.\n\nThe selected value is returned. Pressing ``Cancel`` fails the keyword.\n\n``message`` is the instruction shown in the dialog, ``values`` are\nthe options given to the user and ``default`` is the optional default value.\n\nThe default value can either be one of the specified values or the index of\nthe value starting from ``1``. For example, ``default=user1`` and ``default=1``\nin the examples below have the exact same effect.\n\nExample:\n| ${user} = | Get Selection From User | Select user | user1 | user2 | admin |\n| ${user} = | Get Selection From User | Select user | user1 | user2 | admin | default=user1 |\n| ${user} = | Get Selection From User | Select user | user1 | user2 | admin | default=1 |\n\n``default`` is new in Robot Framework 7.1.",
      "shortdoc": "Pauses execution and asks user to select a value.",
      "tags": [],
      "source": "/home/peke/Devel/robotframework/src/robot/libraries/Dialogs.py",
      "lineno": 86
    },
    {
      "name": "Get Selections From User",
      "args": [
        {
          "name": "message",
          "type": null,
          "defaultValue": null,
          "kind": "POSITIONAL_OR_NAMED",
          "required": true,
          "repr": "message"
        },
        {
          "name": "values",
          "type": null,
          "defaultValue": null,
          "kind": "VAR_POSITIONAL",
          "required": false,
          "repr": "*values"
        }
      ],
      "returnType": null,
      "doc": "Pauses execution and asks user to select multiple values.\n\nThe selected values are returned as a list. Selecting no values is OK\nand in that case the returned list is empty. Pressing ``Cancel`` fails\nthe keyword.\n\n``message`` is the instruction shown in the dialog and ``values`` are\nthe options given to the user.\n\nExample:\n| ${users} = | Get Selections From User | Select users | user1 | user2 | admin |",
      "shortdoc": "Pauses execution and asks user to select multiple values.",
      "tags": [],
      "source": "/home/peke/Devel/robotframework/src/robot/libraries/Dialogs.py",
      "lineno": 108
    },
    {
      "name": "Get Value From User",
      "args": [
        {
          "name": "message",
          "type": null,
          "defaultValue": null,
          "kind": "POSITIONAL_OR_NAMED",
          "required": true,
          "repr": "message"
        },
        {
          "name": "default_value",
          "type": null,
          "defaultValue": "",
          "kind": "POSITIONAL_OR_NAMED",
          "required": false,
          "repr": "default_value="
        },
        {
          "name": "hidden",
          "type": null,
          "defaultValue": "False",
          "kind": "POSITIONAL_OR_NAMED",
          "required": false,
          "repr": "hidden=False"
        }
      ],
      "returnType": null,
      "doc": "Pauses execution and asks user to input a value.\n\nValue typed by the user, or the possible default value, is returned.\nReturning an empty value is fine, but pressing ``Cancel`` fails the keyword.\n\n``message`` is the instruction shown in the dialog and ``default_value`` is\nthe possible default value shown in the input field.\n\nIf ``hidden`` is given a true value, the value typed by the user is hidden.\n``hidden`` is considered true if it is a non-empty string not equal to\n``false``, ``none`` or ``no``, case-insensitively. If it is not a string,\nits truth value is got directly using same\n[http://docs.python.org/library/stdtypes.html#truth|rules as in Python].\n\nExample:\n| ${username} = | Get Value From User | Input user name | default    |\n| ${password} = | Get Value From User | Input password  | hidden=yes |",
      "shortdoc": "Pauses execution and asks user to input a value.",
      "tags": [],
      "source": "/home/peke/Devel/robotframework/src/robot/libraries/Dialogs.py",
      "lineno": 63
    },
    {
      "name": "Pause Execution",
      "args": [
        {
          "name": "message",
          "type": null,
          "defaultValue": "Execution paused. Press OK to continue.",
          "kind": "POSITIONAL_OR_NAMED",
          "required": false,
          "repr": "message=Execution paused. Press OK to continue."
        }
      ],
      "returnType": null,
      "doc": "Pauses execution until user clicks ``Ok`` button.\n\n``message`` is the message shown in the dialog.",
      "shortdoc": "Pauses execution until user clicks ``Ok`` button.",
      "tags": [],
      "source": "/home/peke/Devel/robotframework/src/robot/libraries/Dialogs.py",
      "lineno": 40
    }
  ],
  "typedocs": []
}