Skip to content

Latest commit

 

History

History
71 lines (64 loc) · 8.89 KB

Flow.Launcher.Plugin.md

File metadata and controls

71 lines (64 loc) · 8.89 KB

Flow.Launcher.Plugin assembly

Flow.Launcher.Plugin namespace

public type description
class ActionContext Context provided as a parameter when invoking a Action or AsyncAction
class ActualApplicationThemeChangedEventArgs The event args for ActualApplicationThemeChangedEventHandler
delegate ActualApplicationThemeChangedEventHandler A delegate for when the actual application theme is changed
delegate AfterFlowLauncherQueryEventHandler Delegate for query event
static class AllowedLanguage Allowed plugin languages
class BaseModel Base model for plugin classes
class DialogJumpResult Describes a result of a Query executed by a plugin in Dialog Jump window
delegate FlowLauncherGlobalKeyboardEventHandler Global keyboard events
class FlowLauncherKeyDownEventArgs Arguments container for the Key Down event
delegate FlowLauncherKeyDownEventHandler Delegate for key down event
class FlowLauncherQueryEventArgs Arguments container for the Query event
record GlyphInfo Text with FontFamily specified
interface IAsyncDialogJump Asynchronous Dialog Jump Model
interface IAsyncExternalPreview This interface is for plugins that wish to provide file preview (external preview) via a third party app instead of the default preview.
interface IAsyncHomeQuery Asynchronous Query Model for Flow Launcher When Query Text is Empty
interface IAsyncPlugin Asynchronous Plugin Model for Flow Launcher
interface IAsyncReloadable This interface is to indicate and allow plugins to asyncronously reload their in memory data cache or other mediums when user makes a new change that is not immediately captured. For example, for BrowserBookmark and Program plugin does not automatically detect when a user added a new bookmark or program, so this interface's function is exposed to allow user manually do the reloading after those new additions. The command that allows user to manual reload is exposed via Plugin.Sys, and it will call the plugins that have implemented this interface.
interface IContextMenu Adds support for presenting additional options for a given Result from a context menu.
interface IDialogJump Synchronous Dialog Jump Model
interface IDialogJumpDialog Interface for handling file dialog instances in DialogJump.
interface IDialogJumpDialogWindow Interface for handling a specific file dialog window in DialogJump.
interface IDialogJumpDialogWindowTab Interface for handling a specific tab in a file dialog window in DialogJump.
interface IDialogJumpExplorer Interface for handling file explorer instances in DialogJump.
interface IDialogJumpExplorerWindow Interface for handling a specific file explorer window in DialogJump.
interface IFeatures Base Interface for Flow's special plugin feature interface
interface IHomeQuery Synchronous Query Model for Flow Launcher When Query Text is Empty
interface IPlugin Synchronous Plugin Model for Flow Launcher
interface IPluginI18n Represent plugins that support internationalization
interface IPublicAPI Public APIs that plugin can use
interface IReloadable This interface is to indicate and allow plugins to synchronously reload their in memory data cache or other mediums when user makes a new change that is not immediately captured. For example, for BrowserBookmark and Program plugin does not automatically detect when a user added a new bookmark or program, so this interface's function is exposed to allow user manually do the reloading after those new additions. The command that allows user to manual reload is exposed via Plugin.Sys, and it will call the plugins that have implemented this interface.
interface IResultUpdated Interface for plugins that want to manually update their results
interface ISavable Inherit this interface if you need to save additional data which is not a setting or cache, please implement this interface.
interface ISettingProvider This interface is used to create settings panel for .Net plugins
enum KeyEvent Enumeration of key events for RegisterGlobalKeyboardCallback and RemoveGlobalKeyboardCallback
class PluginInitContext Carries data passed to a plugin when it gets initialized.
class PluginMetadata Plugin metadata
class PluginPair Plugin instance and plugin metadata
class Query Represents a query that is sent to a plugin.
class Result Describes a result of a Query executed by a plugin
delegate ResultItemDropEventHandler Delegate for drop events [unused?]
class ResultUpdatedEventArgs Event arguments for the ResultsUpdated event
delegate ResultUpdatedEventHandler Delegate for the ResultsUpdated event
class SpecialKeyState Contains the press state of certain special keys.
record UserPlugin User Plugin Model for Flow Launcher
class VisibilityChangedEventArgs The event args for VisibilityChangedEventHandler
delegate VisibilityChangedEventHandler A delegate for when the visibility is changed

Flow.Launcher.Plugin.SharedCommands namespace

public type description
static class FilesFolders Commands that are useful to run on files... and folders!
static class SearchWeb Contains methods to open a search in a new browser window or tab.
static class ShellCommand Contains methods for running shell commands

Flow.Launcher.Plugin.SharedModels namespace

public type description
class MatchResult Represents the result of a match operation.
class MonitorInfo Contains full information about a display monitor. Inspired from: https://github.com/Jack251970/DesktopWidgets3.
enum SearchPrecisionScore Represents the search precision score used to filter search results.
class ThemeData Theme data model