diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands.md deleted file mode 100644 index 5351c40..0000000 --- a/API-Reference/Flow.Launcher.Plugin.SharedCommands.md +++ /dev/null @@ -1,9 +0,0 @@ -# Flow.Launcher.Plugin.SharedCommands Namesapce - -## Class - -- [FilesFolders](Flow.Launcher.Plugin.SharedCommands/filesfolders.md) - -- [SearchWeb](Flow.Launcher.Plugin.SharedCommands/searchweb.md) - -- [ShellCommand](Flow.Launcher.Plugin.SharedCommands/shellcommand.md) \ No newline at end of file diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders.md new file mode 100644 index 0000000..b6feaea --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders.md @@ -0,0 +1,26 @@ +# FilesFolders class + +```csharp +public static class FilesFolders +``` + +## Public Members + +| name | description | +| --- | --- | +| static [CopyAll](FilesFolders/CopyAll.md)(…) | Copies the folder and all of its files and folders including subfolders to the target location | +| static [FileExists](FilesFolders/FileExists.md)(…) | | +| static [GetPreviousExistingDirectory](FilesFolders/GetPreviousExistingDirectory.md)(…) | Gets the previous level directory from a path string. Checks that previous level directory exists and returns it as a path string, or empty string if doesn't exist | +| static [IsLocationPathString](FilesFolders/IsLocationPathString.md)(…) | This checks whether a given string is a directory path or network location string. It does not check if location actually exists. | +| static [LocationExists](FilesFolders/LocationExists.md)(…) | | +| static [OpenContainingFolder](FilesFolders/OpenContainingFolder.md)(…) | | +| static [OpenPath](FilesFolders/OpenPath.md)(…) | | +| static [RemoveFolderIfExists](FilesFolders/RemoveFolderIfExists.md)(…) | | +| static [ReturnPreviousDirectoryIfIncompleteString](FilesFolders/ReturnPreviousDirectoryIfIncompleteString.md)(…) | Returns the previous level directory if path incomplete (does not end with '\'). Does not check if previous level directory exists. Returns passed in string if is complete path | +| static [VerifyBothFolderFilesEqual](FilesFolders/VerifyBothFolderFilesEqual.md)(…) | | + +## See Also + +* namespace [Flow.Launcher.Plugin.SharedCommands](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/CopyAll.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/CopyAll.md new file mode 100644 index 0000000..d90ef7d --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/CopyAll.md @@ -0,0 +1,19 @@ +# FilesFolders.CopyAll method + +Copies the folder and all of its files and folders including subfolders to the target location + +```csharp +public static void CopyAll(this string sourcePath, string targetPath) +``` + +| parameter | description | +| --- | --- | +| sourcePath | | +| targetPath | | + +## See Also + +* class [FilesFolders](../FilesFolders.md) +* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/FileExists.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/FileExists.md new file mode 100644 index 0000000..8c230f1 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/FileExists.md @@ -0,0 +1,12 @@ +# FilesFolders.FileExists method + +```csharp +public static bool FileExists(this string filePath) +``` + +## See Also + +* class [FilesFolders](../FilesFolders.md) +* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/GetPreviousExistingDirectory.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/GetPreviousExistingDirectory.md new file mode 100644 index 0000000..e6a9f57 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/GetPreviousExistingDirectory.md @@ -0,0 +1,14 @@ +# FilesFolders.GetPreviousExistingDirectory method + +Gets the previous level directory from a path string. Checks that previous level directory exists and returns it as a path string, or empty string if doesn't exist + +```csharp +public static string GetPreviousExistingDirectory(Func locationExists, string path) +``` + +## See Also + +* class [FilesFolders](../FilesFolders.md) +* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/IsLocationPathString.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/IsLocationPathString.md new file mode 100644 index 0000000..ebfd586 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/IsLocationPathString.md @@ -0,0 +1,14 @@ +# FilesFolders.IsLocationPathString method + +This checks whether a given string is a directory path or network location string. It does not check if location actually exists. + +```csharp +public static bool IsLocationPathString(this string querySearchString) +``` + +## See Also + +* class [FilesFolders](../FilesFolders.md) +* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/LocationExists.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/LocationExists.md new file mode 100644 index 0000000..a597414 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/LocationExists.md @@ -0,0 +1,12 @@ +# FilesFolders.LocationExists method + +```csharp +public static bool LocationExists(this string path) +``` + +## See Also + +* class [FilesFolders](../FilesFolders.md) +* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/OpenContainingFolder.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/OpenContainingFolder.md new file mode 100644 index 0000000..3e0d8ec --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/OpenContainingFolder.md @@ -0,0 +1,12 @@ +# FilesFolders.OpenContainingFolder method + +```csharp +public static void OpenContainingFolder(string path) +``` + +## See Also + +* class [FilesFolders](../FilesFolders.md) +* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/OpenPath.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/OpenPath.md new file mode 100644 index 0000000..1f6e25f --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/OpenPath.md @@ -0,0 +1,12 @@ +# FilesFolders.OpenPath method + +```csharp +public static void OpenPath(string fileOrFolderPath) +``` + +## See Also + +* class [FilesFolders](../FilesFolders.md) +* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/RemoveFolderIfExists.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/RemoveFolderIfExists.md new file mode 100644 index 0000000..8ec39c6 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/RemoveFolderIfExists.md @@ -0,0 +1,12 @@ +# FilesFolders.RemoveFolderIfExists method + +```csharp +public static void RemoveFolderIfExists(this string path) +``` + +## See Also + +* class [FilesFolders](../FilesFolders.md) +* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/ReturnPreviousDirectoryIfIncompleteString.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/ReturnPreviousDirectoryIfIncompleteString.md new file mode 100644 index 0000000..38077db --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/ReturnPreviousDirectoryIfIncompleteString.md @@ -0,0 +1,14 @@ +# FilesFolders.ReturnPreviousDirectoryIfIncompleteString method + +Returns the previous level directory if path incomplete (does not end with '\'). Does not check if previous level directory exists. Returns passed in string if is complete path + +```csharp +public static string ReturnPreviousDirectoryIfIncompleteString(string path) +``` + +## See Also + +* class [FilesFolders](../FilesFolders.md) +* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/VerifyBothFolderFilesEqual.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/VerifyBothFolderFilesEqual.md new file mode 100644 index 0000000..85d728d --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/VerifyBothFolderFilesEqual.md @@ -0,0 +1,12 @@ +# FilesFolders.VerifyBothFolderFilesEqual method + +```csharp +public static bool VerifyBothFolderFilesEqual(this string fromPath, string toPath) +``` + +## See Also + +* class [FilesFolders](../FilesFolders.md) +* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/SearchWeb.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/SearchWeb.md new file mode 100644 index 0000000..b90faa3 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/SearchWeb.md @@ -0,0 +1,18 @@ +# SearchWeb class + +```csharp +public static class SearchWeb +``` + +## Public Members + +| name | description | +| --- | --- | +| static [OpenInBrowserTab](SearchWeb/OpenInBrowserTab.md)(…) | Opens search as a tab in the default browser chosen in Windows settings. | +| static [OpenInBrowserWindow](SearchWeb/OpenInBrowserWindow.md)(…) | Opens search in a new browser. If no browser path is passed in then Chrome is used. Leave browser path blank to use Chrome. | + +## See Also + +* namespace [Flow.Launcher.Plugin.SharedCommands](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/SearchWeb/OpenInBrowserTab.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/SearchWeb/OpenInBrowserTab.md new file mode 100644 index 0000000..b5ff252 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/SearchWeb/OpenInBrowserTab.md @@ -0,0 +1,15 @@ +# SearchWeb.OpenInBrowserTab method + +Opens search as a tab in the default browser chosen in Windows settings. + +```csharp +public static void OpenInBrowserTab(this string url, string browserPath = "", + bool inPrivate = false, string privateArg = "") +``` + +## See Also + +* class [SearchWeb](../SearchWeb.md) +* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/SearchWeb/OpenInBrowserWindow.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/SearchWeb/OpenInBrowserWindow.md new file mode 100644 index 0000000..2ebb023 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/SearchWeb/OpenInBrowserWindow.md @@ -0,0 +1,15 @@ +# SearchWeb.OpenInBrowserWindow method + +Opens search in a new browser. If no browser path is passed in then Chrome is used. Leave browser path blank to use Chrome. + +```csharp +public static void OpenInBrowserWindow(this string url, string browserPath = "", + bool inPrivate = false, string privateArg = "") +``` + +## See Also + +* class [SearchWeb](../SearchWeb.md) +* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand.EnumThreadDelegate.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand.EnumThreadDelegate.md new file mode 100644 index 0000000..7da1fa7 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand.EnumThreadDelegate.md @@ -0,0 +1,12 @@ +# ShellCommand.EnumThreadDelegate delegate + +```csharp +public delegate bool EnumThreadDelegate(IntPtr hwnd, IntPtr lParam); +``` + +## See Also + +* class [ShellCommand](./ShellCommand.md) +* namespace [Flow.Launcher.Plugin.SharedCommands](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand.md new file mode 100644 index 0000000..34c499b --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand.md @@ -0,0 +1,20 @@ +# ShellCommand class + +```csharp +public static class ShellCommand +``` + +## Public Members + +| name | description | +| --- | --- | +| static [Execute](ShellCommand/Execute.md)(…) | Runs a windows command using the provided ProcessStartInfo (2 methods) | +| static [RunAsDifferentUser](ShellCommand/RunAsDifferentUser.md)(…) | | +| static [SetProcessStartInfo](ShellCommand/SetProcessStartInfo.md)(…) | | +| delegate [EnumThreadDelegate](ShellCommand.EnumThreadDelegate.md) | | + +## See Also + +* namespace [Flow.Launcher.Plugin.SharedCommands](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand/Execute.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand/Execute.md new file mode 100644 index 0000000..56608b9 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand/Execute.md @@ -0,0 +1,47 @@ +# ShellCommand.Execute method (1 of 2) + +Runs a windows command using the provided ProcessStartInfo + +```csharp +public static void Execute(ProcessStartInfo info) +``` + +## Exceptions + +| exception | condition | +| --- | --- | +| !:FileNotFoundException | Thrown when unable to find the file specified in the command | +| !:Win32Exception | Thrown when error occurs during the execution of the command | + +## See Also + +* class [ShellCommand](../ShellCommand.md) +* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) + +--- + +# ShellCommand.Execute method (2 of 2) + +Runs a windows command using the provided ProcessStartInfo using a custom execute command function + +```csharp +public static void Execute(Func startProcess, ProcessStartInfo info) +``` + +| parameter | description | +| --- | --- | +| Func startProcessstartProcess | allows you to pass in a custom command execution function | + +## Exceptions + +| exception | condition | +| --- | --- | +| !:FileNotFoundException | Thrown when unable to find the file specified in the command | +| !:Win32Exception | Thrown when error occurs during the execution of the command | + +## See Also + +* class [ShellCommand](../ShellCommand.md) +* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand/RunAsDifferentUser.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand/RunAsDifferentUser.md new file mode 100644 index 0000000..f93757e --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand/RunAsDifferentUser.md @@ -0,0 +1,12 @@ +# ShellCommand.RunAsDifferentUser method + +```csharp +public static Process RunAsDifferentUser(ProcessStartInfo processStartInfo) +``` + +## See Also + +* class [ShellCommand](../ShellCommand.md) +* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand/SetProcessStartInfo.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand/SetProcessStartInfo.md new file mode 100644 index 0000000..58a560c --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand/SetProcessStartInfo.md @@ -0,0 +1,14 @@ +# ShellCommand.SetProcessStartInfo method + +```csharp +public static ProcessStartInfo SetProcessStartInfo(this string fileName, + string workingDirectory = "", string arguments = "", string verb = "", + bool createNoWindow = false) +``` + +## See Also + +* class [ShellCommand](../ShellCommand.md) +* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/_sidebar.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/_sidebar.md deleted file mode 100644 index 281168b..0000000 --- a/API-Reference/Flow.Launcher.Plugin.SharedCommands/_sidebar.md +++ /dev/null @@ -1,5 +0,0 @@ -- [**Flow.Launcher.Plugin.SharedCommands**](../Flow.Launcher.Plugin.SharedCommands.md) - - **Class** - - [FilesFolders](filesfolders.md) - - [SearchWeb](searchweb.md) - - [ShellCommand](shellcommand.md) \ No newline at end of file diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/filesfolders.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/filesfolders.md deleted file mode 100644 index b8ee22e..0000000 --- a/API-Reference/Flow.Launcher.Plugin.SharedCommands/filesfolders.md +++ /dev/null @@ -1,169 +0,0 @@ -# FilesFolders - -Namespace: Flow.Launcher.Plugin.SharedCommands - - - -```csharp -public static class FilesFolders -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FilesFolders](filesfolders.md) - -## Methods - -### **CopyAll(String, String)** - -Copies the folder and all of its files and folders - including subfolders to the target location - -```csharp -public static void CopyAll(string sourcePath, string targetPath) -``` - -#### Parameters - -`sourcePath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -`targetPath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **VerifyBothFolderFilesEqual(String, String)** - - - -```csharp -public static bool VerifyBothFolderFilesEqual(string fromPath, string toPath) -``` - -#### Parameters - -`fromPath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -`toPath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -#### Returns - -[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
- -### **RemoveFolderIfExists(String)** - - - -```csharp -public static void RemoveFolderIfExists(string path) -``` - -#### Parameters - -`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **LocationExists(String)** - - - -```csharp -public static bool LocationExists(string path) -``` - -#### Parameters - -`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -#### Returns - -[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
- -### **FileExists(String)** - - - -```csharp -public static bool FileExists(string filePath) -``` - -#### Parameters - -`filePath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -#### Returns - -[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
- -### **OpenPath(String)** - - - -```csharp -public static void OpenPath(string fileOrFolderPath) -``` - -#### Parameters - -`fileOrFolderPath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **OpenContainingFolder(String)** - - - -```csharp -public static void OpenContainingFolder(string path) -``` - -#### Parameters - -`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **IsLocationPathString(String)** - -This checks whether a given string is a directory path or network location string. - It does not check if location actually exists. - -```csharp -public static bool IsLocationPathString(string querySearchString) -``` - -#### Parameters - -`querySearchString` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -#### Returns - -[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
- -### **GetPreviousExistingDirectory(Func<String, Boolean>, String)** - -Gets the previous level directory from a path string. - Checks that previous level directory exists and returns it - as a path string, or empty string if doesn't exist - -```csharp -public static string GetPreviousExistingDirectory(Func locationExists, string path) -``` - -#### Parameters - -`locationExists` [Func<String, Boolean>](https://docs.microsoft.com/en-us/dotnet/api/system.func-2)
- -`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -#### Returns - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ReturnPreviousDirectoryIfIncompleteString(String)** - -Returns the previous level directory if path incomplete (does not end with '\'). - Does not check if previous level directory exists. - Returns passed in string if is complete path - -```csharp -public static string ReturnPreviousDirectoryIfIncompleteString(string path) -``` - -#### Parameters - -`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -#### Returns - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/searchweb.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/searchweb.md deleted file mode 100644 index 48dbc5c..0000000 --- a/API-Reference/Flow.Launcher.Plugin.SharedCommands/searchweb.md +++ /dev/null @@ -1,42 +0,0 @@ -# SearchWeb - -Namespace: Flow.Launcher.Plugin.SharedCommands - - - -```csharp -public static class SearchWeb -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [SearchWeb](searchweb.md) - -## Methods - -### **NewBrowserWindow(String, String)** - -Opens search in a new browser. If no browser path is passed in then Chrome is used. - Leave browser path blank to use Chrome. - -```csharp -public static void NewBrowserWindow(string url, string browserPath) -``` - -#### Parameters - -`url` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -`browserPath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **NewTabInBrowser(String, String)** - -Opens search as a tab in the default browser chosen in Windows settings. - -```csharp -public static void NewTabInBrowser(string url, string browserPath) -``` - -#### Parameters - -`url` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -`browserPath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/shellcommand.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/shellcommand.md deleted file mode 100644 index 9d97db5..0000000 --- a/API-Reference/Flow.Launcher.Plugin.SharedCommands/shellcommand.md +++ /dev/null @@ -1,51 +0,0 @@ -# ShellCommand - -Namespace: Flow.Launcher.Plugin.SharedCommands - - - -```csharp -public static class ShellCommand -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ShellCommand](shellcommand.md) - -## Methods - -### **RunAsDifferentUser(ProcessStartInfo)** - - - -```csharp -public static Process RunAsDifferentUser(ProcessStartInfo processStartInfo) -``` - -#### Parameters - -`processStartInfo` ProcessStartInfo
- -#### Returns - -Process
- -### **SetProcessStartInfo(String, String, String, String)** - - - -```csharp -public static ProcessStartInfo SetProcessStartInfo(string fileName, string workingDirectory, string arguments, string verb) -``` - -#### Parameters - -`fileName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -`workingDirectory` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -`arguments` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -`verb` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -#### Returns - -ProcessStartInfo
diff --git a/API-Reference/Flow.Launcher.Plugin.SharedModels.md b/API-Reference/Flow.Launcher.Plugin.SharedModels.md deleted file mode 100644 index ddbf723..0000000 --- a/API-Reference/Flow.Launcher.Plugin.SharedModels.md +++ /dev/null @@ -1,9 +0,0 @@ -# Flow.Launcher.Plugin.SharedModels Namespace - -## Class - -- [MatchResult](Flow.Launcher.Plugin.SharedModels/matchresult.md) - -## Enum - -- [SearchPrecisionScore](Flow.Launcher.Plugin.SharedModels/searchprecisionscore.md) \ No newline at end of file diff --git a/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult.md b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult.md new file mode 100644 index 0000000..43358d4 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult.md @@ -0,0 +1,23 @@ +# MatchResult class + +```csharp +public class MatchResult +``` + +## Public Members + +| name | description | +| --- | --- | +| [MatchResult](MatchResult/MatchResult.md)(…) | (2 constructors) | +| [MatchData](MatchResult/MatchData.md) { get; set; } | Matched data to highlight. | +| [RawScore](MatchResult/RawScore.md) { get; set; } | | +| [Score](MatchResult/Score.md) { get; } | The final score of the match result with search precision filters applied. | +| [SearchPrecision](MatchResult/SearchPrecision.md) { get; set; } | | +| [Success](MatchResult/Success.md) { get; set; } | | +| [IsSearchPrecisionScoreMet](MatchResult/IsSearchPrecisionScoreMet.md)() | | + +## See Also + +* namespace [Flow.Launcher.Plugin.SharedModels](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/IsSearchPrecisionScoreMet.md b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/IsSearchPrecisionScoreMet.md new file mode 100644 index 0000000..32843e0 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/IsSearchPrecisionScoreMet.md @@ -0,0 +1,12 @@ +# MatchResult.IsSearchPrecisionScoreMet method + +```csharp +public bool IsSearchPrecisionScoreMet() +``` + +## See Also + +* class [MatchResult](../MatchResult.md) +* namespace [Flow.Launcher.Plugin.SharedModels](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/MatchData.md b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/MatchData.md new file mode 100644 index 0000000..7aec31f --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/MatchData.md @@ -0,0 +1,14 @@ +# MatchResult.MatchData property + +Matched data to highlight. + +```csharp +public List MatchData { get; set; } +``` + +## See Also + +* class [MatchResult](../MatchResult.md) +* namespace [Flow.Launcher.Plugin.SharedModels](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/MatchResult.md b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/MatchResult.md new file mode 100644 index 0000000..02b9fe7 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/MatchResult.md @@ -0,0 +1,28 @@ +# MatchResult constructor (1 of 2) + +```csharp +public MatchResult(bool success, SearchPrecisionScore searchPrecision) +``` + +## See Also + +* enum [SearchPrecisionScore](../SearchPrecisionScore.md) +* class [MatchResult](../MatchResult.md) +* namespace [Flow.Launcher.Plugin.SharedModels](../../Flow.Launcher.Plugin.md) + +--- + +# MatchResult constructor (2 of 2) + +```csharp +public MatchResult(bool success, SearchPrecisionScore searchPrecision, List matchData, + int rawScore) +``` + +## See Also + +* enum [SearchPrecisionScore](../SearchPrecisionScore.md) +* class [MatchResult](../MatchResult.md) +* namespace [Flow.Launcher.Plugin.SharedModels](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/RawScore.md b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/RawScore.md new file mode 100644 index 0000000..4588973 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/RawScore.md @@ -0,0 +1,12 @@ +# MatchResult.RawScore property + +```csharp +public int RawScore { get; set; } +``` + +## See Also + +* class [MatchResult](../MatchResult.md) +* namespace [Flow.Launcher.Plugin.SharedModels](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/Score.md b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/Score.md new file mode 100644 index 0000000..3b45753 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/Score.md @@ -0,0 +1,14 @@ +# MatchResult.Score property + +The final score of the match result with search precision filters applied. + +```csharp +public int Score { get; } +``` + +## See Also + +* class [MatchResult](../MatchResult.md) +* namespace [Flow.Launcher.Plugin.SharedModels](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/SearchPrecision.md b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/SearchPrecision.md new file mode 100644 index 0000000..4c3e66b --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/SearchPrecision.md @@ -0,0 +1,13 @@ +# MatchResult.SearchPrecision property + +```csharp +public SearchPrecisionScore SearchPrecision { get; set; } +``` + +## See Also + +* enum [SearchPrecisionScore](../SearchPrecisionScore.md) +* class [MatchResult](../MatchResult.md) +* namespace [Flow.Launcher.Plugin.SharedModels](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/Success.md b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/Success.md new file mode 100644 index 0000000..ab9b3d3 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/Success.md @@ -0,0 +1,12 @@ +# MatchResult.Success property + +```csharp +public bool Success { get; set; } +``` + +## See Also + +* class [MatchResult](../MatchResult.md) +* namespace [Flow.Launcher.Plugin.SharedModels](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedModels/SearchPrecisionScore.md b/API-Reference/Flow.Launcher.Plugin.SharedModels/SearchPrecisionScore.md new file mode 100644 index 0000000..85ebdb7 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedModels/SearchPrecisionScore.md @@ -0,0 +1,19 @@ +# SearchPrecisionScore enumeration + +```csharp +public enum SearchPrecisionScore +``` + +## Values + +| name | value | description | +| --- | --- | --- | +| Regular | `50` | | +| Low | `20` | | +| None | `0` | | + +## See Also + +* namespace [Flow.Launcher.Plugin.SharedModels](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedModels/_sidebar.md b/API-Reference/Flow.Launcher.Plugin.SharedModels/_sidebar.md deleted file mode 100644 index 56d8b04..0000000 --- a/API-Reference/Flow.Launcher.Plugin.SharedModels/_sidebar.md +++ /dev/null @@ -1,5 +0,0 @@ -- [**Flow.Launcher.Plugin.SharedModels**](../Flow.Launcher.Plugin.SharedModels.md) - - **Class** - - [MatchResult](matchresult.md) - - **Enum** - - [SearchPrecisionScore](searchprecisionscore.md) \ No newline at end of file diff --git a/API-Reference/Flow.Launcher.Plugin.SharedModels/matchresult.md b/API-Reference/Flow.Launcher.Plugin.SharedModels/matchresult.md deleted file mode 100644 index 10a2ea2..0000000 --- a/API-Reference/Flow.Launcher.Plugin.SharedModels/matchresult.md +++ /dev/null @@ -1,121 +0,0 @@ -# MatchResult - -Namespace: Flow.Launcher.Plugin.SharedModels - - - -```csharp -public class MatchResult -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [MatchResult](matchresult.md) - -## Properties - -### **Success** - - - -```csharp -public bool Success { get; set; } -``` - -#### Property Value - -[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
- -### **Score** - -The final score of the match result with search precision filters applied. - -```csharp -public int Score { get; private set; } -``` - -#### Property Value - -[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
- -### **RawScore** - - - -```csharp -public int RawScore { get; set; } -``` - -#### Property Value - -[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
- -### **MatchData** - -Matched data to highlight. - -```csharp -public List MatchData { get; set; } -``` - -#### Property Value - -[List<Int32>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.list-1)
- -### **SearchPrecision** - - - -```csharp -public SearchPrecisionScore SearchPrecision { get; set; } -``` - -#### Property Value - -[SearchPrecisionScore](sharedmodels.searchprecisionscore.md)
- -## Constructors - -### **MatchResult(Boolean, SearchPrecisionScore)** - - - -```csharp -public MatchResult(bool success, SearchPrecisionScore searchPrecision) -``` - -#### Parameters - -`success` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
- -`searchPrecision` [SearchPrecisionScore](sharedmodels.searchprecisionscore.md)
- -### **MatchResult(Boolean, SearchPrecisionScore, List<Int32>, Int32)** - - - -```csharp -public MatchResult(bool success, SearchPrecisionScore searchPrecision, List matchData, int rawScore) -``` - -#### Parameters - -`success` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
- -`searchPrecision` [SearchPrecisionScore](sharedmodels.searchprecisionscore.md)
- -`matchData` [List<Int32>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.list-1)
- -`rawScore` [Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
- -## Methods - -### **IsSearchPrecisionScoreMet()** - - - -```csharp -public bool IsSearchPrecisionScoreMet() -``` - -#### Returns - -[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
diff --git a/API-Reference/Flow.Launcher.Plugin.SharedModels/searchprecisionscore.md b/API-Reference/Flow.Launcher.Plugin.SharedModels/searchprecisionscore.md deleted file mode 100644 index f9376e7..0000000 --- a/API-Reference/Flow.Launcher.Plugin.SharedModels/searchprecisionscore.md +++ /dev/null @@ -1,23 +0,0 @@ -# SearchPrecisionScore - -Namespace: Flow.Launcher.Plugin.SharedModels - -```c# -public enum SearchPrecisionScore -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ValueType](https://docs.microsoft.com/en-us/dotnet/api/system.valuetype) -> [Enum](https://docs.microsoft.com/en-us/dotnet/api/system.enum)-> [SearchPrecisionScore](searchprecisionscore.md) - -## Field - -### Regular - -Value: 50 - -### Low - -Value: 20 - -### None - -Value: 0 \ No newline at end of file diff --git a/API-Reference/Flow.Launcher.Plugin.md b/API-Reference/Flow.Launcher.Plugin.md index 59dce03..d0d7f50 100644 --- a/API-Reference/Flow.Launcher.Plugin.md +++ b/API-Reference/Flow.Launcher.Plugin.md @@ -1,52 +1,52 @@ -# Flow.Launcher.Plugin Namespace - -## Class - -- [ActionContext](Flow.Launcher.Plugin/actioncontext.md) - -- [AllowedLanguage](Flow.Launcher.Plugin/allowedlanguage.md) - -- [BaseModel](Flow.Launcher.Plugin/basemodel.md) - -- [FlowLauncherKeyDownEventArgs](Flow.Launcher.Plugin/flowlauncherkeydowneventargs.md) - -- [FlowLauncherQueryEventArgs](Flow.Launcher.Plugin/flowlauncherqueryeventargs.md) - -- [PluginInitContext](Flow.Launcher.Plugin/plugininitcontext.md) - -- [PluginMetadata](Flow.Launcher.Plugin/pluginmetadata.md) - -- [PluginPair](Flow.Launcher.Plugin/pluginpair.md) - -- [Query](Flow.Launcher.Plugin/query.md) - -- [Result](Flow.Launcher.Plugin/result.md) - -- [ResultUpdatedEventArgs](Flow.Launcher.Plugin/resultupdatedeventargs.md) - -- [SpecialKeyState](Flow.Launcher.Plugin/specialkeystate.md) - - -## Interface - -- [IAsyncPlugin](Flow.Launcher.Plugin/iasyncplugin.md) - -- [IAsyncReloadable](Flow.Launcher.Plugin/iasyncreloadable.md) - -- [IContextMenu](Flow.Launcher.Plugin/icontextmenu.md) - -- [IFeatures](Flow.Launcher.Plugin/ifeatures.md) - -- [IPlugin](Flow.Launcher.Plugin/iplugin.md) - -- [IPluginI18n](Flow.Launcher.Plugin/iplugini18n.md) - -- [IPublicAPI](Flow.Launcher.Plugin/ipublicapi.md) - -- [IReloadable](Flow.Launcher.Plugin/ireloadable.md) - -- [IResultUpdated](Flow.Launcher.Plugin/iresultupdated.md) - -- [ISavable](Flow.Launcher.Plugin/isavable.md) - -- [ISettingProvider](Flow.Launcher.Plugin/isettingprovider.md) \ No newline at end of file +# Flow.Launcher.Plugin assembly + +## Flow.Launcher.Plugin namespace + +| public type | description | +| --- | --- | +| class [ActionContext](./Flow.Launcher.Plugin/ActionContext.md) | | +| delegate [AfterFlowLauncherQueryEventHandler](./Flow.Launcher.Plugin/AfterFlowLauncherQueryEventHandler.md) | | +| static class [AllowedLanguage](./Flow.Launcher.Plugin/AllowedLanguage.md) | | +| class [BaseModel](./Flow.Launcher.Plugin/BaseModel.md) | | +| delegate [FlowLauncherGlobalKeyboardEventHandler](./Flow.Launcher.Plugin/FlowLauncherGlobalKeyboardEventHandler.md) | Global keyboard events | +| class [FlowLauncherKeyDownEventArgs](./Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs.md) | | +| delegate [FlowLauncherKeyDownEventHandler](./Flow.Launcher.Plugin/FlowLauncherKeyDownEventHandler.md) | | +| class [FlowLauncherQueryEventArgs](./Flow.Launcher.Plugin/FlowLauncherQueryEventArgs.md) | | +| record [GlyphInfo](./Flow.Launcher.Plugin/GlyphInfo.md) | Text with FontFamily specified | +| interface [IAsyncPlugin](./Flow.Launcher.Plugin/IAsyncPlugin.md) | Asynchronous Plugin Model for Flow Launcher | +| interface [IAsyncReloadable](./Flow.Launcher.Plugin/IAsyncReloadable.md) | 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](./Flow.Launcher.Plugin/IContextMenu.md) | | +| interface [IFeatures](./Flow.Launcher.Plugin/IFeatures.md) | Base Interface for Flow's special plugin feature interface | +| interface [IPlugin](./Flow.Launcher.Plugin/IPlugin.md) | Synchronous Plugin Model for Flow Launcher | +| interface [IPluginI18n](./Flow.Launcher.Plugin/IPluginI18n.md) | Represent plugins that support internationalization | +| interface [IPublicAPI](./Flow.Launcher.Plugin/IPublicAPI.md) | Public APIs that plugin can use | +| interface [IReloadable](./Flow.Launcher.Plugin/IReloadable.md) | 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](./Flow.Launcher.Plugin/IResultUpdated.md) | | +| interface [ISavable](./Flow.Launcher.Plugin/ISavable.md) | Save addtional plugin data. Inherit this interface if additional data e.g. cache needs to be saved, Otherwise if LoadSettingJsonStorage or SaveSettingJsonStorage has been callded, plugin settings will be automatically saved (see Flow.Launcher/PublicAPIInstance.SavePluginSettings) by Flow | +| interface [ISettingProvider](./Flow.Launcher.Plugin/ISettingProvider.md) | | +| class [PluginInitContext](./Flow.Launcher.Plugin/PluginInitContext.md) | | +| class [PluginMetadata](./Flow.Launcher.Plugin/PluginMetadata.md) | | +| class [PluginPair](./Flow.Launcher.Plugin/PluginPair.md) | | +| class [Query](./Flow.Launcher.Plugin/Query.md) | | +| class [Result](./Flow.Launcher.Plugin/Result.md) | | +| delegate [ResultItemDropEventHandler](./Flow.Launcher.Plugin/ResultItemDropEventHandler.md) | | +| class [ResultUpdatedEventArgs](./Flow.Launcher.Plugin/ResultUpdatedEventArgs.md) | | +| delegate [ResultUpdatedEventHandler](./Flow.Launcher.Plugin/ResultUpdatedEventHandler.md) | | +| class [SpecialKeyState](./Flow.Launcher.Plugin/SpecialKeyState.md) | | + +## Flow.Launcher.Plugin.SharedCommands namespace + +| public type | description | +| --- | --- | +| static class [FilesFolders](./Flow.Launcher.Plugin.SharedCommands/FilesFolders.md) | | +| static class [SearchWeb](./Flow.Launcher.Plugin.SharedCommands/SearchWeb.md) | | +| static class [ShellCommand](./Flow.Launcher.Plugin.SharedCommands/ShellCommand.md) | | + +## Flow.Launcher.Plugin.SharedModels namespace + +| public type | description | +| --- | --- | +| class [MatchResult](./Flow.Launcher.Plugin.SharedModels/MatchResult.md) | | +| enum [SearchPrecisionScore](./Flow.Launcher.Plugin.SharedModels/SearchPrecisionScore.md) | | + + diff --git a/API-Reference/Flow.Launcher.Plugin/ActionContext.md b/API-Reference/Flow.Launcher.Plugin/ActionContext.md new file mode 100644 index 0000000..3bdbee3 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/ActionContext.md @@ -0,0 +1,18 @@ +# ActionContext class + +```csharp +public class ActionContext +``` + +## Public Members + +| name | description | +| --- | --- | +| [ActionContext](ActionContext/ActionContext.md)() | The default constructor. | +| [SpecialKeyState](ActionContext/SpecialKeyState.md) { get; set; } | | + +## See Also + +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/ActionContext/ActionContext.md b/API-Reference/Flow.Launcher.Plugin/ActionContext/ActionContext.md new file mode 100644 index 0000000..0883609 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/ActionContext/ActionContext.md @@ -0,0 +1,14 @@ +# ActionContext constructor + +The default constructor. + +```csharp +public ActionContext() +``` + +## See Also + +* class [ActionContext](../ActionContext.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/ActionContext/SpecialKeyState.md b/API-Reference/Flow.Launcher.Plugin/ActionContext/SpecialKeyState.md new file mode 100644 index 0000000..abb0e86 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/ActionContext/SpecialKeyState.md @@ -0,0 +1,13 @@ +# ActionContext.SpecialKeyState property + +```csharp +public SpecialKeyState SpecialKeyState { get; set; } +``` + +## See Also + +* class [SpecialKeyState](../SpecialKeyState.md) +* class [ActionContext](../ActionContext.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/AfterFlowLauncherQueryEventHandler.md b/API-Reference/Flow.Launcher.Plugin/AfterFlowLauncherQueryEventHandler.md new file mode 100644 index 0000000..03ea3c1 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/AfterFlowLauncherQueryEventHandler.md @@ -0,0 +1,12 @@ +# AfterFlowLauncherQueryEventHandler delegate + +```csharp +public delegate void AfterFlowLauncherQueryEventHandler(FlowLauncherQueryEventArgs e); +``` + +## See Also + +* class [FlowLauncherQueryEventArgs](./FlowLauncherQueryEventArgs.md) +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/AllowedLanguage.md b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage.md new file mode 100644 index 0000000..09ef0ad --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage.md @@ -0,0 +1,22 @@ +# AllowedLanguage class + +```csharp +public static class AllowedLanguage +``` + +## Public Members + +| name | description | +| --- | --- | +| static [CSharp](AllowedLanguage/CSharp.md) { get; } | | +| static [Executable](AllowedLanguage/Executable.md) { get; } | | +| static [FSharp](AllowedLanguage/FSharp.md) { get; } | | +| static [Python](AllowedLanguage/Python.md) { get; } | | +| static [IsAllowed](AllowedLanguage/IsAllowed.md)(…) | | +| static [IsDotNet](AllowedLanguage/IsDotNet.md)(…) | | + +## See Also + +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/CSharp.md b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/CSharp.md new file mode 100644 index 0000000..ad1e22d --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/CSharp.md @@ -0,0 +1,12 @@ +# AllowedLanguage.CSharp property + +```csharp +public static string CSharp { get; } +``` + +## See Also + +* class [AllowedLanguage](../AllowedLanguage.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/Executable.md b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/Executable.md new file mode 100644 index 0000000..ecabc9b --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/Executable.md @@ -0,0 +1,12 @@ +# AllowedLanguage.Executable property + +```csharp +public static string Executable { get; } +``` + +## See Also + +* class [AllowedLanguage](../AllowedLanguage.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/FSharp.md b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/FSharp.md new file mode 100644 index 0000000..bc824e7 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/FSharp.md @@ -0,0 +1,12 @@ +# AllowedLanguage.FSharp property + +```csharp +public static string FSharp { get; } +``` + +## See Also + +* class [AllowedLanguage](../AllowedLanguage.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/IsAllowed.md b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/IsAllowed.md new file mode 100644 index 0000000..cad347c --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/IsAllowed.md @@ -0,0 +1,12 @@ +# AllowedLanguage.IsAllowed method + +```csharp +public static bool IsAllowed(string language) +``` + +## See Also + +* class [AllowedLanguage](../AllowedLanguage.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/IsDotNet.md b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/IsDotNet.md new file mode 100644 index 0000000..e8d9c68 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/IsDotNet.md @@ -0,0 +1,12 @@ +# AllowedLanguage.IsDotNet method + +```csharp +public static bool IsDotNet(string language) +``` + +## See Also + +* class [AllowedLanguage](../AllowedLanguage.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/Python.md b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/Python.md new file mode 100644 index 0000000..0bcbbff --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/Python.md @@ -0,0 +1,12 @@ +# AllowedLanguage.Python property + +```csharp +public static string Python { get; } +``` + +## See Also + +* class [AllowedLanguage](../AllowedLanguage.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/BaseModel.md b/API-Reference/Flow.Launcher.Plugin/BaseModel.md new file mode 100644 index 0000000..fc8b9cd --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/BaseModel.md @@ -0,0 +1,24 @@ +# BaseModel class + +```csharp +public class BaseModel : INotifyPropertyChanged +``` + +## Public Members + +| name | description | +| --- | --- | +| [BaseModel](BaseModel/BaseModel.md)() | The default constructor. | +| event [PropertyChanged](BaseModel/PropertyChanged.md) | | + +## Protected Members + +| name | description | +| --- | --- | +| [OnPropertyChanged](BaseModel/OnPropertyChanged.md)(…) | | + +## See Also + +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/BaseModel/BaseModel.md b/API-Reference/Flow.Launcher.Plugin/BaseModel/BaseModel.md new file mode 100644 index 0000000..5fc05ef --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/BaseModel/BaseModel.md @@ -0,0 +1,14 @@ +# BaseModel constructor + +The default constructor. + +```csharp +public BaseModel() +``` + +## See Also + +* class [BaseModel](../BaseModel.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/BaseModel/OnPropertyChanged.md b/API-Reference/Flow.Launcher.Plugin/BaseModel/OnPropertyChanged.md new file mode 100644 index 0000000..05c1f30 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/BaseModel/OnPropertyChanged.md @@ -0,0 +1,12 @@ +# BaseModel.OnPropertyChanged method + +```csharp +protected void OnPropertyChanged([CallerMemberName] string propertyName = null) +``` + +## See Also + +* class [BaseModel](../BaseModel.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/BaseModel/PropertyChanged.md b/API-Reference/Flow.Launcher.Plugin/BaseModel/PropertyChanged.md new file mode 100644 index 0000000..abdcb7f --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/BaseModel/PropertyChanged.md @@ -0,0 +1,12 @@ +# BaseModel.PropertyChanged event + +```csharp +public event PropertyChangedEventHandler PropertyChanged; +``` + +## See Also + +* class [BaseModel](../BaseModel.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/FlowLauncherGlobalKeyboardEventHandler.md b/API-Reference/Flow.Launcher.Plugin/FlowLauncherGlobalKeyboardEventHandler.md new file mode 100644 index 0000000..e78cb95 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/FlowLauncherGlobalKeyboardEventHandler.md @@ -0,0 +1,25 @@ +# FlowLauncherGlobalKeyboardEventHandler delegate + +Global keyboard events + +```csharp +public delegate bool FlowLauncherGlobalKeyboardEventHandler(int keyevent, int vkcode, + SpecialKeyState state); +``` + +| parameter | description | +| --- | --- | +| keyevent | WM_KEYDOWN = 256,WM_KEYUP = 257,WM_SYSKEYUP = 261,WM_SYSKEYDOWN = 260 | +| vkcode | | +| state | | + +## Return Value + +return true to continue handling, return false to intercept system handling + +## See Also + +* class [SpecialKeyState](./SpecialKeyState.md) +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs.md b/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs.md new file mode 100644 index 0000000..3ad0121 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs.md @@ -0,0 +1,19 @@ +# FlowLauncherKeyDownEventArgs class + +```csharp +public class FlowLauncherKeyDownEventArgs +``` + +## Public Members + +| name | description | +| --- | --- | +| [FlowLauncherKeyDownEventArgs](FlowLauncherKeyDownEventArgs/FlowLauncherKeyDownEventArgs.md)() | The default constructor. | +| [keyEventArgs](FlowLauncherKeyDownEventArgs/keyEventArgs.md) { get; set; } | | +| [Query](FlowLauncherKeyDownEventArgs/Query.md) { get; set; } | | + +## See Also + +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs/FlowLauncherKeyDownEventArgs.md b/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs/FlowLauncherKeyDownEventArgs.md new file mode 100644 index 0000000..5a45404 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs/FlowLauncherKeyDownEventArgs.md @@ -0,0 +1,14 @@ +# FlowLauncherKeyDownEventArgs constructor + +The default constructor. + +```csharp +public FlowLauncherKeyDownEventArgs() +``` + +## See Also + +* class [FlowLauncherKeyDownEventArgs](../FlowLauncherKeyDownEventArgs.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs/Query.md b/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs/Query.md new file mode 100644 index 0000000..4be61a5 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs/Query.md @@ -0,0 +1,12 @@ +# FlowLauncherKeyDownEventArgs.Query property + +```csharp +public string Query { get; set; } +``` + +## See Also + +* class [FlowLauncherKeyDownEventArgs](../FlowLauncherKeyDownEventArgs.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs/keyEventArgs.md b/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs/keyEventArgs.md new file mode 100644 index 0000000..4dc13c6 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs/keyEventArgs.md @@ -0,0 +1,12 @@ +# FlowLauncherKeyDownEventArgs.keyEventArgs property + +```csharp +public KeyEventArgs keyEventArgs { get; set; } +``` + +## See Also + +* class [FlowLauncherKeyDownEventArgs](../FlowLauncherKeyDownEventArgs.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventHandler.md b/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventHandler.md new file mode 100644 index 0000000..e5c9aa6 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventHandler.md @@ -0,0 +1,12 @@ +# FlowLauncherKeyDownEventHandler delegate + +```csharp +public delegate void FlowLauncherKeyDownEventHandler(FlowLauncherKeyDownEventArgs e); +``` + +## See Also + +* class [FlowLauncherKeyDownEventArgs](./FlowLauncherKeyDownEventArgs.md) +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/FlowLauncherQueryEventArgs.md b/API-Reference/Flow.Launcher.Plugin/FlowLauncherQueryEventArgs.md new file mode 100644 index 0000000..4af8369 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/FlowLauncherQueryEventArgs.md @@ -0,0 +1,18 @@ +# FlowLauncherQueryEventArgs class + +```csharp +public class FlowLauncherQueryEventArgs +``` + +## Public Members + +| name | description | +| --- | --- | +| [FlowLauncherQueryEventArgs](FlowLauncherQueryEventArgs/FlowLauncherQueryEventArgs.md)() | The default constructor. | +| [Query](FlowLauncherQueryEventArgs/Query.md) { get; set; } | | + +## See Also + +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/FlowLauncherQueryEventArgs/FlowLauncherQueryEventArgs.md b/API-Reference/Flow.Launcher.Plugin/FlowLauncherQueryEventArgs/FlowLauncherQueryEventArgs.md new file mode 100644 index 0000000..4146442 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/FlowLauncherQueryEventArgs/FlowLauncherQueryEventArgs.md @@ -0,0 +1,14 @@ +# FlowLauncherQueryEventArgs constructor + +The default constructor. + +```csharp +public FlowLauncherQueryEventArgs() +``` + +## See Also + +* class [FlowLauncherQueryEventArgs](../FlowLauncherQueryEventArgs.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/FlowLauncherQueryEventArgs/Query.md b/API-Reference/Flow.Launcher.Plugin/FlowLauncherQueryEventArgs/Query.md new file mode 100644 index 0000000..3b637d8 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/FlowLauncherQueryEventArgs/Query.md @@ -0,0 +1,13 @@ +# FlowLauncherQueryEventArgs.Query property + +```csharp +public Query Query { get; set; } +``` + +## See Also + +* class [Query](../Query.md) +* class [FlowLauncherQueryEventArgs](../FlowLauncherQueryEventArgs.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/GlyphInfo.md b/API-Reference/Flow.Launcher.Plugin/GlyphInfo.md new file mode 100644 index 0000000..820fafc --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/GlyphInfo.md @@ -0,0 +1,21 @@ +# GlyphInfo record + +Text with FontFamily specified + +```csharp +public record GlyphInfo +``` + +## Public Members + +| name | description | +| --- | --- | +| [GlyphInfo](GlyphInfo/GlyphInfo.md)(…) | Text with FontFamily specified | +| [FontFamily](GlyphInfo/FontFamily.md) { get; set; } | | +| [Glyph](GlyphInfo/Glyph.md) { get; set; } | | + +## See Also + +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/GlyphInfo/FontFamily.md b/API-Reference/Flow.Launcher.Plugin/GlyphInfo/FontFamily.md new file mode 100644 index 0000000..ab898d0 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/GlyphInfo/FontFamily.md @@ -0,0 +1,12 @@ +# GlyphInfo.FontFamily property + +```csharp +public string FontFamily { get; set; } +``` + +## See Also + +* record [GlyphInfo](../GlyphInfo.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/GlyphInfo/Glyph.md b/API-Reference/Flow.Launcher.Plugin/GlyphInfo/Glyph.md new file mode 100644 index 0000000..1920755 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/GlyphInfo/Glyph.md @@ -0,0 +1,12 @@ +# GlyphInfo.Glyph property + +```csharp +public string Glyph { get; set; } +``` + +## See Also + +* record [GlyphInfo](../GlyphInfo.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/GlyphInfo/GlyphInfo.md b/API-Reference/Flow.Launcher.Plugin/GlyphInfo/GlyphInfo.md new file mode 100644 index 0000000..ec689d8 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/GlyphInfo/GlyphInfo.md @@ -0,0 +1,19 @@ +# GlyphInfo constructor + +Text with FontFamily specified + +```csharp +public GlyphInfo(string FontFamily, string Glyph) +``` + +| parameter | description | +| --- | --- | +| FontFamily | Font Family of this Glyph | +| Glyph | Text/Unicode of the Glyph | + +## See Also + +* record [GlyphInfo](../GlyphInfo.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IAsyncPlugin.md b/API-Reference/Flow.Launcher.Plugin/IAsyncPlugin.md new file mode 100644 index 0000000..2b91e68 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IAsyncPlugin.md @@ -0,0 +1,20 @@ +# IAsyncPlugin interface + +Asynchronous Plugin Model for Flow Launcher + +```csharp +public interface IAsyncPlugin +``` + +## Members + +| name | description | +| --- | --- | +| [InitAsync](IAsyncPlugin/InitAsync.md)(…) | Initialize plugin asynchrously (will still wait finish to continue) | +| [QueryAsync](IAsyncPlugin/QueryAsync.md)(…) | Asynchronous Querying | + +## See Also + +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IAsyncPlugin/InitAsync.md b/API-Reference/Flow.Launcher.Plugin/IAsyncPlugin/InitAsync.md new file mode 100644 index 0000000..a7852b8 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IAsyncPlugin/InitAsync.md @@ -0,0 +1,19 @@ +# IAsyncPlugin.InitAsync method + +Initialize plugin asynchrously (will still wait finish to continue) + +```csharp +public Task InitAsync(PluginInitContext context) +``` + +| parameter | description | +| --- | --- | +| context | | + +## See Also + +* class [PluginInitContext](../PluginInitContext.md) +* interface [IAsyncPlugin](../IAsyncPlugin.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IAsyncPlugin/QueryAsync.md b/API-Reference/Flow.Launcher.Plugin/IAsyncPlugin/QueryAsync.md new file mode 100644 index 0000000..d9838eb --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IAsyncPlugin/QueryAsync.md @@ -0,0 +1,21 @@ +# IAsyncPlugin.QueryAsync method + +Asynchronous Querying + +```csharp +public Task> QueryAsync(Query query, CancellationToken token) +``` + +| parameter | description | +| --- | --- | +| query | Query to search | +| token | Cancel when querying job is obsolete | + +## See Also + +* class [Result](../Result.md) +* class [Query](../Query.md) +* interface [IAsyncPlugin](../IAsyncPlugin.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IAsyncReloadable.md b/API-Reference/Flow.Launcher.Plugin/IAsyncReloadable.md new file mode 100644 index 0000000..c666109 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IAsyncReloadable.md @@ -0,0 +1,20 @@ +# IAsyncReloadable interface + +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. + +```csharp +public interface IAsyncReloadable : IFeatures +``` + +## Members + +| name | description | +| --- | --- | +| [ReloadDataAsync](IAsyncReloadable/ReloadDataAsync.md)() | | + +## See Also + +* interface [IFeatures](./IFeatures.md) +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IAsyncReloadable/ReloadDataAsync.md b/API-Reference/Flow.Launcher.Plugin/IAsyncReloadable/ReloadDataAsync.md new file mode 100644 index 0000000..fcf48f1 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IAsyncReloadable/ReloadDataAsync.md @@ -0,0 +1,12 @@ +# IAsyncReloadable.ReloadDataAsync method + +```csharp +public Task ReloadDataAsync() +``` + +## See Also + +* interface [IAsyncReloadable](../IAsyncReloadable.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IContextMenu.md b/API-Reference/Flow.Launcher.Plugin/IContextMenu.md new file mode 100644 index 0000000..8d73421 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IContextMenu.md @@ -0,0 +1,18 @@ +# IContextMenu interface + +```csharp +public interface IContextMenu : IFeatures +``` + +## Members + +| name | description | +| --- | --- | +| [LoadContextMenus](IContextMenu/LoadContextMenus.md)(…) | | + +## See Also + +* interface [IFeatures](./IFeatures.md) +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IContextMenu/LoadContextMenus.md b/API-Reference/Flow.Launcher.Plugin/IContextMenu/LoadContextMenus.md new file mode 100644 index 0000000..718fcb8 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IContextMenu/LoadContextMenus.md @@ -0,0 +1,13 @@ +# IContextMenu.LoadContextMenus method + +```csharp +public List LoadContextMenus(Result selectedResult) +``` + +## See Also + +* class [Result](../Result.md) +* interface [IContextMenu](../IContextMenu.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IFeatures.md b/API-Reference/Flow.Launcher.Plugin/IFeatures.md new file mode 100644 index 0000000..b6f56ce --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IFeatures.md @@ -0,0 +1,13 @@ +# IFeatures interface + +Base Interface for Flow's special plugin feature interface + +```csharp +public interface IFeatures +``` + +## See Also + +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPlugin.md b/API-Reference/Flow.Launcher.Plugin/IPlugin.md new file mode 100644 index 0000000..2309e26 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPlugin.md @@ -0,0 +1,23 @@ +# IPlugin interface + +Synchronous Plugin Model for Flow Launcher + +If the Querying or Init method requires high IO transmission or performaing CPU intense jobs (performing better with cancellation), please try the IAsyncPlugin interface + +```csharp +public interface IPlugin : IAsyncPlugin +``` + +## Members + +| name | description | +| --- | --- | +| [Init](IPlugin/Init.md)(…) | Initialize plugin | +| [Query](IPlugin/Query.md)(…) | Querying when user's search changes | + +## See Also + +* interface [IAsyncPlugin](./IAsyncPlugin.md) +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPlugin/Init.md b/API-Reference/Flow.Launcher.Plugin/IPlugin/Init.md new file mode 100644 index 0000000..79000e0 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPlugin/Init.md @@ -0,0 +1,19 @@ +# IPlugin.Init method + +Initialize plugin + +```csharp +public void Init(PluginInitContext context) +``` + +| parameter | description | +| --- | --- | +| context | | + +## See Also + +* class [PluginInitContext](../PluginInitContext.md) +* interface [IPlugin](../IPlugin.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPlugin/Query.md b/API-Reference/Flow.Launcher.Plugin/IPlugin/Query.md new file mode 100644 index 0000000..f061488 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPlugin/Query.md @@ -0,0 +1,22 @@ +# IPlugin.Query method + +Querying when user's search changes + +This method will be called within a Task.Run, so please avoid synchrously wait for long. + +```csharp +public List Query(Query query) +``` + +| parameter | description | +| --- | --- | +| query | Query to search | + +## See Also + +* class [Result](../Result.md) +* class [Query](../Query.md) +* interface [IPlugin](../IPlugin.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPluginI18n.md b/API-Reference/Flow.Launcher.Plugin/IPluginI18n.md new file mode 100644 index 0000000..aaee16c --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPluginI18n.md @@ -0,0 +1,22 @@ +# IPluginI18n interface + +Represent plugins that support internationalization + +```csharp +public interface IPluginI18n : IFeatures +``` + +## Members + +| name | description | +| --- | --- | +| [GetTranslatedPluginDescription](IPluginI18n/GetTranslatedPluginDescription.md)() | | +| [GetTranslatedPluginTitle](IPluginI18n/GetTranslatedPluginTitle.md)() | | +| [OnCultureInfoChanged](IPluginI18n/OnCultureInfoChanged.md)(…) | The method will be invoked when language of flow changed | + +## See Also + +* interface [IFeatures](./IFeatures.md) +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPluginI18n/GetTranslatedPluginDescription.md b/API-Reference/Flow.Launcher.Plugin/IPluginI18n/GetTranslatedPluginDescription.md new file mode 100644 index 0000000..b42b2dc --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPluginI18n/GetTranslatedPluginDescription.md @@ -0,0 +1,12 @@ +# IPluginI18n.GetTranslatedPluginDescription method + +```csharp +public string GetTranslatedPluginDescription() +``` + +## See Also + +* interface [IPluginI18n](../IPluginI18n.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPluginI18n/GetTranslatedPluginTitle.md b/API-Reference/Flow.Launcher.Plugin/IPluginI18n/GetTranslatedPluginTitle.md new file mode 100644 index 0000000..ed8a50e --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPluginI18n/GetTranslatedPluginTitle.md @@ -0,0 +1,12 @@ +# IPluginI18n.GetTranslatedPluginTitle method + +```csharp +public string GetTranslatedPluginTitle() +``` + +## See Also + +* interface [IPluginI18n](../IPluginI18n.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPluginI18n/OnCultureInfoChanged.md b/API-Reference/Flow.Launcher.Plugin/IPluginI18n/OnCultureInfoChanged.md new file mode 100644 index 0000000..fc587de --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPluginI18n/OnCultureInfoChanged.md @@ -0,0 +1,14 @@ +# IPluginI18n.OnCultureInfoChanged method + +The method will be invoked when language of flow changed + +```csharp +public void OnCultureInfoChanged(CultureInfo newCulture) +``` + +## See Also + +* interface [IPluginI18n](../IPluginI18n.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI.md new file mode 100644 index 0000000..15472e2 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI.md @@ -0,0 +1,48 @@ +# IPublicAPI interface + +Public APIs that plugin can use + +```csharp +public interface IPublicAPI +``` + +## Members + +| name | description | +| --- | --- | +| [AddActionKeyword](IPublicAPI/AddActionKeyword.md)(…) | Add ActionKeyword for specific plugin | +| [ChangeQuery](IPublicAPI/ChangeQuery.md)(…) | Change Flow.Launcher query | +| [CheckForNewUpdate](IPublicAPI/CheckForNewUpdate.md)() | Check for new Flow Launcher update | +| [CopyToClipboard](IPublicAPI/CopyToClipboard.md)(…) | Copy Text to clipboard | +| [FuzzySearch](IPublicAPI/FuzzySearch.md)(…) | Fuzzy Search the string with the given query. This is the core search mechanism Flow uses | +| [GetAllPlugins](IPublicAPI/GetAllPlugins.md)() | Get all loaded plugins | +| [GetTranslation](IPublicAPI/GetTranslation.md)(…) | Get translation of current language You need to implement IPluginI18n if you want to support multiple languages for your plugin | +| [HttpDownloadAsync](IPublicAPI/HttpDownloadAsync.md)(…) | Download the specific url to a cretain file path | +| [HttpGetStreamAsync](IPublicAPI/HttpGetStreamAsync.md)(…) | Http download the spefic url and return as stream | +| [HttpGetStringAsync](IPublicAPI/HttpGetStringAsync.md)(…) | Http download the spefic url and return as string | +| [LoadSettingJsonStorage<T>](IPublicAPI/LoadSettingJsonStorage.md)() | Load JsonStorage for current plugin's setting. This is the method used to load settings from json in Flow. When the file is not exist, it will create a new instance for the specific type. | +| [LogDebug](IPublicAPI/LogDebug.md)(…) | Log debug message Message will only be logged in Debug mode | +| [LogException](IPublicAPI/LogException.md)(…) | Log an Exception. Will throw if in debug mode so developer will be aware, otherwise logs the eror message. This is the primary logging method used for Flow | +| [LogInfo](IPublicAPI/LogInfo.md)(…) | Log info message | +| [LogWarn](IPublicAPI/LogWarn.md)(…) | Log warning message | +| [OpenDirectory](IPublicAPI/OpenDirectory.md)(…) | Open directory in an explorer configured by user via Flow's Settings. The default is Windows Explorer | +| [OpenSettingDialog](IPublicAPI/OpenSettingDialog.md)() | Open setting dialog | +| [OpenUrl](IPublicAPI/OpenUrl.md)(…) | Opens the url. The browser and mode used is based on what's configured in Flow's default browser settings. | +| [RegisterGlobalKeyboardCallback](IPublicAPI/RegisterGlobalKeyboardCallback.md)(…) | Register a callback for Global Keyboard Event | +| [ReloadAllPluginData](IPublicAPI/ReloadAllPluginData.md)() | Reloads any Plugins that have the IReloadable implemented. It refeshes Plugin's in memory data with new content added by user. | +| [RemoveActionKeyword](IPublicAPI/RemoveActionKeyword.md)(…) | Remove ActionKeyword for specific plugin | +| [RemoveGlobalKeyboardCallback](IPublicAPI/RemoveGlobalKeyboardCallback.md)(…) | Remove a callback for Global Keyboard Event | +| [RestartApp](IPublicAPI/RestartApp.md)() | Restart Flow Launcher | +| [SaveAppAllSettings](IPublicAPI/SaveAppAllSettings.md)() | Save everything, all of Flow Launcher and plugins' data and settings | +| [SavePluginSettings](IPublicAPI/SavePluginSettings.md)() | Save all Flow's plugins settings | +| [SaveSettingJsonStorage<T>](IPublicAPI/SaveSettingJsonStorage.md)() | Save JsonStorage for current plugin's setting. This is the method used to save settings to json in Flow.Launcher This method will save the original instance loaded with LoadJsonStorage. This API call is for manually Save. Flow will automatically save all setting type that has called LoadSettingJsonStorage or SaveSettingJsonStorage previously. | +| [ShellRun](IPublicAPI/ShellRun.md)(…) | Run a shell command | +| [ShowMainWindow](IPublicAPI/ShowMainWindow.md)() | Show the MainWindow when hiding | +| [ShowMsg](IPublicAPI/ShowMsg.md)(…) | Show message box (2 methods) | +| [ShowMsgError](IPublicAPI/ShowMsgError.md)(…) | Show the error message using Flow's standard error icon. | + +## See Also + +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/AddActionKeyword.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/AddActionKeyword.md new file mode 100644 index 0000000..4521675 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/AddActionKeyword.md @@ -0,0 +1,19 @@ +# IPublicAPI.AddActionKeyword method + +Add ActionKeyword for specific plugin + +```csharp +public void AddActionKeyword(string pluginId, string newActionKeyword) +``` + +| parameter | description | +| --- | --- | +| pluginId | ID for plugin that needs to add action keyword | +| newActionKeyword | The actionkeyword that is supposed to be added | + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ChangeQuery.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ChangeQuery.md new file mode 100644 index 0000000..4b9fb2b --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ChangeQuery.md @@ -0,0 +1,19 @@ +# IPublicAPI.ChangeQuery method + +Change Flow.Launcher query + +```csharp +public void ChangeQuery(string query, bool requery = false) +``` + +| parameter | description | +| --- | --- | +| query | query text | +| requery | force requery By default, Flow Launcher will not fire query if your query is same with existing one. Set this to true to force Flow Launcher requerying | + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/CheckForNewUpdate.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/CheckForNewUpdate.md new file mode 100644 index 0000000..4e69418 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/CheckForNewUpdate.md @@ -0,0 +1,14 @@ +# IPublicAPI.CheckForNewUpdate method + +Check for new Flow Launcher update + +```csharp +public void CheckForNewUpdate() +``` + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/CopyToClipboard.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/CopyToClipboard.md new file mode 100644 index 0000000..34c4bcd --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/CopyToClipboard.md @@ -0,0 +1,18 @@ +# IPublicAPI.CopyToClipboard method + +Copy Text to clipboard + +```csharp +public void CopyToClipboard(string text) +``` + +| parameter | description | +| --- | --- | +| Text | Text to save on clipboard | + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/FuzzySearch.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/FuzzySearch.md new file mode 100644 index 0000000..7b31b58 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/FuzzySearch.md @@ -0,0 +1,24 @@ +# IPublicAPI.FuzzySearch method + +Fuzzy Search the string with the given query. This is the core search mechanism Flow uses + +```csharp +public MatchResult FuzzySearch(string query, string stringToCompare) +``` + +| parameter | description | +| --- | --- | +| query | Query string | +| stringToCompare | The string that will be compared against the query | + +## Return Value + +Match results + +## See Also + +* class [MatchResult](../../Flow.Launcher.Plugin.SharedModels/MatchResult.md) +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/GetAllPlugins.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/GetAllPlugins.md new file mode 100644 index 0000000..18f91e7 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/GetAllPlugins.md @@ -0,0 +1,15 @@ +# IPublicAPI.GetAllPlugins method + +Get all loaded plugins + +```csharp +public List GetAllPlugins() +``` + +## See Also + +* class [PluginPair](../PluginPair.md) +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/GetTranslation.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/GetTranslation.md new file mode 100644 index 0000000..ec422b7 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/GetTranslation.md @@ -0,0 +1,18 @@ +# IPublicAPI.GetTranslation method + +Get translation of current language You need to implement IPluginI18n if you want to support multiple languages for your plugin + +```csharp +public string GetTranslation(string key) +``` + +| parameter | description | +| --- | --- | +| key | | + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/HttpDownloadAsync.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/HttpDownloadAsync.md new file mode 100644 index 0000000..90dfd17 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/HttpDownloadAsync.md @@ -0,0 +1,23 @@ +# IPublicAPI.HttpDownloadAsync method + +Download the specific url to a cretain file path + +```csharp +public Task HttpDownloadAsync(string url, string filePath, CancellationToken token = default) +``` + +| parameter | description | +| --- | --- | +| url | URL to download file | +| token | place to store file | + +## Return Value + +Task showing the progress + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/HttpGetStreamAsync.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/HttpGetStreamAsync.md new file mode 100644 index 0000000..b0a94d6 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/HttpGetStreamAsync.md @@ -0,0 +1,23 @@ +# IPublicAPI.HttpGetStreamAsync method + +Http download the spefic url and return as stream + +```csharp +public Task HttpGetStreamAsync(string url, CancellationToken token = default) +``` + +| parameter | description | +| --- | --- | +| url | URL to call Http Get | +| token | Cancellation Token | + +## Return Value + +Task to get stream result + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/HttpGetStringAsync.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/HttpGetStringAsync.md new file mode 100644 index 0000000..bd4ab42 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/HttpGetStringAsync.md @@ -0,0 +1,23 @@ +# IPublicAPI.HttpGetStringAsync method + +Http download the spefic url and return as string + +```csharp +public Task HttpGetStringAsync(string url, CancellationToken token = default) +``` + +| parameter | description | +| --- | --- | +| url | URL to call Http Get | +| token | Cancellation Token | + +## Return Value + +Task to get string result + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LoadSettingJsonStorage.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LoadSettingJsonStorage.md new file mode 100644 index 0000000..48ec321 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LoadSettingJsonStorage.md @@ -0,0 +1,19 @@ +# IPublicAPI.LoadSettingJsonStorage<T> method + +Load JsonStorage for current plugin's setting. This is the method used to load settings from json in Flow. When the file is not exist, it will create a new instance for the specific type. + +```csharp +public T LoadSettingJsonStorage() + where T : new() +``` + +| parameter | description | +| --- | --- | +| T | Type for deserialization | + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogDebug.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogDebug.md new file mode 100644 index 0000000..c17bf29 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogDebug.md @@ -0,0 +1,14 @@ +# IPublicAPI.LogDebug method + +Log debug message Message will only be logged in Debug mode + +```csharp +public void LogDebug(string className, string message, [CallerMemberName] string methodName = "") +``` + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogException.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogException.md new file mode 100644 index 0000000..1727c56 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogException.md @@ -0,0 +1,15 @@ +# IPublicAPI.LogException method + +Log an Exception. Will throw if in debug mode so developer will be aware, otherwise logs the eror message. This is the primary logging method used for Flow + +```csharp +public void LogException(string className, string message, Exception e, + [CallerMemberName] string methodName = "") +``` + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogInfo.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogInfo.md new file mode 100644 index 0000000..381ffb1 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogInfo.md @@ -0,0 +1,14 @@ +# IPublicAPI.LogInfo method + +Log info message + +```csharp +public void LogInfo(string className, string message, [CallerMemberName] string methodName = "") +``` + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogWarn.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogWarn.md new file mode 100644 index 0000000..3c38b13 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogWarn.md @@ -0,0 +1,14 @@ +# IPublicAPI.LogWarn method + +Log warning message + +```csharp +public void LogWarn(string className, string message, [CallerMemberName] string methodName = "") +``` + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/OpenDirectory.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/OpenDirectory.md new file mode 100644 index 0000000..fdf8ec7 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/OpenDirectory.md @@ -0,0 +1,19 @@ +# IPublicAPI.OpenDirectory method + +Open directory in an explorer configured by user via Flow's Settings. The default is Windows Explorer + +```csharp +public void OpenDirectory(string DirectoryPath, string FileName = null) +``` + +| parameter | description | +| --- | --- | +| DirectoryPath | Directory Path to open | +| FileName | Extra FileName Info | + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/OpenSettingDialog.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/OpenSettingDialog.md new file mode 100644 index 0000000..4e1aa72 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/OpenSettingDialog.md @@ -0,0 +1,14 @@ +# IPublicAPI.OpenSettingDialog method + +Open setting dialog + +```csharp +public void OpenSettingDialog() +``` + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/OpenUrl.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/OpenUrl.md new file mode 100644 index 0000000..735888c --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/OpenUrl.md @@ -0,0 +1,14 @@ +# IPublicAPI.OpenUrl method + +Opens the url. The browser and mode used is based on what's configured in Flow's default browser settings. + +```csharp +public void OpenUrl(string url, bool? inPrivate = null) +``` + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RegisterGlobalKeyboardCallback.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RegisterGlobalKeyboardCallback.md new file mode 100644 index 0000000..a990812 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RegisterGlobalKeyboardCallback.md @@ -0,0 +1,19 @@ +# IPublicAPI.RegisterGlobalKeyboardCallback method + +Register a callback for Global Keyboard Event + +```csharp +public void RegisterGlobalKeyboardCallback(Func callback) +``` + +| parameter | description | +| --- | --- | +| callback | | + +## See Also + +* class [SpecialKeyState](../SpecialKeyState.md) +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ReloadAllPluginData.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ReloadAllPluginData.md new file mode 100644 index 0000000..80c8b08 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ReloadAllPluginData.md @@ -0,0 +1,14 @@ +# IPublicAPI.ReloadAllPluginData method + +Reloads any Plugins that have the IReloadable implemented. It refeshes Plugin's in memory data with new content added by user. + +```csharp +public Task ReloadAllPluginData() +``` + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RemoveActionKeyword.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RemoveActionKeyword.md new file mode 100644 index 0000000..dfafcc0 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RemoveActionKeyword.md @@ -0,0 +1,19 @@ +# IPublicAPI.RemoveActionKeyword method + +Remove ActionKeyword for specific plugin + +```csharp +public void RemoveActionKeyword(string pluginId, string oldActionKeyword) +``` + +| parameter | description | +| --- | --- | +| pluginId | ID for plugin that needs to remove action keyword | +| newActionKeyword | The actionkeyword that is supposed to be removed | + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RemoveGlobalKeyboardCallback.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RemoveGlobalKeyboardCallback.md new file mode 100644 index 0000000..9b6eaff --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RemoveGlobalKeyboardCallback.md @@ -0,0 +1,19 @@ +# IPublicAPI.RemoveGlobalKeyboardCallback method + +Remove a callback for Global Keyboard Event + +```csharp +public void RemoveGlobalKeyboardCallback(Func callback) +``` + +| parameter | description | +| --- | --- | +| callback | | + +## See Also + +* class [SpecialKeyState](../SpecialKeyState.md) +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RestartApp.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RestartApp.md new file mode 100644 index 0000000..082691d --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RestartApp.md @@ -0,0 +1,14 @@ +# IPublicAPI.RestartApp method + +Restart Flow Launcher + +```csharp +public void RestartApp() +``` + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/SaveAppAllSettings.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/SaveAppAllSettings.md new file mode 100644 index 0000000..eeccec0 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/SaveAppAllSettings.md @@ -0,0 +1,14 @@ +# IPublicAPI.SaveAppAllSettings method + +Save everything, all of Flow Launcher and plugins' data and settings + +```csharp +public void SaveAppAllSettings() +``` + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/SavePluginSettings.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/SavePluginSettings.md new file mode 100644 index 0000000..9808308 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/SavePluginSettings.md @@ -0,0 +1,14 @@ +# IPublicAPI.SavePluginSettings method + +Save all Flow's plugins settings + +```csharp +public void SavePluginSettings() +``` + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/SaveSettingJsonStorage.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/SaveSettingJsonStorage.md new file mode 100644 index 0000000..e68cc1d --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/SaveSettingJsonStorage.md @@ -0,0 +1,19 @@ +# IPublicAPI.SaveSettingJsonStorage<T> method + +Save JsonStorage for current plugin's setting. This is the method used to save settings to json in Flow.Launcher This method will save the original instance loaded with LoadJsonStorage. This API call is for manually Save. Flow will automatically save all setting type that has called LoadSettingJsonStorage or SaveSettingJsonStorage previously. + +```csharp +public void SaveSettingJsonStorage() + where T : new() +``` + +| parameter | description | +| --- | --- | +| T | Type for Serialization | + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShellRun.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShellRun.md new file mode 100644 index 0000000..611a94c --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShellRun.md @@ -0,0 +1,26 @@ +# IPublicAPI.ShellRun method + +Run a shell command + +```csharp +public void ShellRun(string cmd, string filename = "cmd.exe") +``` + +| parameter | description | +| --- | --- | +| cmd | The command or program to run | +| filename | the shell type to run, e.g. powershell.exe | + +## Exceptions + +| exception | condition | +| --- | --- | +| FileNotFoundException | Thrown when unable to find the file specified in the command | +| !:Win32Exception | Thrown when error occurs during the execution of the command | + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShowMainWindow.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShowMainWindow.md new file mode 100644 index 0000000..e75fcc7 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShowMainWindow.md @@ -0,0 +1,14 @@ +# IPublicAPI.ShowMainWindow method + +Show the MainWindow when hiding + +```csharp +public void ShowMainWindow() +``` + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShowMsg.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShowMsg.md new file mode 100644 index 0000000..ffd7adc --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShowMsg.md @@ -0,0 +1,43 @@ +# IPublicAPI.ShowMsg method (1 of 2) + +Show message box + +```csharp +public void ShowMsg(string title, string subTitle = "", string iconPath = "") +``` + +| parameter | description | +| --- | --- | +| title | Message title | +| subTitle | Message subtitle | +| iconPath | Message icon path (relative path to your plugin folder) | + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + +--- + +# IPublicAPI.ShowMsg method (2 of 2) + +Show message box + +```csharp +public void ShowMsg(string title, string subTitle, string iconPath, + bool useMainWindowAsOwner = true) +``` + +| parameter | description | +| --- | --- | +| title | Message title | +| subTitle | Message subtitle | +| iconPath | Message icon path (relative path to your plugin folder) | +| useMainWindowAsOwner | when true will use main windows as the owner | + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShowMsgError.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShowMsgError.md new file mode 100644 index 0000000..66f0443 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShowMsgError.md @@ -0,0 +1,19 @@ +# IPublicAPI.ShowMsgError method + +Show the error message using Flow's standard error icon. + +```csharp +public void ShowMsgError(string title, string subTitle = "") +``` + +| parameter | description | +| --- | --- | +| title | Message title | +| subTitle | Optional message subtitle | + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IReloadable.md b/API-Reference/Flow.Launcher.Plugin/IReloadable.md new file mode 100644 index 0000000..85586a8 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IReloadable.md @@ -0,0 +1,22 @@ +# IReloadable interface + +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. + +If requiring reloading data asynchronously, please use the IAsyncReloadable interface + +```csharp +public interface IReloadable : IFeatures +``` + +## Members + +| name | description | +| --- | --- | +| [ReloadData](IReloadable/ReloadData.md)() | | + +## See Also + +* interface [IFeatures](./IFeatures.md) +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IReloadable/ReloadData.md b/API-Reference/Flow.Launcher.Plugin/IReloadable/ReloadData.md new file mode 100644 index 0000000..90e163a --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IReloadable/ReloadData.md @@ -0,0 +1,12 @@ +# IReloadable.ReloadData method + +```csharp +public void ReloadData() +``` + +## See Also + +* interface [IReloadable](../IReloadable.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IResultUpdated.md b/API-Reference/Flow.Launcher.Plugin/IResultUpdated.md new file mode 100644 index 0000000..4ad9e75 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IResultUpdated.md @@ -0,0 +1,18 @@ +# IResultUpdated interface + +```csharp +public interface IResultUpdated : IFeatures +``` + +## Members + +| name | description | +| --- | --- | +| event [ResultsUpdated](IResultUpdated/ResultsUpdated.md) | | + +## See Also + +* interface [IFeatures](./IFeatures.md) +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IResultUpdated/ResultsUpdated.md b/API-Reference/Flow.Launcher.Plugin/IResultUpdated/ResultsUpdated.md new file mode 100644 index 0000000..f1857ef --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IResultUpdated/ResultsUpdated.md @@ -0,0 +1,13 @@ +# IResultUpdated.ResultsUpdated event + +```csharp +public event ResultUpdatedEventHandler ResultsUpdated; +``` + +## See Also + +* delegate [ResultUpdatedEventHandler](../ResultUpdatedEventHandler.md) +* interface [IResultUpdated](../IResultUpdated.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/ISavable.md b/API-Reference/Flow.Launcher.Plugin/ISavable.md new file mode 100644 index 0000000..71c8e0b --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/ISavable.md @@ -0,0 +1,20 @@ +# ISavable interface + +Save addtional plugin data. Inherit this interface if additional data e.g. cache needs to be saved, Otherwise if LoadSettingJsonStorage or SaveSettingJsonStorage has been callded, plugin settings will be automatically saved (see Flow.Launcher/PublicAPIInstance.SavePluginSettings) by Flow + +```csharp +public interface ISavable : IFeatures +``` + +## Members + +| name | description | +| --- | --- | +| [Save](ISavable/Save.md)() | | + +## See Also + +* interface [IFeatures](./IFeatures.md) +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/ISavable/Save.md b/API-Reference/Flow.Launcher.Plugin/ISavable/Save.md new file mode 100644 index 0000000..88bdcf1 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/ISavable/Save.md @@ -0,0 +1,12 @@ +# ISavable.Save method + +```csharp +public void Save() +``` + +## See Also + +* interface [ISavable](../ISavable.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/ISettingProvider.md b/API-Reference/Flow.Launcher.Plugin/ISettingProvider.md new file mode 100644 index 0000000..28ad7b9 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/ISettingProvider.md @@ -0,0 +1,17 @@ +# ISettingProvider interface + +```csharp +public interface ISettingProvider +``` + +## Members + +| name | description | +| --- | --- | +| [CreateSettingPanel](ISettingProvider/CreateSettingPanel.md)() | | + +## See Also + +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/ISettingProvider/CreateSettingPanel.md b/API-Reference/Flow.Launcher.Plugin/ISettingProvider/CreateSettingPanel.md new file mode 100644 index 0000000..73e53e4 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/ISettingProvider/CreateSettingPanel.md @@ -0,0 +1,12 @@ +# ISettingProvider.CreateSettingPanel method + +```csharp +public Control CreateSettingPanel() +``` + +## See Also + +* interface [ISettingProvider](../ISettingProvider.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginInitContext.md b/API-Reference/Flow.Launcher.Plugin/PluginInitContext.md new file mode 100644 index 0000000..85e3023 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginInitContext.md @@ -0,0 +1,20 @@ +# PluginInitContext class + +```csharp +public class PluginInitContext +``` + +## Public Members + +| name | description | +| --- | --- | +| [PluginInitContext](PluginInitContext/PluginInitContext.md)() | The default constructor. | +| [PluginInitContext](PluginInitContext/PluginInitContext.md)(…) | | +| [API](PluginInitContext/API.md) { get; set; } | Public APIs for plugin invocation | +| [CurrentPluginMetadata](PluginInitContext/CurrentPluginMetadata.md) { get; } | | + +## See Also + +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginInitContext/API.md b/API-Reference/Flow.Launcher.Plugin/PluginInitContext/API.md new file mode 100644 index 0000000..444b49e --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginInitContext/API.md @@ -0,0 +1,15 @@ +# PluginInitContext.API property + +Public APIs for plugin invocation + +```csharp +public IPublicAPI API { get; set; } +``` + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* class [PluginInitContext](../PluginInitContext.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginInitContext/CurrentPluginMetadata.md b/API-Reference/Flow.Launcher.Plugin/PluginInitContext/CurrentPluginMetadata.md new file mode 100644 index 0000000..47ba233 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginInitContext/CurrentPluginMetadata.md @@ -0,0 +1,13 @@ +# PluginInitContext.CurrentPluginMetadata property + +```csharp +public PluginMetadata CurrentPluginMetadata { get; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* class [PluginInitContext](../PluginInitContext.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginInitContext/PluginInitContext.md b/API-Reference/Flow.Launcher.Plugin/PluginInitContext/PluginInitContext.md new file mode 100644 index 0000000..42207e3 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginInitContext/PluginInitContext.md @@ -0,0 +1,29 @@ +# PluginInitContext constructor (1 of 2) + +The default constructor. + +```csharp +public PluginInitContext() +``` + +## See Also + +* class [PluginInitContext](../PluginInitContext.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + +--- + +# PluginInitContext constructor (2 of 2) + +```csharp +public PluginInitContext(PluginMetadata currentPluginMetadata, IPublicAPI api) +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* interface [IPublicAPI](../IPublicAPI.md) +* class [PluginInitContext](../PluginInitContext.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata.md new file mode 100644 index 0000000..eac5d0e --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata.md @@ -0,0 +1,37 @@ +# PluginMetadata class + +```csharp +public class PluginMetadata : BaseModel +``` + +## Public Members + +| name | description | +| --- | --- | +| [PluginMetadata](PluginMetadata/PluginMetadata.md)() | The default constructor. | +| [ActionKeyword](PluginMetadata/ActionKeyword.md) { get; set; } | | +| [ActionKeywords](PluginMetadata/ActionKeywords.md) { get; set; } | | +| [Author](PluginMetadata/Author.md) { get; set; } | | +| [AvgQueryTime](PluginMetadata/AvgQueryTime.md) { get; set; } | | +| [Description](PluginMetadata/Description.md) { get; set; } | | +| [Disabled](PluginMetadata/Disabled.md) { get; set; } | | +| [ExecuteFileName](PluginMetadata/ExecuteFileName.md) { get; set; } | | +| [ExecuteFilePath](PluginMetadata/ExecuteFilePath.md) { get; } | | +| [IcoPath](PluginMetadata/IcoPath.md) { get; set; } | | +| [ID](PluginMetadata/ID.md) { get; set; } | | +| [InitTime](PluginMetadata/InitTime.md) { get; set; } | Init time include both plugin load time and init time | +| [Language](PluginMetadata/Language.md) { get; set; } | | +| [Name](PluginMetadata/Name.md) { get; set; } | | +| [PluginDirectory](PluginMetadata/PluginDirectory.md) { get; } | | +| [Priority](PluginMetadata/Priority.md) { get; set; } | | +| [QueryCount](PluginMetadata/QueryCount.md) { get; set; } | | +| [Version](PluginMetadata/Version.md) { get; set; } | | +| [Website](PluginMetadata/Website.md) { get; set; } | | +| override [ToString](PluginMetadata/ToString.md)() | | + +## See Also + +* class [BaseModel](./BaseModel.md) +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ActionKeyword.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ActionKeyword.md new file mode 100644 index 0000000..2b7e3f5 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ActionKeyword.md @@ -0,0 +1,12 @@ +# PluginMetadata.ActionKeyword property + +```csharp +public string ActionKeyword { get; set; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ActionKeywords.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ActionKeywords.md new file mode 100644 index 0000000..f037a9d --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ActionKeywords.md @@ -0,0 +1,12 @@ +# PluginMetadata.ActionKeywords property + +```csharp +public List ActionKeywords { get; set; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Author.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Author.md new file mode 100644 index 0000000..e9c25ea --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Author.md @@ -0,0 +1,12 @@ +# PluginMetadata.Author property + +```csharp +public string Author { get; set; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/AvgQueryTime.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/AvgQueryTime.md new file mode 100644 index 0000000..c375b5f --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/AvgQueryTime.md @@ -0,0 +1,12 @@ +# PluginMetadata.AvgQueryTime property + +```csharp +public long AvgQueryTime { get; set; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Description.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Description.md new file mode 100644 index 0000000..29c374b --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Description.md @@ -0,0 +1,12 @@ +# PluginMetadata.Description property + +```csharp +public string Description { get; set; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Disabled.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Disabled.md new file mode 100644 index 0000000..3b46193 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Disabled.md @@ -0,0 +1,12 @@ +# PluginMetadata.Disabled property + +```csharp +public bool Disabled { get; set; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ExecuteFileName.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ExecuteFileName.md new file mode 100644 index 0000000..400703d --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ExecuteFileName.md @@ -0,0 +1,12 @@ +# PluginMetadata.ExecuteFileName property + +```csharp +public string ExecuteFileName { get; set; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ExecuteFilePath.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ExecuteFilePath.md new file mode 100644 index 0000000..83f6082 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ExecuteFilePath.md @@ -0,0 +1,12 @@ +# PluginMetadata.ExecuteFilePath property + +```csharp +public string ExecuteFilePath { get; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ID.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ID.md new file mode 100644 index 0000000..7578d55 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ID.md @@ -0,0 +1,12 @@ +# PluginMetadata.ID property + +```csharp +public string ID { get; set; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/IcoPath.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/IcoPath.md new file mode 100644 index 0000000..c55321b --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/IcoPath.md @@ -0,0 +1,12 @@ +# PluginMetadata.IcoPath property + +```csharp +public string IcoPath { get; set; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/InitTime.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/InitTime.md new file mode 100644 index 0000000..139ef7e --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/InitTime.md @@ -0,0 +1,14 @@ +# PluginMetadata.InitTime property + +Init time include both plugin load time and init time + +```csharp +public long InitTime { get; set; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Language.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Language.md new file mode 100644 index 0000000..fedc7a6 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Language.md @@ -0,0 +1,12 @@ +# PluginMetadata.Language property + +```csharp +public string Language { get; set; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Name.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Name.md new file mode 100644 index 0000000..925cdb1 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Name.md @@ -0,0 +1,12 @@ +# PluginMetadata.Name property + +```csharp +public string Name { get; set; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/PluginDirectory.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/PluginDirectory.md new file mode 100644 index 0000000..87bc6d7 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/PluginDirectory.md @@ -0,0 +1,12 @@ +# PluginMetadata.PluginDirectory property + +```csharp +public string PluginDirectory { get; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/PluginMetadata.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/PluginMetadata.md new file mode 100644 index 0000000..2788d2e --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/PluginMetadata.md @@ -0,0 +1,14 @@ +# PluginMetadata constructor + +The default constructor. + +```csharp +public PluginMetadata() +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Priority.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Priority.md new file mode 100644 index 0000000..f28cf84 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Priority.md @@ -0,0 +1,12 @@ +# PluginMetadata.Priority property + +```csharp +public int Priority { get; set; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/QueryCount.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/QueryCount.md new file mode 100644 index 0000000..1320f3a --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/QueryCount.md @@ -0,0 +1,12 @@ +# PluginMetadata.QueryCount property + +```csharp +public int QueryCount { get; set; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ToString.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ToString.md new file mode 100644 index 0000000..dc7fd45 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ToString.md @@ -0,0 +1,12 @@ +# PluginMetadata.ToString method + +```csharp +public override string ToString() +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Version.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Version.md new file mode 100644 index 0000000..5899800 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Version.md @@ -0,0 +1,12 @@ +# PluginMetadata.Version property + +```csharp +public string Version { get; set; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Website.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Website.md new file mode 100644 index 0000000..2293a48 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Website.md @@ -0,0 +1,12 @@ +# PluginMetadata.Website property + +```csharp +public string Website { get; set; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginPair.md b/API-Reference/Flow.Launcher.Plugin/PluginPair.md new file mode 100644 index 0000000..c9d1ca6 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginPair.md @@ -0,0 +1,22 @@ +# PluginPair class + +```csharp +public class PluginPair +``` + +## Public Members + +| name | description | +| --- | --- | +| [PluginPair](PluginPair/PluginPair.md)() | The default constructor. | +| [Metadata](PluginPair/Metadata.md) { get; } | | +| [Plugin](PluginPair/Plugin.md) { get; } | | +| override [Equals](PluginPair/Equals.md)(…) | | +| override [GetHashCode](PluginPair/GetHashCode.md)() | | +| override [ToString](PluginPair/ToString.md)() | | + +## See Also + +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginPair/Equals.md b/API-Reference/Flow.Launcher.Plugin/PluginPair/Equals.md new file mode 100644 index 0000000..ae70a35 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginPair/Equals.md @@ -0,0 +1,12 @@ +# PluginPair.Equals method + +```csharp +public override bool Equals(object obj) +``` + +## See Also + +* class [PluginPair](../PluginPair.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginPair/GetHashCode.md b/API-Reference/Flow.Launcher.Plugin/PluginPair/GetHashCode.md new file mode 100644 index 0000000..d3b5797 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginPair/GetHashCode.md @@ -0,0 +1,12 @@ +# PluginPair.GetHashCode method + +```csharp +public override int GetHashCode() +``` + +## See Also + +* class [PluginPair](../PluginPair.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginPair/Metadata.md b/API-Reference/Flow.Launcher.Plugin/PluginPair/Metadata.md new file mode 100644 index 0000000..56a64fb --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginPair/Metadata.md @@ -0,0 +1,13 @@ +# PluginPair.Metadata property + +```csharp +public PluginMetadata Metadata { get; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* class [PluginPair](../PluginPair.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginPair/Plugin.md b/API-Reference/Flow.Launcher.Plugin/PluginPair/Plugin.md new file mode 100644 index 0000000..b96767b --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginPair/Plugin.md @@ -0,0 +1,13 @@ +# PluginPair.Plugin property + +```csharp +public IAsyncPlugin Plugin { get; } +``` + +## See Also + +* interface [IAsyncPlugin](../IAsyncPlugin.md) +* class [PluginPair](../PluginPair.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginPair/PluginPair.md b/API-Reference/Flow.Launcher.Plugin/PluginPair/PluginPair.md new file mode 100644 index 0000000..d8706d7 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginPair/PluginPair.md @@ -0,0 +1,14 @@ +# PluginPair constructor + +The default constructor. + +```csharp +public PluginPair() +``` + +## See Also + +* class [PluginPair](../PluginPair.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginPair/ToString.md b/API-Reference/Flow.Launcher.Plugin/PluginPair/ToString.md new file mode 100644 index 0000000..5a1608d --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginPair/ToString.md @@ -0,0 +1,12 @@ +# PluginPair.ToString method + +```csharp +public override string ToString() +``` + +## See Also + +* class [PluginPair](../PluginPair.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Query.md b/API-Reference/Flow.Launcher.Plugin/Query.md new file mode 100644 index 0000000..5ddba79 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Query.md @@ -0,0 +1,30 @@ +# Query class + +```csharp +public class Query +``` + +## Public Members + +| name | description | +| --- | --- | +| [Query](Query/Query.md)() | The default constructor. | +| [Query](Query/Query.md)(…) | to allow unit tests for plug ins | +| [ActionKeyword](Query/ActionKeyword.md) { get; set; } | | +| [FirstSearch](Query/FirstSearch.md) { get; } | Return first search split by space if it has | +| [RawQuery](Query/RawQuery.md) { get; } | Raw query, this includes action keyword if it has We didn't recommend use this property directly. You should always use Search property. | +| [Search](Query/Search.md) { get; } | Search part of a query. This will not include action keyword if exclusive plugin gets it, otherwise it should be same as RawQuery. Since we allow user to switch a exclusive plugin to generic plugin, so this property will always give you the "real" query part of the query | +| [SearchTerms](Query/SearchTerms.md) { get; set; } | The search string split into a string array. | +| [SecondSearch](Query/SecondSearch.md) { get; } | Return second search split by space if it has | +| [SecondToEndSearch](Query/SecondToEndSearch.md) { get; } | strings from second search (including) to last search | +| [ThirdSearch](Query/ThirdSearch.md) { get; } | Return third search split by space if it has | +| override [ToString](Query/ToString.md)() | | +| const [ActionKeywordSeparator](Query/ActionKeywordSeparator.md) | User can set multiple action keywords seperated by ';' | +| const [GlobalPluginWildcardSign](Query/GlobalPluginWildcardSign.md) | '*' is used for System Plugin | +| const [TermSeparator](Query/TermSeparator.md) | Query can be splited into multiple terms by whitespace | + +## See Also + +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/ActionKeyword.md b/API-Reference/Flow.Launcher.Plugin/Query/ActionKeyword.md new file mode 100644 index 0000000..11d0bec --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Query/ActionKeyword.md @@ -0,0 +1,12 @@ +# Query.ActionKeyword property + +```csharp +public string ActionKeyword { get; set; } +``` + +## See Also + +* class [Query](../Query.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/ActionKeywordSeparator.md b/API-Reference/Flow.Launcher.Plugin/Query/ActionKeywordSeparator.md new file mode 100644 index 0000000..7848a5b --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Query/ActionKeywordSeparator.md @@ -0,0 +1,14 @@ +# Query.ActionKeywordSeparator field + +User can set multiple action keywords seperated by ';' + +```csharp +public const string ActionKeywordSeparator; +``` + +## See Also + +* class [Query](../Query.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/FirstSearch.md b/API-Reference/Flow.Launcher.Plugin/Query/FirstSearch.md new file mode 100644 index 0000000..0a4fd07 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Query/FirstSearch.md @@ -0,0 +1,14 @@ +# Query.FirstSearch property + +Return first search split by space if it has + +```csharp +public string FirstSearch { get; } +``` + +## See Also + +* class [Query](../Query.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/GlobalPluginWildcardSign.md b/API-Reference/Flow.Launcher.Plugin/Query/GlobalPluginWildcardSign.md new file mode 100644 index 0000000..7c9624b --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Query/GlobalPluginWildcardSign.md @@ -0,0 +1,14 @@ +# Query.GlobalPluginWildcardSign field + +'*' is used for System Plugin + +```csharp +public const string GlobalPluginWildcardSign; +``` + +## See Also + +* class [Query](../Query.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/Query.md b/API-Reference/Flow.Launcher.Plugin/Query/Query.md new file mode 100644 index 0000000..5588432 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Query/Query.md @@ -0,0 +1,30 @@ +# Query constructor (1 of 2) + +The default constructor. + +```csharp +public Query() +``` + +## See Also + +* class [Query](../Query.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + +--- + +# Query constructor (2 of 2) + +to allow unit tests for plug ins + +```csharp +public Query(string rawQuery, string search, string[] terms, string[] searchTerms, + string actionKeyword = "") +``` + +## See Also + +* class [Query](../Query.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/RawQuery.md b/API-Reference/Flow.Launcher.Plugin/Query/RawQuery.md new file mode 100644 index 0000000..b8875b7 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Query/RawQuery.md @@ -0,0 +1,14 @@ +# Query.RawQuery property + +Raw query, this includes action keyword if it has We didn't recommend use this property directly. You should always use Search property. + +```csharp +public string RawQuery { get; } +``` + +## See Also + +* class [Query](../Query.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/Search.md b/API-Reference/Flow.Launcher.Plugin/Query/Search.md new file mode 100644 index 0000000..cd60d03 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Query/Search.md @@ -0,0 +1,14 @@ +# Query.Search property + +Search part of a query. This will not include action keyword if exclusive plugin gets it, otherwise it should be same as RawQuery. Since we allow user to switch a exclusive plugin to generic plugin, so this property will always give you the "real" query part of the query + +```csharp +public string Search { get; } +``` + +## See Also + +* class [Query](../Query.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/SearchTerms.md b/API-Reference/Flow.Launcher.Plugin/Query/SearchTerms.md new file mode 100644 index 0000000..97aa6fa --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Query/SearchTerms.md @@ -0,0 +1,14 @@ +# Query.SearchTerms property + +The search string split into a string array. + +```csharp +public string[] SearchTerms { get; set; } +``` + +## See Also + +* class [Query](../Query.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/SecondSearch.md b/API-Reference/Flow.Launcher.Plugin/Query/SecondSearch.md new file mode 100644 index 0000000..65457b0 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Query/SecondSearch.md @@ -0,0 +1,14 @@ +# Query.SecondSearch property + +Return second search split by space if it has + +```csharp +public string SecondSearch { get; } +``` + +## See Also + +* class [Query](../Query.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/SecondToEndSearch.md b/API-Reference/Flow.Launcher.Plugin/Query/SecondToEndSearch.md new file mode 100644 index 0000000..035e35f --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Query/SecondToEndSearch.md @@ -0,0 +1,14 @@ +# Query.SecondToEndSearch property + +strings from second search (including) to last search + +```csharp +public string SecondToEndSearch { get; } +``` + +## See Also + +* class [Query](../Query.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/TermSeparator.md b/API-Reference/Flow.Launcher.Plugin/Query/TermSeparator.md new file mode 100644 index 0000000..97babd1 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Query/TermSeparator.md @@ -0,0 +1,14 @@ +# Query.TermSeparator field + +Query can be splited into multiple terms by whitespace + +```csharp +public const string TermSeparator; +``` + +## See Also + +* class [Query](../Query.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/ThirdSearch.md b/API-Reference/Flow.Launcher.Plugin/Query/ThirdSearch.md new file mode 100644 index 0000000..475457b --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Query/ThirdSearch.md @@ -0,0 +1,14 @@ +# Query.ThirdSearch property + +Return third search split by space if it has + +```csharp +public string ThirdSearch { get; } +``` + +## See Also + +* class [Query](../Query.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/ToString.md b/API-Reference/Flow.Launcher.Plugin/Query/ToString.md new file mode 100644 index 0000000..ae5a95e --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Query/ToString.md @@ -0,0 +1,12 @@ +# Query.ToString method + +```csharp +public override string ToString() +``` + +## See Also + +* class [Query](../Query.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result.IconDelegate.md b/API-Reference/Flow.Launcher.Plugin/Result.IconDelegate.md new file mode 100644 index 0000000..23199c7 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result.IconDelegate.md @@ -0,0 +1,12 @@ +# Result.IconDelegate delegate + +```csharp +public delegate ImageSource IconDelegate(); +``` + +## See Also + +* class [Result](./Result.md) +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result.md b/API-Reference/Flow.Launcher.Plugin/Result.md new file mode 100644 index 0000000..cbeca3d --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result.md @@ -0,0 +1,36 @@ +# Result class + +```csharp +public class Result +``` + +## Public Members + +| name | description | +| --- | --- | +| [Result](Result/Result.md)() | The default constructor. | +| [Action](Result/Action.md) { get; set; } | Delegate. An action to take in the form of a function call when the result has been selected true to hide flowlauncher after select result | +| [ActionKeywordAssigned](Result/ActionKeywordAssigned.md) { get; set; } | This holds the action keyword that triggered the result. If result is triggered by global keyword: *, this should be empty. | +| [AutoCompleteText](Result/AutoCompleteText.md) { get; set; } | This holds the text which can be provided by plugin to help Flow autocomplete text for user on the plugin result. If autocomplete action for example is tab, pressing tab will have the default constructed autocomplete text (result's Title), or the text provided here if not empty. | +| [ContextData](Result/ContextData.md) { get; set; } | Additional data associated with this result As external information for ContextMenu | +| [Glyph](Result/Glyph.md) { get; set; } | Information for Glyph Icon (Prioritized than IcoPath/Icon if user enable Glyph Icons) | +| [IcoPath](Result/IcoPath.md) { get; set; } | Image Displayed on the result Relative Path to the Image FileGlyphInfo is prioritized if not null | +| [PluginDirectory](Result/PluginDirectory.md) { get; set; } | Plugin directory | +| [PluginID](Result/PluginID.md) { get; } | Plugin ID that generated this result | +| [Score](Result/Score.md) { get; set; } | Priority of the current result default: 0 | +| [SubTitle](Result/SubTitle.md) { get; set; } | Provides additional details for the result. This is optional | +| [SubTitleToolTip](Result/SubTitleToolTip.md) { get; set; } | Show message as ToolTip on result SubTitle hover over | +| [Title](Result/Title.md) { get; set; } | The title of the result. This is always required. | +| [TitleHighlightData](Result/TitleHighlightData.md) { get; set; } | A list of indexes for the characters to be highlighted in Title | +| [TitleToolTip](Result/TitleToolTip.md) { get; set; } | Show message as ToolTip on result Title hover over | +| [Icon](Result/Icon.md) | Delegate to Get Image Source | +| override [Equals](Result/Equals.md)(…) | | +| override [GetHashCode](Result/GetHashCode.md)() | | +| override [ToString](Result/ToString.md)() | | +| delegate [IconDelegate](Result.IconDelegate.md) | | + +## See Also + +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/Action.md b/API-Reference/Flow.Launcher.Plugin/Result/Action.md new file mode 100644 index 0000000..998016e --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/Action.md @@ -0,0 +1,15 @@ +# Result.Action property + +Delegate. An action to take in the form of a function call when the result has been selected true to hide flowlauncher after select result + +```csharp +public Func Action { get; set; } +``` + +## See Also + +* class [ActionContext](../ActionContext.md) +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/ActionKeywordAssigned.md b/API-Reference/Flow.Launcher.Plugin/Result/ActionKeywordAssigned.md new file mode 100644 index 0000000..c2985cd --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/ActionKeywordAssigned.md @@ -0,0 +1,14 @@ +# Result.ActionKeywordAssigned property + +This holds the action keyword that triggered the result. If result is triggered by global keyword: *, this should be empty. + +```csharp +public string ActionKeywordAssigned { get; set; } +``` + +## See Also + +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/AutoCompleteText.md b/API-Reference/Flow.Launcher.Plugin/Result/AutoCompleteText.md new file mode 100644 index 0000000..3f5baa5 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/AutoCompleteText.md @@ -0,0 +1,14 @@ +# Result.AutoCompleteText property + +This holds the text which can be provided by plugin to help Flow autocomplete text for user on the plugin result. If autocomplete action for example is tab, pressing tab will have the default constructed autocomplete text (result's Title), or the text provided here if not empty. + +```csharp +public string AutoCompleteText { get; set; } +``` + +## See Also + +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/ContextData.md b/API-Reference/Flow.Launcher.Plugin/Result/ContextData.md new file mode 100644 index 0000000..5212291 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/ContextData.md @@ -0,0 +1,14 @@ +# Result.ContextData property + +Additional data associated with this result As external information for ContextMenu + +```csharp +public object ContextData { get; set; } +``` + +## See Also + +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/Equals.md b/API-Reference/Flow.Launcher.Plugin/Result/Equals.md new file mode 100644 index 0000000..f8a5c3b --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/Equals.md @@ -0,0 +1,12 @@ +# Result.Equals method + +```csharp +public override bool Equals(object obj) +``` + +## See Also + +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/GetHashCode.md b/API-Reference/Flow.Launcher.Plugin/Result/GetHashCode.md new file mode 100644 index 0000000..af4ad6a --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/GetHashCode.md @@ -0,0 +1,12 @@ +# Result.GetHashCode method + +```csharp +public override int GetHashCode() +``` + +## See Also + +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/Glyph.md b/API-Reference/Flow.Launcher.Plugin/Result/Glyph.md new file mode 100644 index 0000000..c70d43b --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/Glyph.md @@ -0,0 +1,15 @@ +# Result.Glyph property + +Information for Glyph Icon (Prioritized than IcoPath/Icon if user enable Glyph Icons) + +```csharp +public GlyphInfo Glyph { get; set; } +``` + +## See Also + +* record [GlyphInfo](../GlyphInfo.md) +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/IcoPath.md b/API-Reference/Flow.Launcher.Plugin/Result/IcoPath.md new file mode 100644 index 0000000..55baf4c --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/IcoPath.md @@ -0,0 +1,14 @@ +# Result.IcoPath property + +Image Displayed on the result Relative Path to the Image FileGlyphInfo is prioritized if not null + +```csharp +public string IcoPath { get; set; } +``` + +## See Also + +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/Icon.md b/API-Reference/Flow.Launcher.Plugin/Result/Icon.md new file mode 100644 index 0000000..8d08325 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/Icon.md @@ -0,0 +1,15 @@ +# Result.Icon field + +Delegate to Get Image Source + +```csharp +public IconDelegate Icon; +``` + +## See Also + +* delegate [IconDelegate](../Result.IconDelegate.md) +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/PluginDirectory.md b/API-Reference/Flow.Launcher.Plugin/Result/PluginDirectory.md new file mode 100644 index 0000000..d64eb16 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/PluginDirectory.md @@ -0,0 +1,14 @@ +# Result.PluginDirectory property + +Plugin directory + +```csharp +public string PluginDirectory { get; set; } +``` + +## See Also + +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/PluginID.md b/API-Reference/Flow.Launcher.Plugin/Result/PluginID.md new file mode 100644 index 0000000..6a6343c --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/PluginID.md @@ -0,0 +1,14 @@ +# Result.PluginID property + +Plugin ID that generated this result + +```csharp +public string PluginID { get; } +``` + +## See Also + +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/Result.md b/API-Reference/Flow.Launcher.Plugin/Result/Result.md new file mode 100644 index 0000000..ba8845d --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/Result.md @@ -0,0 +1,14 @@ +# Result constructor + +The default constructor. + +```csharp +public Result() +``` + +## See Also + +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/Score.md b/API-Reference/Flow.Launcher.Plugin/Result/Score.md new file mode 100644 index 0000000..3a0448a --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/Score.md @@ -0,0 +1,14 @@ +# Result.Score property + +Priority of the current result default: 0 + +```csharp +public int Score { get; set; } +``` + +## See Also + +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/SubTitle.md b/API-Reference/Flow.Launcher.Plugin/Result/SubTitle.md new file mode 100644 index 0000000..7058122 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/SubTitle.md @@ -0,0 +1,14 @@ +# Result.SubTitle property + +Provides additional details for the result. This is optional + +```csharp +public string SubTitle { get; set; } +``` + +## See Also + +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/SubTitleToolTip.md b/API-Reference/Flow.Launcher.Plugin/Result/SubTitleToolTip.md new file mode 100644 index 0000000..a9f652b --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/SubTitleToolTip.md @@ -0,0 +1,14 @@ +# Result.SubTitleToolTip property + +Show message as ToolTip on result SubTitle hover over + +```csharp +public string SubTitleToolTip { get; set; } +``` + +## See Also + +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/Title.md b/API-Reference/Flow.Launcher.Plugin/Result/Title.md new file mode 100644 index 0000000..1e714cc --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/Title.md @@ -0,0 +1,14 @@ +# Result.Title property + +The title of the result. This is always required. + +```csharp +public string Title { get; set; } +``` + +## See Also + +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/TitleHighlightData.md b/API-Reference/Flow.Launcher.Plugin/Result/TitleHighlightData.md new file mode 100644 index 0000000..76c82dc --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/TitleHighlightData.md @@ -0,0 +1,14 @@ +# Result.TitleHighlightData property + +A list of indexes for the characters to be highlighted in Title + +```csharp +public IList TitleHighlightData { get; set; } +``` + +## See Also + +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/TitleToolTip.md b/API-Reference/Flow.Launcher.Plugin/Result/TitleToolTip.md new file mode 100644 index 0000000..2b54b9b --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/TitleToolTip.md @@ -0,0 +1,14 @@ +# Result.TitleToolTip property + +Show message as ToolTip on result Title hover over + +```csharp +public string TitleToolTip { get; set; } +``` + +## See Also + +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/ToString.md b/API-Reference/Flow.Launcher.Plugin/Result/ToString.md new file mode 100644 index 0000000..df651ac --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/ToString.md @@ -0,0 +1,12 @@ +# Result.ToString method + +```csharp +public override string ToString() +``` + +## See Also + +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/ResultItemDropEventHandler.md b/API-Reference/Flow.Launcher.Plugin/ResultItemDropEventHandler.md new file mode 100644 index 0000000..76f8617 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/ResultItemDropEventHandler.md @@ -0,0 +1,13 @@ +# ResultItemDropEventHandler delegate + +```csharp +public delegate void ResultItemDropEventHandler(Result result, IDataObject dropObject, + DragEventArgs e); +``` + +## See Also + +* class [Result](./Result.md) +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs.md b/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs.md new file mode 100644 index 0000000..58810cd --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs.md @@ -0,0 +1,20 @@ +# ResultUpdatedEventArgs class + +```csharp +public class ResultUpdatedEventArgs : EventArgs +``` + +## Public Members + +| name | description | +| --- | --- | +| [ResultUpdatedEventArgs](ResultUpdatedEventArgs/ResultUpdatedEventArgs.md)() | The default constructor. | +| [Token](ResultUpdatedEventArgs/Token.md) { get; set; } | | +| [Query](ResultUpdatedEventArgs/Query.md) | | +| [Results](ResultUpdatedEventArgs/Results.md) | | + +## See Also + +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/Query.md b/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/Query.md new file mode 100644 index 0000000..fd78834 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/Query.md @@ -0,0 +1,13 @@ +# ResultUpdatedEventArgs.Query field + +```csharp +public Query Query; +``` + +## See Also + +* class [Query](../Query.md) +* class [ResultUpdatedEventArgs](../ResultUpdatedEventArgs.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/ResultUpdatedEventArgs.md b/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/ResultUpdatedEventArgs.md new file mode 100644 index 0000000..5972cc4 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/ResultUpdatedEventArgs.md @@ -0,0 +1,14 @@ +# ResultUpdatedEventArgs constructor + +The default constructor. + +```csharp +public ResultUpdatedEventArgs() +``` + +## See Also + +* class [ResultUpdatedEventArgs](../ResultUpdatedEventArgs.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/Results.md b/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/Results.md new file mode 100644 index 0000000..1e30af2 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/Results.md @@ -0,0 +1,13 @@ +# ResultUpdatedEventArgs.Results field + +```csharp +public List Results; +``` + +## See Also + +* class [Result](../Result.md) +* class [ResultUpdatedEventArgs](../ResultUpdatedEventArgs.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/Token.md b/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/Token.md new file mode 100644 index 0000000..cb70027 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/Token.md @@ -0,0 +1,12 @@ +# ResultUpdatedEventArgs.Token property + +```csharp +public CancellationToken Token { get; set; } +``` + +## See Also + +* class [ResultUpdatedEventArgs](../ResultUpdatedEventArgs.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventHandler.md b/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventHandler.md new file mode 100644 index 0000000..63d075f --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventHandler.md @@ -0,0 +1,13 @@ +# ResultUpdatedEventHandler delegate + +```csharp +public delegate void ResultUpdatedEventHandler(IResultUpdated sender, ResultUpdatedEventArgs e); +``` + +## See Also + +* interface [IResultUpdated](./IResultUpdated.md) +* class [ResultUpdatedEventArgs](./ResultUpdatedEventArgs.md) +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/SpecialKeyState.md b/API-Reference/Flow.Launcher.Plugin/SpecialKeyState.md new file mode 100644 index 0000000..d395f62 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/SpecialKeyState.md @@ -0,0 +1,21 @@ +# SpecialKeyState class + +```csharp +public class SpecialKeyState +``` + +## Public Members + +| name | description | +| --- | --- | +| [SpecialKeyState](SpecialKeyState/SpecialKeyState.md)() | The default constructor. | +| [AltPressed](SpecialKeyState/AltPressed.md) { get; set; } | | +| [CtrlPressed](SpecialKeyState/CtrlPressed.md) { get; set; } | | +| [ShiftPressed](SpecialKeyState/ShiftPressed.md) { get; set; } | | +| [WinPressed](SpecialKeyState/WinPressed.md) { get; set; } | | + +## See Also + +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/AltPressed.md b/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/AltPressed.md new file mode 100644 index 0000000..535406a --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/AltPressed.md @@ -0,0 +1,12 @@ +# SpecialKeyState.AltPressed property + +```csharp +public bool AltPressed { get; set; } +``` + +## See Also + +* class [SpecialKeyState](../SpecialKeyState.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/CtrlPressed.md b/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/CtrlPressed.md new file mode 100644 index 0000000..5356387 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/CtrlPressed.md @@ -0,0 +1,12 @@ +# SpecialKeyState.CtrlPressed property + +```csharp +public bool CtrlPressed { get; set; } +``` + +## See Also + +* class [SpecialKeyState](../SpecialKeyState.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/ShiftPressed.md b/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/ShiftPressed.md new file mode 100644 index 0000000..d3ed62c --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/ShiftPressed.md @@ -0,0 +1,12 @@ +# SpecialKeyState.ShiftPressed property + +```csharp +public bool ShiftPressed { get; set; } +``` + +## See Also + +* class [SpecialKeyState](../SpecialKeyState.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/SpecialKeyState.md b/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/SpecialKeyState.md new file mode 100644 index 0000000..473285b --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/SpecialKeyState.md @@ -0,0 +1,14 @@ +# SpecialKeyState constructor + +The default constructor. + +```csharp +public SpecialKeyState() +``` + +## See Also + +* class [SpecialKeyState](../SpecialKeyState.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/WinPressed.md b/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/WinPressed.md new file mode 100644 index 0000000..cddfc8f --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/WinPressed.md @@ -0,0 +1,12 @@ +# SpecialKeyState.WinPressed property + +```csharp +public bool WinPressed { get; set; } +``` + +## See Also + +* class [SpecialKeyState](../SpecialKeyState.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/_sidebar.md b/API-Reference/Flow.Launcher.Plugin/_sidebar.md deleted file mode 100644 index acb61c1..0000000 --- a/API-Reference/Flow.Launcher.Plugin/_sidebar.md +++ /dev/null @@ -1,26 +0,0 @@ -- [**Flow.Launcher.Plugin**](../Flow.Launcher.Plugin.md) - - **Class** - - [ActionContext](actioncontext.md) - - [AllowedLanguage](allowedlanguage.md) - - [BaseModel](basemodel.md) - - [FlowLauncherKeyDownEventArgs](flowlauncherkeydowneventargs.md) - - [FlowLauncherQueryEventArgs](flowlauncherqueryeventargs.md) - - [PluginInitContext](plugininitcontext.md) - - [PluginMetadata](pluginmetadata.md) - - [PluginPair](pluginpair.md) - - [Query](query.md) - - [Result](result.md) - - [ResultUpdatedEventArgs](resultupdatedeventargs.md) - - [SpecialKeyState](specialkeystate.md) - - **Interface** - - [IAsyncPlugin](iasyncplugin.md) - - [IAsyncReloadable](iasyncreloadable.md) - - [IContextMenu](icontextmenu.md) - - [IFeatures](ifeatures.md) - - [IPlugin](iplugin.md) - - [IPluginI18n](iplugini18n.md) - - [IPublicAPI](ipublicapi.md) - - [IReloadable](ireloadable.md) - - [IResultUpdated](iresultupdated.md) - - [ISavable](isavable.md) - - [ISettingProvider](isettingprovider.md) \ No newline at end of file diff --git a/API-Reference/Flow.Launcher.Plugin/actioncontext.md b/API-Reference/Flow.Launcher.Plugin/actioncontext.md deleted file mode 100644 index 6b88b5e..0000000 --- a/API-Reference/Flow.Launcher.Plugin/actioncontext.md +++ /dev/null @@ -1,35 +0,0 @@ -# ActionContext - -Namespace: Flow.Launcher.Plugin - - - -```csharp -public class ActionContext -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ActionContext](actioncontext.md) - -## Properties - -### **SpecialKeyState** - - - -```csharp -public SpecialKeyState SpecialKeyState { get; set; } -``` - -#### Property Value - -[SpecialKeyState](specialkeystate.md)
- -## Constructors - -### **ActionContext()** - - - -```csharp -public ActionContext() -``` diff --git a/API-Reference/Flow.Launcher.Plugin/allowedlanguage.md b/API-Reference/Flow.Launcher.Plugin/allowedlanguage.md deleted file mode 100644 index 3251d46..0000000 --- a/API-Reference/Flow.Launcher.Plugin/allowedlanguage.md +++ /dev/null @@ -1,95 +0,0 @@ -# AllowedLanguage - -Namespace: Flow.Launcher.Plugin - - - -```csharp -public static class AllowedLanguage -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [AllowedLanguage](allowedlanguage.md) - -## Properties - -### **Python** - - - -```csharp -public static string Python { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **CSharp** - - - -```csharp -public static string CSharp { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **FSharp** - - - -```csharp -public static string FSharp { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Executable** - - - -```csharp -public static string Executable { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Methods - -### **IsDotNet(String)** - - - -```csharp -public static bool IsDotNet(string language) -``` - -#### Parameters - -`language` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -#### Returns - -[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
- -### **IsAllowed(String)** - - - -```csharp -public static bool IsAllowed(string language) -``` - -#### Parameters - -`language` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -#### Returns - -[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
diff --git a/API-Reference/Flow.Launcher.Plugin/basemodel.md b/API-Reference/Flow.Launcher.Plugin/basemodel.md deleted file mode 100644 index 29b4c68..0000000 --- a/API-Reference/Flow.Launcher.Plugin/basemodel.md +++ /dev/null @@ -1,46 +0,0 @@ -# BaseModel - -Namespace: Flow.Launcher.Plugin - - - -```csharp -public class BaseModel : System.ComponentModel.INotifyPropertyChanged -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [BaseModel](basemodel.md)
-Implements INotifyPropertyChanged - -## Constructors - -### **BaseModel()** - - - -```csharp -public BaseModel() -``` - -## Methods - -### **OnPropertyChanged(String)** - - - -```csharp -protected void OnPropertyChanged(string propertyName) -``` - -#### Parameters - -`propertyName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Events - -### **PropertyChanged** - - - -```csharp -public event PropertyChangedEventHandler PropertyChanged; -``` diff --git a/API-Reference/Flow.Launcher.Plugin/flowlauncherkeydowneventargs.md b/API-Reference/Flow.Launcher.Plugin/flowlauncherkeydowneventargs.md deleted file mode 100644 index 9213142..0000000 --- a/API-Reference/Flow.Launcher.Plugin/flowlauncherkeydowneventargs.md +++ /dev/null @@ -1,47 +0,0 @@ -# FlowLauncherQueryEventArgs - -Namespace: Flow.Launcher.Plugin - - - -```csharp -public class FlowLauncherKeyDownEventArgs -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FlowLauncherQueryEventArgs](flowlauncherqueryeventargs.md) - -## Properties - -### **Query** - - - -```csharp -public Query Query { get; set; } -``` - -#### Property Value - -[Query](query.md)
- -```csharp -public Query Query { get; set; } -``` - -[KeyEventArgs](https://docs.microsoft.com/en-us/dotnet/api/system.windows.forms.keyeventargs)
- - -```csharp -public KeyEventArgs keyEventArgs { get; set; } -``` - - -## Constructors - -### **FlowLauncherQueryEventArgs()** - - - -```csharp -public FlowLauncherQueryEventArgs() -``` diff --git a/API-Reference/Flow.Launcher.Plugin/flowlauncherqueryeventargs.md b/API-Reference/Flow.Launcher.Plugin/flowlauncherqueryeventargs.md deleted file mode 100644 index 60ed339..0000000 --- a/API-Reference/Flow.Launcher.Plugin/flowlauncherqueryeventargs.md +++ /dev/null @@ -1,35 +0,0 @@ -# FlowLauncherQueryEventArgs - -Namespace: Flow.Launcher.Plugin - - - -```csharp -public class FlowLauncherQueryEventArgs -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FlowLauncherQueryEventArgs](flowlauncherqueryeventargs.md) - -## Properties - -### **Query** - - - -```csharp -public Query Query { get; set; } -``` - -#### Property Value - -[Query](query.md)
- -## Constructors - -### **FlowLauncherQueryEventArgs()** - - - -```csharp -public FlowLauncherQueryEventArgs() -``` diff --git a/API-Reference/Flow.Launcher.Plugin/iasyncplugin.md b/API-Reference/Flow.Launcher.Plugin/iasyncplugin.md deleted file mode 100644 index e5b1de5..0000000 --- a/API-Reference/Flow.Launcher.Plugin/iasyncplugin.md +++ /dev/null @@ -1,47 +0,0 @@ -# IAsyncPlugin - -Namespace: Flow.Launcher.Plugin - -Asynchronous Plugin Model for Flow Launcher - -```csharp -public interface IAsyncPlugin -``` - -## Methods - -### **QueryAsync(Query, CancellationToken)** - -Asynchronous Querying - -```csharp -Task> QueryAsync(Query query, CancellationToken token) -``` - -#### Parameters - -`query` [Query](query.md)
-Query to search - -`token` [CancellationToken](https://docs.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken)
-Cancel when querying job is obsolete - -#### Returns - -[Task<List<Result>>](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1)
- -### **InitAsync(PluginInitContext)** - -Initialize plugin asynchrously (will still wait finish to continue) - -```csharp -Task InitAsync(PluginInitContext context) -``` - -#### Parameters - -`context` [PluginInitContext](plugininitcontext.md)
- -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
diff --git a/API-Reference/Flow.Launcher.Plugin/iasyncreloadable.md b/API-Reference/Flow.Launcher.Plugin/iasyncreloadable.md deleted file mode 100644 index 286a312..0000000 --- a/API-Reference/Flow.Launcher.Plugin/iasyncreloadable.md +++ /dev/null @@ -1,31 +0,0 @@ -# IAsyncReloadable - -Namespace: Flow.Launcher.Plugin - -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. - -```csharp -public interface IAsyncReloadable -``` - -## Methods - -### **ReloadDataAsync()** - - - -```csharp -Task ReloadDataAsync() -``` - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
diff --git a/API-Reference/Flow.Launcher.Plugin/icontextmenu.md b/API-Reference/Flow.Launcher.Plugin/icontextmenu.md deleted file mode 100644 index 7aab015..0000000 --- a/API-Reference/Flow.Launcher.Plugin/icontextmenu.md +++ /dev/null @@ -1,29 +0,0 @@ -# IContextMenu - -Namespace: Flow.Launcher.Plugin - - - -```csharp -public interface IContextMenu : IFeatures -``` - -Implements [IFeatures](ifeatures.md) - -## Methods - -### **LoadContextMenus(Result)** - - - -```csharp -List LoadContextMenus(Result selectedResult) -``` - -#### Parameters - -`selectedResult` [Result](result.md)
- -#### Returns - -[List<Result>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.list-1)
diff --git a/API-Reference/Flow.Launcher.Plugin/ifeatures.md b/API-Reference/Flow.Launcher.Plugin/ifeatures.md deleted file mode 100644 index 570a11d..0000000 --- a/API-Reference/Flow.Launcher.Plugin/ifeatures.md +++ /dev/null @@ -1,9 +0,0 @@ -# IFeatures - -Namespace: Flow.Launcher.Plugin - - - -```csharp -public interface IFeatures -``` diff --git a/API-Reference/Flow.Launcher.Plugin/iplugin.md b/API-Reference/Flow.Launcher.Plugin/iplugin.md deleted file mode 100644 index 90eec42..0000000 --- a/API-Reference/Flow.Launcher.Plugin/iplugin.md +++ /dev/null @@ -1,48 +0,0 @@ -# IPlugin - -Namespace: Flow.Launcher.Plugin - -Synchronous Plugin Model for Flow Launcher - - If the Querying or Init method requires high IO transmission - or performaing CPU intense jobs (performing better with cancellation), please try the IAsyncPlugin interface - -```csharp -public interface IPlugin : IAsyncPlugin -``` - -Implements [IAsyncPlugin](iasyncplugin.md) - -## Methods - -### **Query(Query)** - -Querying when user's search changes - - This method will be called within a Task.Run, - so please avoid synchrously wait for long. - -```csharp -List Query(Query query) -``` - -#### Parameters - -`query` [Query](query.md)
-Query to search - -#### Returns - -[List<Result>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.list-1)
- -### **Init(PluginInitContext)** - -Initialize plugin - -```csharp -void Init(PluginInitContext context) -``` - -#### Parameters - -`context` [PluginInitContext](plugininitcontext.md)
diff --git a/API-Reference/Flow.Launcher.Plugin/iplugini18n.md b/API-Reference/Flow.Launcher.Plugin/iplugini18n.md deleted file mode 100644 index a914191..0000000 --- a/API-Reference/Flow.Launcher.Plugin/iplugini18n.md +++ /dev/null @@ -1,37 +0,0 @@ -# IPluginI18n - -Namespace: Flow.Launcher.Plugin - -Represent plugins that support internationalization - -```csharp -public interface IPluginI18n : IFeatures -``` - -Implements [IFeatures](ifeatures.md) - -## Methods - -### **GetTranslatedPluginTitle()** - - - -```csharp -string GetTranslatedPluginTitle() -``` - -#### Returns - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **GetTranslatedPluginDescription()** - - - -```csharp -string GetTranslatedPluginDescription() -``` - -#### Returns - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
diff --git a/API-Reference/Flow.Launcher.Plugin/ipublicapi.md b/API-Reference/Flow.Launcher.Plugin/ipublicapi.md deleted file mode 100644 index 3e1898a..0000000 --- a/API-Reference/Flow.Launcher.Plugin/ipublicapi.md +++ /dev/null @@ -1,399 +0,0 @@ -# IPublicAPI - -Namespace: Flow.Launcher.Plugin - -Public APIs that plugin can use - -```csharp -public interface IPublicAPI -``` - -## Methods - -### **ChangeQuery(String, Boolean)** - -Change Flow.Launcher query - -```csharp -void ChangeQuery(string query, bool requery) -``` - -#### Parameters - -`query` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-query text - -`requery` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
- - force requery By default, Flow Launcher will not fire query if your query is same with existing one. - Set this to true to force Flow Launcher requerying - -### **RestartApp()** - -Restart Flow Launcher - -```csharp -void RestartApp() -``` - -### **SaveAppAllSettings()** - -Save everything, all of Flow Launcher and plugins' data and settings - -```csharp -void SaveAppAllSettings() -``` - -### **SavePluginSettings()** - -Save all Flow's plugins settings - -```csharp -void SavePluginSettings() -``` - -### **ReloadAllPluginData()** - -Reloads any Plugins that have the - IReloadable implemented. It refeshes - Plugin's in memory data with new content - added by user. - -```csharp -Task ReloadAllPluginData() -``` - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- -### **CheckForNewUpdate()** - -Check for new Flow Launcher update - -```csharp -void CheckForNewUpdate() -``` - -### **ShowMsgError(String, String)** - -Show the error message using Flow's standard error icon. - -```csharp -void ShowMsgError(string title, string subTitle) -``` - -#### Parameters - -`title` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-Message title - -`subTitle` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-Optional message subtitle - -### **ShowMsg(String, String, String)** - -Show message box - -```csharp -void ShowMsg(string title, string subTitle, string iconPath) -``` - -#### Parameters - -`title` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-Message title - -`subTitle` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-Message subtitle - -`iconPath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-Message icon path (relative path to your plugin folder) - -### **ShowMsg(String, String, String, Boolean)** - -Show message box - -```csharp -void ShowMsg(string title, string subTitle, string iconPath, bool useMainWindowAsOwner) -``` - -#### Parameters - -`title` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-Message title - -`subTitle` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-Message subtitle - -`iconPath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-Message icon path (relative path to your plugin folder) - -`useMainWindowAsOwner` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-when true will use main windows as the owner - -### **OpenSettingDialog()** - -Open setting dialog - -```csharp -void OpenSettingDialog() -``` - -### **GetTranslation(String)** - -Get translation of current language - You need to implement IPluginI18n if you want to support multiple languages for your plugin - -```csharp -string GetTranslation(string key) -``` - -#### Parameters - -`key` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -#### Returns - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **GetAllPlugins()** - -Get all loaded plugins - -```csharp -List GetAllPlugins() -``` - -#### Returns - -[List<PluginPair>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.list-1)
- -### **FuzzySearch(String, String)** - -Fuzzy Search the string with the given query. This is the core search mechanism Flow uses - -```csharp -MatchResult FuzzySearch(string query, string stringToCompare) -``` - -#### Parameters - -`query` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-Query string - -`stringToCompare` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The string that will be compared against the query - -#### Returns - -[MatchResult](sharedmodels.matchresult.md)
-Match results - -### **HttpGetStringAsync(String, CancellationToken)** - -Http download the spefic url and return as string - -```csharp -Task HttpGetStringAsync(string url, CancellationToken token) -``` - -#### Parameters - -`url` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-URL to call Http Get - -`token` [CancellationToken](https://docs.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken)
-Cancellation Token - -#### Returns - -[Task<String>](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1)
-Task to get string result - -### **HttpGetStreamAsync(String, CancellationToken)** - -Http download the spefic url and return as stream - -```csharp -Task HttpGetStreamAsync(string url, CancellationToken token) -``` - -#### Parameters - -`url` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-URL to call Http Get - -`token` [CancellationToken](https://docs.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken)
-Cancellation Token - -#### Returns - -[Task<Stream>](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1)
-Task to get stream result - -### **HttpDownloadAsync(String, String, CancellationToken)** - -Download the specific url to a cretain file path - -```csharp -Task HttpDownloadAsync(string url, string filePath, CancellationToken token) -``` - -#### Parameters - -`url` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-URL to download file - -`filePath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -`token` [CancellationToken](https://docs.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken)
-place to store file - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
-Task showing the progress - -### **AddActionKeyword(String, String)** - -Add ActionKeyword for specific plugin - -```csharp -void AddActionKeyword(string pluginId, string newActionKeyword) -``` - -#### Parameters - -`pluginId` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-ID for plugin that needs to add action keyword - -`newActionKeyword` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The actionkeyword that is supposed to be added - -### **RemoveActionKeyword(String, String)** - -Remove ActionKeyword for specific plugin - -```csharp -void RemoveActionKeyword(string pluginId, string oldActionKeyword) -``` - -#### Parameters - -`pluginId` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-ID for plugin that needs to remove action keyword - -`oldActionKeyword` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **LogDebug(String, String, String)** - -Log debug message - Message will only be logged in Debug mode - -```csharp -void LogDebug(string className, string message, string methodName) -``` - -#### Parameters - -`className` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -`message` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -`methodName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **LogInfo(String, String, String)** - -Log info message - -```csharp -void LogInfo(string className, string message, string methodName) -``` - -#### Parameters - -`className` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -`message` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -`methodName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **LogWarn(String, String, String)** - -Log warning message - -```csharp -void LogWarn(string className, string message, string methodName) -``` - -#### Parameters - -`className` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -`message` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -`methodName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **LogException(String, String, Exception, String)** - -Log an Exception. Will throw if in debug mode so developer will be aware, - otherwise logs the eror message. This is the primary logging method used for Flow - -```csharp -void LogException(string className, string message, Exception e, string methodName) -``` - -#### Parameters - -`className` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -`message` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -`e` [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception)
- -`methodName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **LoadSettingJsonStorage<T>()** - -Load JsonStorage for current plugin's setting. This is the method used to load settings from json in Flow. - When the file is not exist, it will create a new instance for the specific type. - -```csharp -T LoadSettingJsonStorage() -``` - -#### Type Parameters - -`T`
-Type for deserialization - -#### Returns - -T
- -### **SaveSettingJsonStorage<T>()** - -Save JsonStorage for current plugin's setting. This is the method used to save settings to json in Flow.Launcher - This method will save the original instance loaded with LoadJsonStorage. - This API call is for manually Save. Flow will automatically save all setting type that has called LoadSettingJsonStorage or SaveSettingJsonStorage previously. - -```csharp -void SaveSettingJsonStorage() -``` - -#### Type Parameters - -`T`
-Type for Serialization - -## Events - -### **GlobalKeyboardEvent** - -Fired after global keyboard events - if you want to hook something like Ctrl+R, you should use this event - -```csharp -public abstract event FlowLauncherGlobalKeyboardEventHandler GlobalKeyboardEvent; -``` diff --git a/API-Reference/Flow.Launcher.Plugin/ireloadable.md b/API-Reference/Flow.Launcher.Plugin/ireloadable.md deleted file mode 100644 index 2778090..0000000 --- a/API-Reference/Flow.Launcher.Plugin/ireloadable.md +++ /dev/null @@ -1,30 +0,0 @@ -# IReloadable - -Namespace: Flow.Launcher.Plugin - -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. - - - If requiring reloading data asynchronously, please use the IAsyncReloadable interface - -```csharp -public interface IReloadable -``` - -## Methods - -### **ReloadData()** - - - -```csharp -void ReloadData() -``` diff --git a/API-Reference/Flow.Launcher.Plugin/iresultupdated.md b/API-Reference/Flow.Launcher.Plugin/iresultupdated.md deleted file mode 100644 index 5cf1110..0000000 --- a/API-Reference/Flow.Launcher.Plugin/iresultupdated.md +++ /dev/null @@ -1,21 +0,0 @@ -# IResultUpdated - -Namespace: Flow.Launcher.Plugin - - - -```csharp -public interface IResultUpdated : IFeatures -``` - -Implements [IFeatures](ifeatures.md) - -## Events - -### **ResultsUpdated** - - - -```csharp -public abstract event ResultUpdatedEventHandler ResultsUpdated; -``` diff --git a/API-Reference/Flow.Launcher.Plugin/isavable.md b/API-Reference/Flow.Launcher.Plugin/isavable.md deleted file mode 100644 index 67d3cd7..0000000 --- a/API-Reference/Flow.Launcher.Plugin/isavable.md +++ /dev/null @@ -1,21 +0,0 @@ -# ISavable - -Namespace: Flow.Launcher.Plugin - -Save addtional plugin data. Inherit this interface if additional data e.g. cache needs to be saved, - Otherwise if LoadSettingJsonStorage or SaveSettingJsonStorage has been callded, - plugin settings will be automatically saved (see Flow.Launcher/PublicAPIInstance.SavePluginSettings) by Flow - -```csharp -public interface ISavable -``` - -## Methods - -### **Save()** - - - -```csharp -void Save() -``` diff --git a/API-Reference/Flow.Launcher.Plugin/plugininitcontext.md b/API-Reference/Flow.Launcher.Plugin/plugininitcontext.md deleted file mode 100644 index cf9d282..0000000 --- a/API-Reference/Flow.Launcher.Plugin/plugininitcontext.md +++ /dev/null @@ -1,61 +0,0 @@ -# PluginInitContext - -Namespace: Flow.Launcher.Plugin - - - -```csharp -public class PluginInitContext -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [PluginInitContext](plugininitcontext.md) - -## Properties - -### **CurrentPluginMetadata** - - - -```csharp -public PluginMetadata CurrentPluginMetadata { get; internal set; } -``` - -#### Property Value - -[PluginMetadata](pluginmetadata.md)
- -### **API** - -Public APIs for plugin invocation - -```csharp -public IPublicAPI API { get; set; } -``` - -#### Property Value - -[IPublicAPI](ipublicapi.md)
- -## Constructors - -### **PluginInitContext()** - - - -```csharp -public PluginInitContext() -``` - -### **PluginInitContext(PluginMetadata, IPublicAPI)** - - - -```csharp -public PluginInitContext(PluginMetadata currentPluginMetadata, IPublicAPI api) -``` - -#### Parameters - -`currentPluginMetadata` [PluginMetadata](pluginmetadata.md)
- -`api` [IPublicAPI](ipublicapi.md)
diff --git a/API-Reference/Flow.Launcher.Plugin/pluginmetadata.md b/API-Reference/Flow.Launcher.Plugin/pluginmetadata.md deleted file mode 100644 index bc7a06b..0000000 --- a/API-Reference/Flow.Launcher.Plugin/pluginmetadata.md +++ /dev/null @@ -1,264 +0,0 @@ -# PluginMetadata - -Namespace: Flow.Launcher.Plugin - - - -```csharp -public class PluginMetadata : BaseModel, System.ComponentModel.INotifyPropertyChanged -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [BaseModel](basemodel.md) → [PluginMetadata](pluginmetadata.md)
-Implements INotifyPropertyChanged - -## Properties - -### **ID** - - - -```csharp -public string ID { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Name** - - - -```csharp -public string Name { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Author** - - - -```csharp -public string Author { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Version** - - - -```csharp -public string Version { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Language** - - - -```csharp -public string Language { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Description** - - - -```csharp -public string Description { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Website** - - - -```csharp -public string Website { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Disabled** - - - -```csharp -public bool Disabled { get; set; } -``` - -#### Property Value - -[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
- -### **ExecuteFilePath** - - - -```csharp -public string ExecuteFilePath { get; private set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ExecuteFileName** - - - -```csharp -public string ExecuteFileName { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **PluginDirectory** - - - -```csharp -public string PluginDirectory { get; internal set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ActionKeyword** - - - -```csharp -public string ActionKeyword { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ActionKeywords** - - - -```csharp -public List ActionKeywords { get; set; } -``` - -#### Property Value - -[List<String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.list-1)
- -### **IcoPath** - - - -```csharp -public string IcoPath { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Priority** - - - -```csharp -public int Priority { get; set; } -``` - -#### Property Value - -[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
- -### **InitTime** - -Init time include both plugin load time and init time - -```csharp -public long InitTime { get; set; } -``` - -#### Property Value - -[Int64](https://docs.microsoft.com/en-us/dotnet/api/system.int64)
- -### **AvgQueryTime** - - - -```csharp -public long AvgQueryTime { get; set; } -``` - -#### Property Value - -[Int64](https://docs.microsoft.com/en-us/dotnet/api/system.int64)
- -### **QueryCount** - - - -```csharp -public int QueryCount { get; set; } -``` - -#### Property Value - -[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
- -## Constructors - -### **PluginMetadata()** - - - -```csharp -public PluginMetadata() -``` - -## Methods - -### **ToString()** - - - -```csharp -public string ToString() -``` - -#### Returns - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Events - -### **PropertyChanged** - - - -```csharp -public event PropertyChangedEventHandler PropertyChanged; -``` diff --git a/API-Reference/Flow.Launcher.Plugin/pluginpair.md b/API-Reference/Flow.Launcher.Plugin/pluginpair.md deleted file mode 100644 index 77c4fdc..0000000 --- a/API-Reference/Flow.Launcher.Plugin/pluginpair.md +++ /dev/null @@ -1,89 +0,0 @@ -# PluginPair - -Namespace: Flow.Launcher.Plugin - - - -```csharp -public class PluginPair -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [PluginPair](pluginpair.md) - -## Properties - -### **Plugin** - - - -```csharp -public IAsyncPlugin Plugin { get; internal set; } -``` - -#### Property Value - -[IAsyncPlugin](iasyncplugin.md)
- -### **Metadata** - - - -```csharp -public PluginMetadata Metadata { get; internal set; } -``` - -#### Property Value - -[PluginMetadata](pluginmetadata.md)
- -## Constructors - -### **PluginPair()** - - - -```csharp -public PluginPair() -``` - -## Methods - -### **ToString()** - - - -```csharp -public string ToString() -``` - -#### Returns - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Equals(Object)** - - - -```csharp -public bool Equals(object obj) -``` - -#### Parameters - -`obj` [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)
- -#### Returns - -[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
- -### **GetHashCode()** - - - -```csharp -public int GetHashCode() -``` - -#### Returns - -[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
diff --git a/API-Reference/Flow.Launcher.Plugin/query.md b/API-Reference/Flow.Launcher.Plugin/query.md deleted file mode 100644 index 3ecd4e6..0000000 --- a/API-Reference/Flow.Launcher.Plugin/query.md +++ /dev/null @@ -1,181 +0,0 @@ -# Query - -Namespace: Flow.Launcher.Plugin - - - -```csharp -public class Query -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Query](query.md) - -## Fields - -### **TermSeperater** - -Query can be splited into multiple terms by whitespace - -```csharp -public static string TermSeperater; -``` - -### **ActionKeywordSeperater** - -User can set multiple action keywords seperated by ';' - -```csharp -public static string ActionKeywordSeperater; -``` - -### **GlobalPluginWildcardSign** - -'*' is used for System Plugin - -```csharp -public static string GlobalPluginWildcardSign; -``` - -## Properties - -### **RawQuery** - -Raw query, this includes action keyword if it has - We didn't recommend use this property directly. You should always use Search property. - -```csharp -public string RawQuery { get; internal set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Search** - -Search part of a query. - This will not include action keyword if exclusive plugin gets it, otherwise it should be same as RawQuery. - Since we allow user to switch a exclusive plugin to generic plugin, - so this property will always give you the "real" query part of the query - -```csharp -public string Search { get; internal set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Terms** - -The raw query splited into a string array. - -```csharp -public String[] Terms { get; set; } -``` - -#### Property Value - -[String[]](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ActionKeyword** - - - -```csharp -public string ActionKeyword { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **FirstSearch** - -Return first search split by space if it has - -```csharp -public string FirstSearch { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **SecondToEndSearch** - -strings from second search (including) to last search - -```csharp -public string SecondToEndSearch { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **SecondSearch** - -Return second search split by space if it has - -```csharp -public string SecondSearch { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ThirdSearch** - -Return third search split by space if it has - -```csharp -public string ThirdSearch { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Constructors - -### **Query()** - - - -```csharp -public Query() -``` - -### **Query(String, String, String[], String)** - -to allow unit tests for plug ins - -```csharp -public Query(string rawQuery, string search, String[] terms, string actionKeyword) -``` - -#### Parameters - -`rawQuery` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -`search` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -`terms` [String[]](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -`actionKeyword` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Methods - -### **ToString()** - - - -```csharp -public string ToString() -``` - -#### Returns - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
diff --git a/API-Reference/Flow.Launcher.Plugin/result.md b/API-Reference/Flow.Launcher.Plugin/result.md deleted file mode 100644 index d1e86b3..0000000 --- a/API-Reference/Flow.Launcher.Plugin/result.md +++ /dev/null @@ -1,231 +0,0 @@ -# Result - -Namespace: Flow.Launcher.Plugin - - - -```csharp -public class Result -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Result](result.md) - -## Fields - -### **Icon** - -Delegate version of IcoPath. You can use either Icon or IcoPath to display image for the result. - -```csharp -public IconDelegate Icon; -``` - -## Properties - -### **Title** - -Provides the title of the result. This is always required. - -```csharp -public string Title { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **SubTitle** - -Provides additional details for the result. This is optional - -```csharp -public string SubTitle { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ActionKeywordAssigned** - -This holds the action keyword that triggered the result. - If result is triggered by global keyword: *, this should be empty. - -```csharp -public string ActionKeywordAssigned { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **IcoPath** - -Relative Path (plugin directory) to the Image displayed for the current Result. - -```csharp -public string IcoPath { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Action** - -return true to hide flowlauncher after select result - -```csharp -public Func Action { get; set; } -``` - -#### Property Value - -[Func<ActionContext, Boolean>](https://docs.microsoft.com/en-us/dotnet/api/system.func-2)
- -### **Score** - -An int value showing the priority of the current result. It can be used to sort multiple results. - -```csharp -public int Score { get; set; } -``` - -#### Property Value - -[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
- -### **TitleHighlightData** - -A list of indexes for the characters to be highlighted in Title - -```csharp -public IList TitleHighlightData { get; set; } -``` - -#### Property Value - -[IList<Int32>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ilist-1)
- -### **AutoCompleteText** -Full text display in the query window when autocomplete is triggered - -```csharp -public string AutoCompleteText { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **PluginDirectory** - -Plugin directory - -```csharp -public string PluginDirectory { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ContextData** - -Additional data associate with this result - -```csharp -public object ContextData { get; set; } -``` - -#### Property Value - -[Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)
- -### **PluginID** - -Plugin ID that generated this result - -```csharp -public string PluginID { get; internal set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **TitleToolTip** - -Show message as ToolTip on result Title hover over - -```csharp -public string TitleToolTip { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **SubTitleToolTip** - -Show message as ToolTip on result SubTitle hover over - -```csharp -public string SubTitleToolTip { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Constructors - -### **Result()** - - - -```csharp -public Result() -``` - -## Methods - -### **Equals(Object)** - - - -```csharp -public bool Equals(object obj) -``` - -#### Parameters - -`obj` [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)
- -#### Returns - -[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
- -### **GetHashCode()** - - - -```csharp -public int GetHashCode() -``` - -#### Returns - -[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
- -### **ToString()** - - - -```csharp -public string ToString() -``` - -#### Returns - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
diff --git a/API-Reference/Flow.Launcher.Plugin/resultupdatedeventargs.md b/API-Reference/Flow.Launcher.Plugin/resultupdatedeventargs.md deleted file mode 100644 index 746d957..0000000 --- a/API-Reference/Flow.Launcher.Plugin/resultupdatedeventargs.md +++ /dev/null @@ -1,39 +0,0 @@ -# ResultUpdatedEventArgs - -Namespace: Flow.Launcher.Plugin - - - -```csharp -public class ResultUpdatedEventArgs : System.EventArgs -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EventArgs](https://docs.microsoft.com/en-us/dotnet/api/system.eventargs) → [ResultUpdatedEventArgs](resultupdatedeventargs.md) - -## Fields - -### **Results** - - - -```csharp -public List Results; -``` - -### **Query** - - - -```csharp -public Query Query; -``` - -## Constructors - -### **ResultUpdatedEventArgs()** - - - -```csharp -public ResultUpdatedEventArgs() -``` diff --git a/API-Reference/Flow.Launcher.Plugin/specialkeystate.md b/API-Reference/Flow.Launcher.Plugin/specialkeystate.md deleted file mode 100644 index 44620e7..0000000 --- a/API-Reference/Flow.Launcher.Plugin/specialkeystate.md +++ /dev/null @@ -1,71 +0,0 @@ -# SpecialKeyState - -Namespace: Flow.Launcher.Plugin - - - -```csharp -public class SpecialKeyState -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [SpecialKeyState](specialkeystate.md) - -## Properties - -### **CtrlPressed** - - - -```csharp -public bool CtrlPressed { get; set; } -``` - -#### Property Value - -[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
- -### **ShiftPressed** - - - -```csharp -public bool ShiftPressed { get; set; } -``` - -#### Property Value - -[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
- -### **AltPressed** - - - -```csharp -public bool AltPressed { get; set; } -``` - -#### Property Value - -[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
- -### **WinPressed** - - - -```csharp -public bool WinPressed { get; set; } -``` - -#### Property Value - -[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
- -## Constructors - -### **SpecialKeyState()** - - - -```csharp -public SpecialKeyState() -``` diff --git a/API-Reference/README.md b/API-Reference/README.md deleted file mode 100644 index 17802de..0000000 --- a/API-Reference/README.md +++ /dev/null @@ -1,9 +0,0 @@ -## API Reference - -- [Flow.Launcher.Plugin](Flow.Launcher.Plugin.md) - - -- [Flow.Launcher.Plugin.SharedCommands](Flow.Launcher.Plugin.SharedCommands.md) - - -- [Flow.Launcher.Plugin.SharedModels](Flow.Launcher.Plugin.SharedModels.md) \ No newline at end of file diff --git a/API-Reference/_sidebar.md b/API-Reference/_sidebar.md deleted file mode 100644 index 1282571..0000000 --- a/API-Reference/_sidebar.md +++ /dev/null @@ -1,3 +0,0 @@ -- [Flow.Launcher.Plugin](Flow.Launcher.Plugin.md) -- [Flow.Launcher.Plugin.SharedCommands](Flow.Launcher.Plugin.SharedCommands.md) -- [Flow.Launcher.Plugin.SharedModels](Flow.Launcher.Plugin.SharedModels.md) \ No newline at end of file diff --git a/_sidebar.md b/_sidebar.md index 2f75965..dd4a91d 100644 --- a/_sidebar.md +++ b/_sidebar.md @@ -5,7 +5,7 @@ - [**plugin.json**](/plugin.json.md) - Dotnet Plugins - [**Development Guide**](/develop-dotnet-plugins.md) - - [**API Reference**](API-Reference/) + - [**API Reference**](/API-Reference/Flow.Launcher.Plugin.md) - Python Plugins - [**Before you start**](/py-develop-plugins.md) - [**Set up your project**](/py-setup-project.md) diff --git a/develop-dotnet-plugins.md b/develop-dotnet-plugins.md index 164e7df..aa4d4b8 100644 --- a/develop-dotnet-plugins.md +++ b/develop-dotnet-plugins.md @@ -69,3 +69,6 @@ Implementing **IResultUpdated** provides a way to return part of the query resul To early return a result to Flow, you will need to invoke `ResultUpdated` event with an `ResultUpdatedEventArgs`, which includes the current `Query` object and the List of `Result` objects similar to the return value in `Query(Async)`. +### [IDisposable](https://docs.microsoft.com/en-us/dotnet/api/system.idisposable) *Flow 1.8.0 or higher* + +Implementing **IDisposable** to dispose unmanaged resource in the plugin. `Dispose()` will be called when Flow exit. \ No newline at end of file