Actions

ExtensionCustomAction

class ulauncher.api.shared.action.ExtensionCustomAction.ExtensionCustomAction(data, keep_app_open=False)

If initiated with data, the same data will be returned in ItemEnterEvent object

Parameters:
  • data (any) – any type that can be serialized with pickle.dumps()
  • keep_app_open (bool) – pass True if you want to keep Ulauncher window open. False by default

ActionList

class ulauncher.api.shared.action.ActionList.ActionList

Used to run multiple action at once

Parameters:actions (list) – list of actions to run

CopyToClipboardAction

DoNothingAction

class ulauncher.api.shared.action.DoNothingAction.DoNothingAction

Does nothing. Keeps Ulauncher window open

HideWindowAction

class ulauncher.api.shared.action.HideWindowAction.HideWindowAction

Does what the class name says

LaunchAppAction

OpenAction

class ulauncher.api.shared.action.OpenAction.OpenAction(path)

Run platform specific command to open either file or directory

Parameters:path (str) – file or dir path

OpenUrlAction

class ulauncher.api.shared.action.OpenUrlAction.OpenUrlAction(url)

Opens URL in a default browser

Parameters:url (str) –

RenderResultListAction

RunScriptAction

class ulauncher.api.shared.action.RunScriptAction.RunScriptAction(script, args)

Runs a user script

Parameters:
  • script (str) – script content
  • args (list) – arguments

SetUserQueryAction

Note

Please take a short survey to help us build greater API and documentation