acme.plugins.runtime.TextUI.TextUI

class documentation

class TextUI(object):

Constructor: TextUI()

TextUI plugin class. This class provides a textual user interface for the ACME CSE.

Method	`__init__`	Initialize the TextUI plugin.
Method	`configUpdate`	Callback for the `configUpdate` event.
Method	`configure`	Configure the TextUI plugin with the given configuration.
Method	`refreshResources`	Refresh the resources.
Method	`registrationUpdate`	Callback for registration-related events.
Method	`restart`	Restart the TextUI service.
Method	`runUI`	Run the TextUI. This will block until the TextUI is exited.
Method	`scriptClearConsole`	Clear the script console.
Method	`scriptLog`	Print a line to the script log output.
Method	`scriptLogError`	Print a line to the script log output.
Method	`scriptPrint`	Print a line to the script output.
Method	`scriptShowConfirmation`	Show a confirmation dialog.
Method	`scriptShowNotification`	Show a notification.
Method	`scriptVisualBell`	Visual bell.
Method	`shutdown`	Stop the TextUI service.
Method	`start`	Start the TextUI service.
Method	`validate`	Validate the configuration for the TextUI plugin.
Class Variable	`__slots__`	Slots for TextUI class.
Instance Variable	`tuiApp`	Instance of the ACMETuiApp class.

def __init__(self): ¶

Initialize the TextUI plugin.

@onEvent(eventManager.configUpdate)

def configUpdate(self, eventData: EventData): ¶

Callback for the configUpdate event.

Parameters
eventData:`EventData`	The event data, containing the name of the updated configuration setting and its new value.

@configure

def configure(self, config: Configuration): ¶

Configure the TextUI plugin with the given configuration.

Parameters
config:`Configuration`	The configuration to use for the TextUI plugin.

def refreshResources(self) -> bool: ¶

Refresh the resources.

Returns
`bool`	Always returns True.

@onEvent(eventManager.aeHasRegistered)
@onEvent(eventManager.aeHasDeregistered)
@onEvent(eventManager.registeredToRegistrarCSE)
@onEvent(eventManager.registreeCSEHasRegistered)
@onEvent(eventManager.registreeCSEHasDeregistered)
@onEvent(eventManager.deregisteredFromRegistrarCSE)
@onEvent(eventManager.registeredToRemoteCSE)
@onEvent(eventManager.csrUpdated)

def registrationUpdate(self, eventData: EventData): ¶

Callback for registration-related events.

This will trigger an update of the container registrations in the TextUI.

Parameters
eventData:`EventData`	The event data, containing information about the registration event.

@restart

def restart(self): ¶

Restart the TextUI service.

def runUI(self) -> bool: ¶

Run the TextUI. This will block until the TextUI is exited.

Returns
`bool`	True if the TextUI was exited with a restart request, False if it was exited with a quit request.

def scriptClearConsole(self, scriptName: str) -> bool: ¶

Clear the script console.

Parameters
scriptName:`str`	Name of the script.

Returns
`bool`	Always returns True.

def scriptLog(self, scriptName: str, msg: str) -> bool: ¶

Print a line to the script log output.

Parameters
scriptName:`str`	Name of the script.
msg:`str`	Message to print.

Returns
`bool`	Always returns True.

def scriptLogError(self, scriptName: str, msg: str) -> bool: ¶

Print a line to the script log output.

Parameters
scriptName:`str`	Name of the script.
msg:`str`	Message to print.

Returns
`bool`	Always returns True.

def scriptPrint(self, scriptName: str, msg: str): ¶

Print a line to the script output.

Parameters
scriptName:`str`	Name of the script.
msg:`str`	Message to print.

def scriptShowConfirmation(self, msg: str, title: str, confirmButtonText: str | None = 'Confirm', cancelButtonText: str | None = 'Cancel') -> bool | None: ¶

Show a confirmation dialog.

Parameters
msg:`str`	Message to show.
title:`str`	Title of the dialog.
confirmButtonText:`str \| None`	Text for the confirm button.
cancelButtonText:`str \| None`	Text for the cancel button.

Returns
`bool \| None`	True if the user confirmed, False if the user cancelled, None if TUI is not available.

def scriptShowNotification(self, msg: str, title: str, severity: Literal['information', 'warning', 'error'], timeout: float): ¶

Show a notification.

Parameters
msg:`str`	Message to show.
title:`str`	Title of the notification.
severity:`Literal['information', 'warning', 'error']`	Severity of the notification.
timeout:`float`	Timeout in seconds.

def scriptVisualBell(self, scriptName: str) -> bool: ¶

Visual bell.

Parameters
scriptName:`str`	Name of the script.

Returns
`bool`	Always returns True.

@stop

def shutdown(self) -> bool: ¶

Stop the TextUI service.

Returns
`bool`	Always returns True.

@start

def start(self): ¶

Start the TextUI service.

@validate

def validate(self, config: Configuration): ¶

Validate the configuration for the TextUI plugin.

Parameters
config:`Configuration`	The configuration to validate.

Raises
`ConfigurationError`	If the configuration is invalid.

__slots__: tuple[str, ...] = ¶

Slots for TextUI class.

tuiApp: ACMETuiApp = ¶

Instance of the ACMETuiApp class.