starred/Electron.NET
1
0
Fork 0
mirror of https://github.com/ElectronNET/Electron.NET.git synced 2026-02-14 05:34:48 +00:00
Code Issues 668 Packages Projects Releases 20 Wiki Activity

App API:

Browse Source 
* Summaries rewritten
* Added new parameters / Removed not supported parameters
* Added some new methods like appFocus(options), appHasSingleLock, etc.
This commit is contained in:
Konstantin Gross
2020-05-31 03:09:54 +02:00
parent 1ab48350e1
commit eee84d214e
22 changed files with 655 additions and 507 deletions
Download Patch File Download Diff File Expand all files Collapse all files

831
ElectronNET.API/App.cs
View File

File diff suppressed because it is too large Load Diff

21
ElectronNET.API/Entities/AboutPanelOptions.cs
View File

@@ -1,7 +1,7 @@
namespace ElectronNET.API.Entities
{
/// <summary>
///
/// About panel options.
/// </summary>
public class AboutPanelOptions
{
@@ -20,14 +20,29 @@
/// </summary>
public string Copyright { get; set; }
/// <summary>
/// The app's build version number.
/// </summary>
public string Version { get; set; }
/// <summary>
/// Credit information.
/// </summary>
public string Credits { get; set; }
/// <summary>
/// The app's build version number.
/// List of app authors.
/// </summary>
public string Version { get; set; }
public string[] Authors { get; set; }
/// <summary>
/// The app's website.
/// </summary>
public string Website { get; set; }
/// <summary>
/// Path to the app's icon. On Linux, will be shown as 64x64 pixels while retaining aspect ratio.
/// </summary>
public string IconPath { get; set; }
}
}

10
ElectronNET.API/Entities/CPUUsage.cs
View File

@@ -5,15 +5,15 @@
/// </summary>
public class CPUUsage
{
/// <summary>
/// Percentage of CPU used since the last call to getCPUUsage. First call returns 0.
/// </summary>
public int PercentCPUUsage { get; set; }
/// <summary>
/// The number of average idle cpu wakeups per second since the last call to
/// getCPUUsage.First call returns 0.
/// </summary>
public int IdleWakeupsPerSecond { get; set; }
/// <summary>
/// Percentage of CPU used since the last call to getCPUUsage. First call returns 0.
/// </summary>
public int PercentCPUUsage { get; set; }
}
}

15
ElectronNET.API/Entities/FocusOptions.cs Normal file
View File

@@ -0,0 +1,15 @@
namespace ElectronNET.API.Entities
{
/// <summary>
/// Controls the behavior of <see cref="App.Focus(FocusOptions)"/>.
/// </summary>
public class FocusOptions
{
/// <summary>
/// Make the receiver the active app even if another app is currently active.
/// <para/>
/// You should seek to use the <see cref="Steal"/> option as sparingly as possible.
/// </summary>
public bool Steal { get; set; }
}
}

26
ElectronNET.API/Entities/GPUFeatureStatus.cs
View File

@@ -8,77 +8,77 @@ namespace ElectronNET.API.Entities
public class GPUFeatureStatus
{
/// <summary>
/// Canvas
/// Canvas.
/// </summary>
[JsonProperty("2d_canvas")]
public string Canvas { get; set; }
/// <summary>
/// Flash
/// Flash.
/// </summary>
[JsonProperty("flash_3d")]
public string Flash3D { get; set; }
/// <summary>
/// Flash Stage3D
/// Flash Stage3D.
/// </summary>
[JsonProperty("flash_stage3d")]
public string FlashStage3D { get; set; }
/// <summary>
/// Flash Stage3D Baseline profile
/// Flash Stage3D Baseline profile.
/// </summary>
[JsonProperty("flash_stage3d_baseline")]
public string FlashStage3dBaseline { get; set; }
/// <summary>
/// Compositing
/// Compositing.
/// </summary>
[JsonProperty("gpu_compositing")]
public string GpuCompositing { get; set; }
/// <summary>
/// Multiple Raster Threads
/// Multiple Raster Threads.
/// </summary>
[JsonProperty("multiple_raster_threads")]
public string MultipleRasterThreads { get; set; }
/// <summary>
/// Native GpuMemoryBuffers
/// Native GpuMemoryBuffers.
/// </summary>
[JsonProperty("native_gpu_memory_buffers")]
public string NativeGpuMemoryBuffers { get; set; }
/// <summary>
/// Rasterization
/// Rasterization.
/// </summary>
public string Rasterization { get; set; }
/// <summary>
/// Video Decode
/// Video Decode.
/// </summary>
[JsonProperty("video_decode")]
public string VideoDecode { get; set; }
/// <summary>
/// Video Encode
/// Video Encode.
/// </summary>
[JsonProperty("video_encode")]
public string VideoEncode { get; set; }
/// <summary>
/// VPx Video Decode
/// VPx Video Decode.
/// </summary>
[JsonProperty("vpx_decode")]
public string VpxDecode { get; set; }
/// <summary>
/// WebGL
/// WebGL.
/// </summary>
public string Webgl { get; set; }
/// <summary>
/// WebGL2
/// WebGL2.
/// </summary>
public string Webgl2 { get; set; }
}

7
ElectronNET.API/Entities/JumpListCategory.cs
View File

@@ -1,8 +1,7 @@
using ElectronNET.API.Entities;
using Newtonsoft.Json;
using Newtonsoft.Json;
using Newtonsoft.Json.Converters;
namespace ElectronNET.API
namespace ElectronNET.API.Entities
{
/// <summary>
///
@@ -25,4 +24,4 @@ namespace ElectronNET.API
[JsonConverter(typeof(StringEnumConverter))]
public JumpListCategoryType Type { get; set; }
}
}
}

2
ElectronNET.API/Entities/JumpListCategoryType.cs
View File

@@ -1,4 +1,4 @@
namespace ElectronNET.API
namespace ElectronNET.API.Entities
{
/// <summary>
///

9
ElectronNET.API/Entities/JumpListSettings.cs
View File

@@ -6,13 +6,16 @@
public class JumpListSettings
{
/// <summary>
/// The minimum number of items that will be shown in the Jump List (for a more detailed description of this value see the MSDN docs).
/// The minimum number of items that will be shown in the Jump List (for a more detailed description of this value see the
/// <see href="https://msdn.microsoft.com/en-us/library/windows/desktop/dd378398(v=vs.85).aspx">MSDN</see> docs).
/// </summary>
public int MinItems { get; set; } = 0;
/// <summary>
/// Array of JumpListItem objects that correspond to items that the user has explicitly removed from custom categories in the Jump List. These items must not be re-added to the Jump List in the next call to app.setJumpList(), Windows will not display any custom category that contains any of the removed items.
/// Array of JumpListItem objects that correspond to items that the user has explicitly removed from custom categories
/// in the Jump List. These items must not be re-added to the Jump List in the next call to <see cref="App.SetJumpList"/>, Windows will
/// not display any custom category that contains any of the removed items.
/// </summary>
public JumpListItem[] RemovedItems { get; set; } = new JumpListItem[0];
}
}
}

22
ElectronNET.API/Entities/LoginItemSettings.cs
View File

@@ -6,33 +6,33 @@
public class LoginItemSettings
{
/// <summary>
/// true if the app is set to open at login.
/// <see langword="true"/> if the app is set to open at login.
/// </summary>
public bool OpenAtLogin { get; set; }
/// <summary>
/// true if the app is set to open as hidden at login. This setting is only
/// supported on macOS.
/// <see langword="true"/> if the app is set to open as hidden at login. This setting is not available
/// on <see href="https://www.electronjs.org/docs/tutorial/mac-app-store-submission-guide">MAS builds</see>.
/// </summary>
public bool OpenAsHidden { get; set; }
/// <summary>
/// true if the app was opened at login automatically. This setting is only
/// supported on macOS.
/// <see langword="true"/> if the app was opened at login automatically. This setting is not available
/// on <see href="https://www.electronjs.org/docs/tutorial/mac-app-store-submission-guide">MAS builds</see>.
/// </summary>
public bool WasOpenedAtLogin { get; set; }
/// <summary>
/// true if the app was opened as a hidden login item. This indicates that the app
/// should not open any windows at startup.This setting is only supported on macOS.
/// <see langword="true"/> if the app was opened as a hidden login item. This indicates that the app should not
/// open any windows at startup. This setting is not available on
/// <see href="https://www.electronjs.org/docs/tutorial/mac-app-store-submission-guide">MAS builds</see>.
/// </summary>
public bool WasOpenedAsHidden { get; set; }
/// <summary>
/// true if the app was opened as a login item that should restore the state from
/// the previous session.This indicates that the app should restore the windows
/// that were open the last time the app was closed.This setting is only supported
/// on macOS.
/// <see langword="true"/> if the app was opened as a login item that should restore the state from the previous
/// session. This indicates that the app should restore the windows that were open the last time the app was closed.
/// This setting is not available on <see href="https://www.electronjs.org/docs/tutorial/mac-app-store-submission-guide">MAS builds</see>.
/// </summary>
public bool RestoreState { get; set; }
}

11
ElectronNET.API/Entities/LoginSettings.cs
View File

@@ -6,16 +6,15 @@
public class LoginSettings
{
/// <summary>
/// true to open the app at login, false to remove the app as a login item. Defaults
/// to false.
/// <see langword="true"/> to open the app at login, <see langword="false"/> to remove the app as a login item.
/// Defaults to <see langword="false"/>.
/// </summary>
public bool OpenAtLogin { get; set; }
/// <summary>
/// true to open the app as hidden. Defaults to false. The user can edit this
/// setting from the System Preferences so
/// app.getLoginItemStatus().wasOpenedAsHidden should be checked when the app is
/// opened to know the current value.This setting is only supported on macOS.
/// <see langword="true"/> to open the app as hidden. Defaults to <see langword="false"/>. The user can edit this
/// setting from the System Preferences so app.getLoginItemSettings().wasOpenedAsHidden should be checked when the app is
/// opened to know the current value. This setting is not available on <see href="https://www.electronjs.org/docs/tutorial/mac-app-store-submission-guide">MAS builds</see>.
/// </summary>
public bool OpenAsHidden { get; set; }

22
ElectronNET.API/Entities/MemoryInfo.cs
View File

@@ -6,31 +6,19 @@
public class MemoryInfo
{
/// <summary>
/// The maximum amount of memory that has ever been pinned to actual physical RAM.
/// On macOS its value will always be 0.
/// The amount of memory currently pinned to actual physical RAM.
/// </summary>
public int PeakWorkingSetSize { get; set; }
public int WorkingSetSize { get; set; }
/// <summary>
/// Process id of the process.
/// The maximum amount of memory that has ever been pinned to actual physical RAM.
/// </summary>
public int Pid { get; set; }
public int PeakWorkingSetSize { get; set; }
/// <summary>
/// The amount of memory not shared by other processes, such as JS heap or HTML
/// content.
/// </summary>
public int PrivateBytes { get; set; }
/// <summary>
/// The amount of memory shared between processes, typically memory consumed by the
/// Electron code itself
/// </summary>
public int SharedBytes { get; set; }
/// <summary>
/// The amount of memory currently pinned to actual physical RAM.
/// </summary>
public int WorkingSetSize {get; set; }
}
}
}

50
ElectronNET.API/Entities/PathName.cs
View File

@@ -1,79 +1,95 @@
namespace ElectronNET.API.Entities
using System.ComponentModel;
namespace ElectronNET.API.Entities
{
/// <summary>
///
/// Defines the PathName enumeration.
/// </summary>
public enum PathName
{
/// <summary>
/// User’s home directory.
/// </summary>
home,
[Description("home")]
Home,
/// <summary>
/// Per-user application data directory.
/// </summary>
appData,
[Description("appData")]
AppData,
/// <summary>
/// The directory for storing your app’s configuration files,
/// which by default it is the appData directory appended with your app’s name.
/// </summary>
userData,
[Description("userData")]
UserData,
/// <summary>
/// Temporary directory.
/// </summary>
temp,
[Description("temp")]
Temp,
/// <summary>
/// The current executable file.
/// </summary>
exe,
[Description("exe")]
Exe,
/// <summary>
/// The libchromiumcontent library.
/// </summary>
module,
[Description("Module")]
Module,
/// <summary>
/// The current user’s Desktop directory.
/// </summary>
desktop,
[Description("desktop")]
Desktop,
/// <summary>
/// Directory for a user’s “My Documents”.
/// </summary>
documents,
[Description("documents")]
Documents,
/// <summary>
/// Directory for a user’s downloads.
/// </summary>
downloads,
[Description("downloads")]
Downloads,
/// <summary>
/// Directory for a user’s music.
/// </summary>
music,
[Description("music")]
Music,
/// <summary>
/// Directory for a user’s pictures.
/// </summary>
pictures,
[Description("pictures")]
Pictures,
/// <summary>
/// Directory for a user’s videos.
/// </summary>
videos,
[Description("videos")]
Videos,
/// <summary>
/// The logs
/// The logs.
/// </summary>
logs,
[Description("logs")]
Logs,
/// <summary>
/// Full path to the system version of the Pepper Flash plugin.
/// </summary>
pepperFlashSystemPlugin
[Description("PepperFlashSystemPlugin")]
PepperFlashSystemPlugin
}
}

52
ElectronNET.API/Entities/ProcessMetric.cs
View File

@@ -5,24 +5,42 @@
/// </summary>
public class ProcessMetric
{
/// <summary>
/// CPU usage of the process.
/// </summary>
public CPUUsage Cpu { get; set; }
/// <summary>
/// Process id of the process.
/// </summary>
public int PId { get; set; }
/// <summary>
/// Memory information for the process.
/// </summary>
public MemoryInfo Memory {get; set;}
/// <summary>
/// Process type (Browser or Tab or GPU etc).
/// </summary>
public string Type { get; set; }
/// <summary>
/// Process id of the process.
/// </summary>
public int Pid { get; set; }
/// <summary>
/// CPU usage of the process.
/// </summary>
public CPUUsage Cpu { get; set; }
/// <summary>
/// Process type (Browser or Tab or GPU etc).
/// </summary>
public string Type { get; set; }
/// <summary>
/// Creation time for this process. The time is represented as number of milliseconds since epoch.
/// Since the <see cref="PId"/> can be reused after a process dies, it is useful to use both the <see cref="PId"/>
/// and the <see cref="CreationTime"/> to uniquely identify a process.
/// </summary>
public int CreationTime { get; set; }
/// <summary>
/// Memory information for the process.
/// </summary>
public MemoryInfo Memory { get; set; }
/// <summary>
/// Whether the process is sandboxed on OS level.
/// </summary>
public bool Sandboxed { get; set; }
/// <summary>
/// One of the following values:
/// untrusted | low | medium | high | unknown
/// </summary>
public string IntegrityLevel { get; set; }
}
}
}

4
ElectronNET.API/Entities/RelaunchOptions.cs
View File

@@ -1,7 +1,7 @@
namespace ElectronNET.API.Entities
{
/// <summary>
///
/// Controls the behavior of <see cref="App.Relaunch(RelaunchOptions)"/>.
/// </summary>
public class RelaunchOptions
{
@@ -21,4 +21,4 @@
/// </value>
public string ExecPath { get; set; }
}
}
}

7
ElectronNET.API/Entities/UserTask.cs
View File

@@ -52,5 +52,10 @@
/// The title.
/// </value>
public string Title { get; set; }
/// <summary>
/// The working directory. Default is <see cref="string.Empty"/>.
/// </summary>
public string WorkingDirectory { get; set; }
}
}
}

4
ElectronNET.API/QuitEventArgs.cs
View File

@@ -1,7 +1,7 @@
namespace ElectronNET.API
{
/// <summary>
///
/// Event arguments for the <see cref="App.BeforeQuit"/> / <see cref="App.WillQuit"/> event.
/// </summary>
public sealed class QuitEventArgs
{
@@ -13,4 +13,4 @@
Electron.App.PreventQuit();
}
}
}
}