Skip to content

Commit 03d77d1

Browse files
jjw24jjw24
authored
Merge pull request #42 from Flow-Launcher/CSharpPluginDoc
Update C# API Docs
2 parents b485544 + 68dcbd5 commit 03d77d1

File tree

227 files changed

+3090
-2391
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

227 files changed

+3090
-2391
lines changed

‎API-Reference/Flow.Launcher.Plugin.SharedCommands.md‎

Lines changed: 0 additions & 9 deletions
This file was deleted.

‎API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# FilesFolders class
2+
3+
```csharp
4+
public static class FilesFolders
5+
```
6+
7+
## Public Members
8+
9+
| name | description |
10+
| --- | --- |
11+
| static [CopyAll](FilesFolders/CopyAll.md)(…) | Copies the folder and all of its files and folders including subfolders to the target location |
12+
| static [FileExists](FilesFolders/FileExists.md)(…) | |
13+
| 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 |
14+
| 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. |
15+
| static [LocationExists](FilesFolders/LocationExists.md)(…) | |
16+
| static [OpenContainingFolder](FilesFolders/OpenContainingFolder.md)(…) | |
17+
| static [OpenPath](FilesFolders/OpenPath.md)(…) | |
18+
| static [RemoveFolderIfExists](FilesFolders/RemoveFolderIfExists.md)(…) | |
19+
| 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 |
20+
| static [VerifyBothFolderFilesEqual](FilesFolders/VerifyBothFolderFilesEqual.md)(…) | |
21+
22+
## See Also
23+
24+
* namespace [Flow.Launcher.Plugin.SharedCommands](../Flow.Launcher.Plugin.md)
25+
26+
<!-- DO NOT EDIT: generated by xmldocmd for Flow.Launcher.Plugin.dll -->

‎API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/CopyAll.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# FilesFolders.CopyAll method
2+
3+
Copies the folder and all of its files and folders including subfolders to the target location
4+
5+
```csharp
6+
public static void CopyAll(this string sourcePath, string targetPath)
7+
```
8+
9+
| parameter | description |
10+
| --- | --- |
11+
| sourcePath | |
12+
| targetPath | |
13+
14+
## See Also
15+
16+
* class [FilesFolders](../FilesFolders.md)
17+
* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md)
18+
19+
<!-- DO NOT EDIT: generated by xmldocmd for Flow.Launcher.Plugin.dll -->

‎API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/FileExists.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# FilesFolders.FileExists method
2+
3+
```csharp
4+
public static bool FileExists(this string filePath)
5+
```
6+
7+
## See Also
8+
9+
* class [FilesFolders](../FilesFolders.md)
10+
* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md)
11+
12+
<!-- DO NOT EDIT: generated by xmldocmd for Flow.Launcher.Plugin.dll -->

‎API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/GetPreviousExistingDirectory.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# FilesFolders.GetPreviousExistingDirectory method
2+
3+
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
4+
5+
```csharp
6+
public static string GetPreviousExistingDirectory(Func<string, bool> locationExists, string path)
7+
```
8+
9+
## See Also
10+
11+
* class [FilesFolders](../FilesFolders.md)
12+
* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md)
13+
14+
<!-- DO NOT EDIT: generated by xmldocmd for Flow.Launcher.Plugin.dll -->

‎API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/IsLocationPathString.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# FilesFolders.IsLocationPathString method
2+
3+
This checks whether a given string is a directory path or network location string. It does not check if location actually exists.
4+
5+
```csharp
6+
public static bool IsLocationPathString(this string querySearchString)
7+
```
8+
9+
## See Also
10+
11+
* class [FilesFolders](../FilesFolders.md)
12+
* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md)
13+
14+
<!-- DO NOT EDIT: generated by xmldocmd for Flow.Launcher.Plugin.dll -->

‎API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/LocationExists.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# FilesFolders.LocationExists method
2+
3+
```csharp
4+
public static bool LocationExists(this string path)
5+
```
6+
7+
## See Also
8+
9+
* class [FilesFolders](../FilesFolders.md)
10+
* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md)
11+
12+
<!-- DO NOT EDIT: generated by xmldocmd for Flow.Launcher.Plugin.dll -->

‎API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/OpenContainingFolder.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# FilesFolders.OpenContainingFolder method
2+
3+
```csharp
4+
public static void OpenContainingFolder(string path)
5+
```
6+
7+
## See Also
8+
9+
* class [FilesFolders](../FilesFolders.md)
10+
* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md)
11+
12+
<!-- DO NOT EDIT: generated by xmldocmd for Flow.Launcher.Plugin.dll -->

‎API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/OpenPath.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# FilesFolders.OpenPath method
2+
3+
```csharp
4+
public static void OpenPath(string fileOrFolderPath)
5+
```
6+
7+
## See Also
8+
9+
* class [FilesFolders](../FilesFolders.md)
10+
* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md)
11+
12+
<!-- DO NOT EDIT: generated by xmldocmd for Flow.Launcher.Plugin.dll -->

‎API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/RemoveFolderIfExists.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# FilesFolders.RemoveFolderIfExists method
2+
3+
```csharp
4+
public static void RemoveFolderIfExists(this string path)
5+
```
6+
7+
## See Also
8+
9+
* class [FilesFolders](../FilesFolders.md)
10+
* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md)
11+
12+
<!-- DO NOT EDIT: generated by xmldocmd for Flow.Launcher.Plugin.dll -->

0 commit comments

Comments
 (0)