API Reference

Attributes

NAME_SPACE module-attribute

NAME_SPACE = 'Flow.Launcher'

Classes

Functions

change_query

change_query(query: str, requery: bool = False) -> JsonRPCAction

Change the query in Flow Launcher.

Source code in pyflowlauncher/api.py

def change_query(query: str, requery: bool = False) -> JsonRPCAction:
    """Change the query in Flow Launcher."""
    return _send_action("ChangeQuery", query, requery)

close_app

close_app() -> JsonRPCAction

Close Flow Launcher.

Source code in pyflowlauncher/api.py

def close_app() -> JsonRPCAction:
    """Close Flow Launcher."""
    return _send_action("CloseApp")

copy_to_clipboard

copy_to_clipboard(text: str, direct_copy: bool = False, show_default_notification=True) -> JsonRPCAction

Copy text to the clipboard.

Source code in pyflowlauncher/api.py

def copy_to_clipboard(text: str, direct_copy: bool = False, show_default_notification=True) -> JsonRPCAction:
    """Copy text to the clipboard."""
    return _send_action("CopyToClipboard", text, direct_copy, show_default_notification)

hide_app

hide_app() -> JsonRPCAction

Hide Flow Launcher.

Source code in pyflowlauncher/api.py

def hide_app() -> JsonRPCAction:
    """Hide Flow Launcher."""
    return _send_action("HideApp")

open_directory

open_directory(directory_path: str, filename_or_filepath: Optional[str] = None) -> JsonRPCAction

Open a directory.

Source code in pyflowlauncher/api.py

def open_directory(directory_path: str, filename_or_filepath: Optional[str] = None) -> JsonRPCAction:
    """Open a directory."""
    return _send_action("OpenDirectory", directory_path, filename_or_filepath)

open_setting_dialog

open_setting_dialog() -> JsonRPCAction

Open the settings window in Flow Launcher.

Source code in pyflowlauncher/api.py

def open_setting_dialog() -> JsonRPCAction:
    """Open the settings window in Flow Launcher."""
    return _send_action("OpenSettingDialog")

open_uri

open_uri(uri: str) -> JsonRPCAction

Open a URI.

Source code in pyflowlauncher/api.py

def open_uri(uri: str) -> JsonRPCAction:
    """Open a URI."""
    return _send_action("OpenAppUri", uri)

open_url

open_url(url: str, in_private: bool = False) -> JsonRPCAction

Open a URL.

Source code in pyflowlauncher/api.py

def open_url(url: str, in_private: bool = False) -> JsonRPCAction:
    """Open a URL."""
    return _send_action("OpenUrl", url, in_private)

reload_plugins

reload_plugins() -> JsonRPCAction

Reload the plugins in Flow Launcher.

Source code in pyflowlauncher/api.py

def reload_plugins() -> JsonRPCAction:
    """Reload the plugins in Flow Launcher."""
    return _send_action("ReloadPlugins")

shell_run

shell_run(command: str, filename: str = 'cmd.exe') -> JsonRPCAction

Run a shell command.

Source code in pyflowlauncher/api.py

def shell_run(command: str, filename: str = 'cmd.exe') -> JsonRPCAction:
    """Run a shell command."""
    return _send_action("ShellRun", command, filename)

show_app

show_app() -> JsonRPCAction

Show Flow Launcher.

Source code in pyflowlauncher/api.py

def show_app() -> JsonRPCAction:
    """Show Flow Launcher."""
    return _send_action("ShowApp")

show_msg

show_msg(title: str, sub_title: str, ico_path: str = '') -> JsonRPCAction

Show a message in Flow Launcher.

Source code in pyflowlauncher/api.py

def show_msg(title: str, sub_title: str, ico_path: str = "") -> JsonRPCAction:
    """Show a message in Flow Launcher."""
    return _send_action("ShowMsg", title, sub_title, ico_path)

start_loading_bar

start_loading_bar() -> JsonRPCAction

Start the loading bar in Flow Launcher.

Source code in pyflowlauncher/api.py

def start_loading_bar() -> JsonRPCAction:
    """Start the loading bar in Flow Launcher."""
    return _send_action("StartLoadingBar")

stop_loading_bar

stop_loading_bar() -> JsonRPCAction

Stop the loading bar in Flow Launcher.

Source code in pyflowlauncher/api.py

def stop_loading_bar() -> JsonRPCAction:
    """Stop the loading bar in Flow Launcher."""
    return _send_action("StopLoadingBar")