ulauncher.api.shared package¶
Subpackages¶
- ulauncher.api.shared.action package
- Submodules
- ulauncher.api.shared.action.ActionList module
- ulauncher.api.shared.action.BaseAction module
- ulauncher.api.shared.action.CopyToClipboardAction module
- ulauncher.api.shared.action.DoNothingAction module
- ulauncher.api.shared.action.ExtensionCustomAction module
- ulauncher.api.shared.action.LaunchAppAction module
- ulauncher.api.shared.action.OpenAction module
- ulauncher.api.shared.action.OpenUrlAction module
- ulauncher.api.shared.action.RenderResultListAction module
- ulauncher.api.shared.action.RunScriptAction module
- ulauncher.api.shared.action.SetUserQueryAction module
- Module contents
- ulauncher.api.shared.item package
Submodules¶
ulauncher.api.shared.Response module¶
- class ulauncher.api.shared.Response.Response(event, action)¶
Bases:
object
- Parameters:
event (BaseEvent) –
action (BaseAction) –
- action = None¶
- event = None¶
ulauncher.api.shared.event module¶
- class ulauncher.api.shared.event.BaseEvent
Bases:
object
- class ulauncher.api.shared.event.ItemEnterEvent(data)
Bases:
BaseEvent
Is triggered when selected item has action of type
ExtensionCustomAction
Whatever data you’ve passed to action will be available in in this class using methodget_data()
- Parameters:
data (str) –
- get_data()
- Returns:
whatever object you have passed to
ExtensionCustomAction
- class ulauncher.api.shared.event.KeywordQueryEvent(query)
Bases:
BaseEvent
Is triggered when user enters query that starts with your keyword + Space
- Parameters:
query (Query) –
- get_argument()
- Return type:
str
- Returns:
None if arguments were not specified
- get_keyword()
- Return type:
str
- get_query()
- Return type:
- class ulauncher.api.shared.event.PreferencesEvent(preferences)
Bases:
BaseEvent
Is triggered on start
- Parameters:
preferences (dict) –
- preferences = None
- class ulauncher.api.shared.event.PreferencesUpdateEvent(id, old_value, new_value)
Bases:
BaseEvent
Is triggered when user updates preference through Preferences window
- Parameters:
id (str) –
old_value (str) –
new_value (str) –
- id = None
- new_value = None
- old_value = None
- class ulauncher.api.shared.event.SystemExitEvent
Bases:
BaseEvent
Is triggered when extension is about to be terminated.
Your extension has 300ms to handle this event and shut down properly. After that it will be terminated with SIGKILL