---
# System prepended metadata

title: API Guide - dialogMan
tags: [Guide, API]

---

## Methods that TBot can call in getTestInput().
For query and control the app under test and system under test from inside the TBot execution.

==path=API.dialogMan==

## Description
dialog management API group

## Group Methods
1. **speak2GUI**, path=API.dialogMan.speak2GUI
    * Description: shows a message to the dialog panel.
    * Arguments:
        1. *player* : who wants to send the message.
        2. *timeStamp* : the time stamp of the message. If it is None, little T will get it for you.
        3. *dateStamp* : the date stamp of the message. If it is None, little T will get it for you.
        4. *texts* : a list of sentences. Default is the empty list.
2. **QAsInGUI**, path=API.dialogMan.QAsInGUI
    * Description: creates a Q&A session in the dialog panel and returns the list of answers.
    * Arguments:
        1. *player* : who asked the questions.
        2. *questions* : a list of questions.
    * Return Value: a list of answers corresponding to the questions.
3. **timedMessageDialogBox**, path=API.dialogMan.timedMessageDialogBox
    * Description: Show a windowed message that closes after a period specified as a parameter.
    * Arguments:
        1. *player* : who wants to show the message?
        2. *message* : a string as the message
        3. *title* : a string to show in the menubar.
        4. *timeToLive* : the number of second to show the message. Default is None which never closing the message window.
        5. *flagDefaultOK* : a Boolean value setting default     * Return Value to 'ok'. Default is True.
        6. *flagOnlyOK* : a Boolean value setting only one button 'OK'Default is False.
    * Return Value: answer to the dialog.
4. **textEntryDialogBox**, path=API.dialogMan.textEntryDialogBox
    * Description: shows a message window and waiting for the reponse as a string from the user.
    * Arguments:
        1. *player* : who wants to show the message?
        2. *message* : a string as the message
        3. *title* : a string to show in the menubar.
        4. *defaultValue* : the string to return if the user does nothing.
    * Return Value: text entered by the user.
5. **singleSelectionDialogBox**, path=API.dialogMan.singleSelectionDialogBox
    * Description: show a table waiting for the user to select a row.
    * Arguments:
        1. *player* : who wants to show the selection?
        2. *message* : a string as the message
        3. *title* : a string to show in the menubar.
        4. *choices* : a list (of strings) to choose from.
        5. *typeDialog* : a string for an icon showing the type of message. Values can be ? (for questions), error (for error alert), ! (for exclamation) and i (for information). Default is ?
    * Return Value: a row selected by the user.
6. **multipleSelectionDialogBox**, path=API.dialogMan.multipleSelectionDialogBox
    * Description: show a table waiting for the user to select several rows.
    * Arguments:
        1. *player* : who wants to show the selection?
        2. *message* : a string as the message
        3. *title* : a string to show in the menubar.
        4. *choices* : a list (of strings) to choose from.
        5. *typeDialog* : a string for an icon showing the type of message. Values can be ? (for questions), error (for error alert), ! (for exclamation) and i (for information). Default is ?
    * Return Value: rows selected by the users.
7. **progressBox**, path=API.dialogMan.progressBox
    * Description: show a message with a progress indicator.
    * Arguments:
        1. *player* : who wants to show the selection?
        2. *message* : a string as the message
        3. *title* : a string to show in the menubar.
        4. *progressMax* : the maximum of progress indication.
        5. *progressIndexCall* : a call back function that return the progress as a value between zero and progressMax.
8. **fileDialog**, path=API.dialogMan.fileDialog
    * Description: show a file browsing panel for the user to select a file.
    * Arguments:
        1. *player* : who wants to show the selection?
        2. *title* : a string to show in the menubar.
        3. *defaultPath* : a default file path. Default is the empty string.
        4. *wildCard* : the types of files.
        5. *flagMultipleSelection* : a Boolean value for multiple choices. Default is False.
    * Return Value: string of a file path.
9. **folderDialog**, path=API.dialogMan.folderDialog
    * Description: show a folder browsing panel for the user to select a folder.
    * Arguments:
        1. *player* : who wants to show the selection?
        2. *title* : a string to show in the menubar.
        3. *defaultPath* : a default folder path. Default is the empty string.
    * Return Value: string of a folder path.