ulauncher.api.shared.action package¶
Submodules¶
ulauncher.api.shared.action.ActionList module¶
-
class
ulauncher.api.shared.action.ActionList.
ActionList
Bases:
list
,ulauncher.api.shared.action.BaseAction.BaseAction
Used to run multiple action at once
Parameters: actions (list) – list of actions to run -
keep_app_open
() Return type: boolean Returns: return true if there are no actions in the list otherwise returns any(map(lambda i: i.keep_app_open(), self))
-
run
() Runs action
-
ulauncher.api.shared.action.BaseAction module¶
ulauncher.api.shared.action.CopyToClipboardAction module¶
ulauncher.api.shared.action.DoNothingAction module¶
-
class
ulauncher.api.shared.action.DoNothingAction.
DoNothingAction
Bases:
ulauncher.api.shared.action.BaseAction.BaseAction
Does nothing. Keeps Ulauncher window open
-
keep_app_open
() Return type: bool Returns: True if Ulauncher window should remain open once all actions are done
-
run
() Runs action
-
ulauncher.api.shared.action.ExtensionCustomAction module¶
-
class
ulauncher.api.shared.action.ExtensionCustomAction.
ExtensionCustomAction
(data, keep_app_open=False) Bases:
ulauncher.api.shared.action.BaseAction.BaseAction
If initiated with
data
, the same data will be returned inItemEnterEvent
objectParameters: - 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
-
keep_app_open
() Return type: bool Returns: True if Ulauncher window should remain open once all actions are done
-
run
() Runs
trigger_event()
withItemEnterEvent
- data (any) – any type that can be serialized with
ulauncher.api.shared.action.LaunchAppAction module¶
ulauncher.api.shared.action.OpenAction module¶
-
class
ulauncher.api.shared.action.OpenAction.
OpenAction
(path) Bases:
ulauncher.api.shared.action.BaseAction.BaseAction
Run platform specific command to open either file or directory
Parameters: path (str) – file or dir path -
keep_app_open
() Return type: bool Returns: True if Ulauncher window should remain open once all actions are done
-
run
() Runs action
-
ulauncher.api.shared.action.OpenUrlAction module¶
-
class
ulauncher.api.shared.action.OpenUrlAction.
OpenUrlAction
(url) Bases:
ulauncher.api.shared.action.BaseAction.BaseAction
Opens URL in a default browser
Parameters: url (str) – -
run
() Runs action
-
ulauncher.api.shared.action.RenderResultListAction module¶
ulauncher.api.shared.action.RunScriptAction module¶
-
class
ulauncher.api.shared.action.RunScriptAction.
RunScriptAction
(script, args=None) Bases:
ulauncher.api.shared.action.BaseAction.BaseAction
Runs a user script
Parameters: - script (str) – script content
- args (list) – arguments
-
remove_temp_file
(filename: str) → None
-
run
() Runs action