Files
Electron.NET/ElectronNET.API/App.cs
2017-10-14 19:57:49 +02:00

1384 lines
57 KiB
C#
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
using ElectronNET.API.Entities;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using Newtonsoft.Json.Serialization;
using System;
using System.Threading.Tasks;
namespace ElectronNET.API
{
public sealed class App
{
/// <summary>
/// Emitted when all windows have been closed.
///
/// If you do not subscribe to this event and all windows are closed,
/// the default behavior is to quit the app; however, if you subscribe,
/// you control whether the app quits or not.If the user pressed Cmd + Q,
/// or the developer called app.quit(), Electron will first try to close
/// all the windows and then emit the will-quit event, and in this case the
/// window-all-closed event would not be emitted.
/// </summary>
public event Action WindowAllClosed
{
add
{
if (_windowAllClosed == null)
{
BridgeConnector.Socket.On("app-window-all-closed", () =>
{
_windowAllClosed();
});
BridgeConnector.Socket.Emit("register-app-window-all-closed-event");
}
_windowAllClosed += value;
}
remove
{
_windowAllClosed -= value;
}
}
private event Action _windowAllClosed;
/// <summary>
/// Emitted before the application starts closing its windows.
///
/// Note: If application quit was initiated by autoUpdater.quitAndInstall() then before-quit is emitted after
/// emitting close event on all windows and closing them.
/// </summary>
public event Action BeforeQuit
{
add
{
if (_beforeQuit == null)
{
BridgeConnector.Socket.On("app-before-quit", () =>
{
_beforeQuit();
});
BridgeConnector.Socket.Emit("register-app-before-quit-event");
}
_beforeQuit += value;
}
remove
{
_beforeQuit -= value;
}
}
private event Action _beforeQuit;
/// <summary>
/// Emitted when all windows have been closed and the application will quit.
///
/// See the description of the window-all-closed event for the differences between the will-quit and
/// window-all-closed events.
/// </summary>
public event Action WillQuit
{
add
{
if (_willQuit == null)
{
BridgeConnector.Socket.On("app-will-quit", () =>
{
_willQuit();
});
BridgeConnector.Socket.Emit("register-app-will-quit-event");
}
_willQuit += value;
}
remove
{
_willQuit -= value;
}
}
private event Action _willQuit;
/// <summary>
/// Emitted when the application is quitting.
/// </summary>
public event Action Quitting
{
add
{
if (_quitting == null)
{
BridgeConnector.Socket.On("app-quit", () =>
{
_quitting();
});
BridgeConnector.Socket.Emit("register-app-quit-event");
}
_quitting += value;
}
remove
{
_quitting -= value;
}
}
private event Action _quitting;
/// <summary>
/// Emitted when a BrowserWindow gets blurred.
/// </summary>
public event Action BrowserWindowBlur
{
add
{
if (_browserWindowBlur == null)
{
BridgeConnector.Socket.On("app-browser-window-blur", () =>
{
_browserWindowBlur();
});
BridgeConnector.Socket.Emit("register-app-browser-window-blur-event");
}
_browserWindowBlur += value;
}
remove
{
_browserWindowBlur -= value;
}
}
private event Action _browserWindowBlur;
/// <summary>
/// Emitted when a BrowserWindow gets focused.
/// </summary>
public event Action BrowserWindowFocus
{
add
{
if (_browserWindowFocus == null)
{
BridgeConnector.Socket.On("app-browser-window-focus", () =>
{
_browserWindowFocus();
});
BridgeConnector.Socket.Emit("register-app-browser-window-focus-event");
}
_browserWindowFocus += value;
}
remove
{
_browserWindowFocus -= value;
}
}
private event Action _browserWindowFocus;
/// <summary>
/// Emitted when a new BrowserWindow is created.
/// </summary>
public event Action BrowserWindowCreated
{
add
{
if (_browserWindowCreated == null)
{
BridgeConnector.Socket.On("app-browser-window-created", () =>
{
_browserWindowCreated();
});
BridgeConnector.Socket.Emit("register-app-browser-window-created-event");
}
_browserWindowCreated += value;
}
remove
{
_browserWindowCreated -= value;
}
}
private event Action _browserWindowCreated;
/// <summary>
/// Emitted when a new webContents is created.
/// </summary>
public event Action WebContentsCreated
{
add
{
if (_webContentsCreated == null)
{
BridgeConnector.Socket.On("app-web-contents-created", () =>
{
_webContentsCreated();
});
BridgeConnector.Socket.Emit("register-app-web-contents-created-event");
}
_webContentsCreated += value;
}
remove
{
_webContentsCreated -= value;
}
}
private event Action _webContentsCreated;
/// <summary>
/// Emitted when Chromes accessibility support changes.
/// This event fires when assistive technologies, such as screen readers, are enabled or disabled.
/// See https://www.chromium.org/developers/design-documents/accessibility for more details.
/// </summary>
public event Action<bool> AccessibilitySupportChanged
{
add
{
if (_accessibilitySupportChanged == null)
{
BridgeConnector.Socket.On("app-accessibility-support-changed", (state) =>
{
_accessibilitySupportChanged((bool)state);
});
BridgeConnector.Socket.Emit("register-app-accessibility-support-changed-event");
}
_accessibilitySupportChanged += value;
}
remove
{
_accessibilitySupportChanged -= value;
}
}
private event Action<bool> _accessibilitySupportChanged;
private App() { }
public static App Instance
{
get
{
if (_app == null)
{
_app = new App();
}
return _app;
}
}
private static App _app;
private JsonSerializer _jsonSerializer = new JsonSerializer()
{
ContractResolver = new CamelCasePropertyNamesContractResolver()
};
// TODO: Auslagern in eigenes Window-Management
public void OpenWindow(int width, int height, bool show)
{
var browserWindowOptions = new BrowserWindowOptions()
{
Height = height,
Width = width,
Show = show
};
BridgeConnector.Socket.Emit("createBrowserWindow", JObject.FromObject(browserWindowOptions, _jsonSerializer));
}
// TODO: Auslagern in eigenes Notification-API
public void CreateNotification(NotificationOptions notificationOptions)
{
BridgeConnector.Socket.Emit("createNotification", JObject.FromObject(notificationOptions, _jsonSerializer));
}
/// <summary>
/// Try to close all windows. The before-quit event will be emitted first. If all
/// windows are successfully closed, the will-quit event will be emitted and by
/// default the application will terminate. This method guarantees that all
/// beforeunload and unload event handlers are correctly executed. It is possible
/// that a window cancels the quitting by returning false in the beforeunload event
/// handler.
/// </summary>
public void Quit()
{
BridgeConnector.Socket.Emit("appQuit");
}
/// <summary>
/// All windows will be closed immediately without asking user and
/// the before-quit and will-quit events will not be emitted.
/// </summary>
/// <param name="exitCode">Exits immediately with exitCode. exitCode defaults to 0.</param>
public void Exit(int exitCode = 0)
{
BridgeConnector.Socket.Emit("appExit", exitCode);
}
/// <summary>
/// Relaunches the app when current instance exits. By default the new instance will
/// use the same working directory and command line arguments with current instance.
/// When args is specified, the args will be passed as command line arguments
/// instead. When execPath is specified, the execPath will be executed for relaunch
/// instead of current app. Note that this method does not quit the app when
/// executed, you have to call app.quit or app.exit after calling app.relaunch to
/// make the app restart. When app.relaunch is called for multiple times, multiple
/// instances will be started after current instance exited.
/// </summary>
public void Relaunch()
{
BridgeConnector.Socket.Emit("appRelaunch");
}
/// <summary>
/// Relaunches the app when current instance exits. By default the new instance will
/// use the same working directory and command line arguments with current instance.
/// When args is specified, the args will be passed as command line arguments
/// instead. When execPath is specified, the execPath will be executed for relaunch
/// instead of current app. Note that this method does not quit the app when
/// executed, you have to call app.quit or app.exit after calling app.relaunch to
/// make the app restart. When app.relaunch is called for multiple times, multiple
/// instances will be started after current instance exited.
/// </summary>
/// <param name="relaunchOptions"></param>
public void Relaunch(RelaunchOptions relaunchOptions)
{
BridgeConnector.Socket.Emit("appRelaunch", JObject.FromObject(relaunchOptions, _jsonSerializer));
}
/// <summary>
/// On Linux, focuses on the first visible window. On macOS, makes the application
/// the active app.On Windows, focuses on the application's first window.
/// </summary>
public void Focus()
{
BridgeConnector.Socket.Emit("appFocus");
}
/// <summary>
/// Hides all application windows without minimizing them.
/// </summary>
public void Hide()
{
BridgeConnector.Socket.Emit("appHide");
}
/// <summary>
/// Shows application windows after they were hidden. Does not automatically focus them.
/// </summary>
public void Show()
{
BridgeConnector.Socket.Emit("appShow");
}
/// <summary>
/// The current application directory.
/// </summary>
/// <returns></returns>
public async Task<string> GetAppPathAsync()
{
var taskCompletionSource = new TaskCompletionSource<string>();
BridgeConnector.Socket.On("appGetAppPathCompleted", (path) =>
{
BridgeConnector.Socket.Off("appGetAppPathCompleted");
taskCompletionSource.SetResult(path.ToString());
});
BridgeConnector.Socket.Emit("appGetAppPath");
return await taskCompletionSource.Task;
}
/// <summary>
/// You can request the following paths by the name.
/// </summary>
/// <param name="pathName"></param>
/// <returns>A path to a special directory or file associated with name.</returns>
public async Task<string> GetPathAsync(PathName pathName)
{
var taskCompletionSource = new TaskCompletionSource<string>();
BridgeConnector.Socket.On("appGetPathCompleted", (path) =>
{
BridgeConnector.Socket.Off("appGetPathCompleted");
taskCompletionSource.SetResult(path.ToString());
});
BridgeConnector.Socket.Emit("appGetPath", pathName.ToString());
return await taskCompletionSource.Task;
}
// TODO: Fertig coden
/// <summary>
/// Fetches a path's associated icon. On Windows, there a 2 kinds of icons: On Linux
/// and macOS, icons depend on the application associated with file mime type.
/// </summary>
/// <param name="filePath"></param>
/// <returns></returns>
//public async static Task<NativeImage> GetFileIconAsync(string filePath)
//{
// var taskCompletionSource = new TaskCompletionSource<NativeImage>();
// BridgeConnector.Socket.On("appGetFileIconCompleted", (results) =>
// {
// BridgeConnector.Socket.Off("appGetFileIconCompleted");
// byte[] test = ((JArray)results).Last.ToObject<byte[]>();
// //object[] result = results as object[];
// //NativeImage nativeImage = (NativeImage)result[1];
// //taskCompletionSource.SetResult(nativeImage);
// });
// BridgeConnector.Socket.Emit("appGetFileIcon", filePath);
// return await taskCompletionSource.Task;
//}
// TODO: Fertig coden
/// <summary>
/// Fetches a path's associated icon. On Windows, there a 2 kinds of icons: On Linux
/// and macOS, icons depend on the application associated with file mime type.
/// </summary>
/// <param name="filePath"></param>
/// <param name="fileIconOptions"></param>
/// <returns></returns>
//public async static Task<NativeImage> GetFileIconAsync(string filePath, FileIconOptions fileIconOptions)
//{
// var taskCompletionSource = new TaskCompletionSource<NativeImage>();
// BridgeConnector.Socket.On("appGetFileIconCompleted", (results) =>
// {
// BridgeConnector.Socket.Off("appGetFileIconCompleted");
// object[] result = results as object[];
// NativeImage nativeImage = (NativeImage)result[1];
// taskCompletionSource.SetResult(nativeImage);
// });
// BridgeConnector.Socket.Emit("appGetFileIcon", filePath, JObject.FromObject(fileIconOptions, _jsonSerializer));
// return await taskCompletionSource.Task;
//}
/// <summary>
/// Overrides the path to a special directory or file associated with name. If the
/// path specifies a directory that does not exist, the directory will be created by
/// this method.On failure an Error is thrown.You can only override paths of a
/// name defined in app.getPath. By default, web pages' cookies and caches will be
/// stored under the userData directory.If you want to change this location, you
/// have to override the userData path before the ready event of the app module is emitted.
/// </summary>
/// <param name="name"></param>
/// <param name="path"></param>
public void SetPath(string name, string path)
{
BridgeConnector.Socket.Emit("appSetPath", name, path);
}
/// <summary>
/// The version of the loaded application.
/// If no version is found in the applications package.json file,
/// the version of the current bundle or executable is returned.
/// </summary>
/// <returns></returns>
public async Task<string> GetVersionAsync()
{
var taskCompletionSource = new TaskCompletionSource<string>();
BridgeConnector.Socket.On("appGetVersionCompleted", (version) =>
{
BridgeConnector.Socket.Off("appGetVersionCompleted");
taskCompletionSource.SetResult(version.ToString());
});
BridgeConnector.Socket.Emit("appGetVersion");
return await taskCompletionSource.Task;
}
/// <summary>
/// Usually the name field of package.json is a short lowercased name, according to
/// the npm modules spec. You should usually also specify a productName field, which
/// is your application's full capitalized name, and which will be preferred over
/// name by Electron.
/// </summary>
/// <returns>The current applications name, which is the name in the applications package.json file.</returns>
public async Task<string> GetNameAsync()
{
var taskCompletionSource = new TaskCompletionSource<string>();
BridgeConnector.Socket.On("appGetNameCompleted", (name) =>
{
BridgeConnector.Socket.Off("appGetNameCompleted");
taskCompletionSource.SetResult(name.ToString());
});
BridgeConnector.Socket.Emit("appGetName");
return await taskCompletionSource.Task;
}
/// <summary>
/// Overrides the current application's name.
/// </summary>
/// <param name="name">Application's name</param>
public void SetName(string name)
{
BridgeConnector.Socket.Emit("appSetName", name);
}
/// <summary>
/// The current application locale.
/// Note: When distributing your packaged app, you have to also ship the locales
/// folder.Note: On Windows you have to call it after the ready events gets emitted.
/// </summary>
/// <returns></returns>
public async Task<string> GetLocaleAsync()
{
var taskCompletionSource = new TaskCompletionSource<string>();
BridgeConnector.Socket.On("appGetLocaleCompleted", (locale) =>
{
BridgeConnector.Socket.Off("appGetLocaleCompleted");
taskCompletionSource.SetResult(locale.ToString());
});
BridgeConnector.Socket.Emit("appGetLocale");
return await taskCompletionSource.Task;
}
/// <summary>
/// Adds path to the recent documents list. This list is managed by the OS. On
/// Windows you can visit the list from the task bar, and on macOS you can visit it
/// from dock menu.
/// </summary>
/// <param name="path"></param>
public void AddRecentDocument(string path)
{
BridgeConnector.Socket.Emit("appAddRecentDocument", path);
}
/// <summary>
/// Clears the recent documents list.
/// </summary>
public void ClearRecentDocuments()
{
BridgeConnector.Socket.Emit("appClearRecentDocuments");
}
/// <summary>
/// This method sets the current executable as the default handler for a protocol
/// (aka URI scheme). It allows you to integrate your app deeper into the operating
/// system.Once registered, all links with your-protocol:// will be opened with the
/// current executable. The whole link, including protocol, will be passed to your
/// application as a parameter. On Windows you can provide optional parameters path,
/// the path to your executable, and args, an array of arguments to be passed to
/// your executable when it launches.Note: On macOS, you can only register
/// protocols that have been added to your app's info.plist, which can not be
/// modified at runtime.You can however change the file with a simple text editor
/// or script during build time. Please refer to Apple's documentation for details.
/// The API uses the Windows Registry and LSSetDefaultHandlerForURLScheme
/// internally.
/// </summary>
/// <param name="protocol">The name of your protocol, without ://.
/// If you want your app to handle electron:// links,
/// call this method with electron as the parameter.</param>
/// <returns>Whether the call succeeded.</returns>
public async Task<bool> SetAsDefaultProtocolClientAsync(string protocol)
{
var taskCompletionSource = new TaskCompletionSource<bool>();
BridgeConnector.Socket.On("appSetAsDefaultProtocolClientCompleted", (success) =>
{
BridgeConnector.Socket.Off("appSetAsDefaultProtocolClientCompleted");
taskCompletionSource.SetResult((bool)success);
});
BridgeConnector.Socket.Emit("appSetAsDefaultProtocolClient", protocol);
return await taskCompletionSource.Task;
}
/// <summary>
/// This method sets the current executable as the default handler for a protocol
/// (aka URI scheme). It allows you to integrate your app deeper into the operating
/// system.Once registered, all links with your-protocol:// will be opened with the
/// current executable. The whole link, including protocol, will be passed to your
/// application as a parameter. On Windows you can provide optional parameters path,
/// the path to your executable, and args, an array of arguments to be passed to
/// your executable when it launches.Note: On macOS, you can only register
/// protocols that have been added to your app's info.plist, which can not be
/// modified at runtime.You can however change the file with a simple text editor
/// or script during build time. Please refer to Apple's documentation for details.
/// The API uses the Windows Registry and LSSetDefaultHandlerForURLScheme
/// internally.
/// </summary>
/// <param name="protocol">The name of your protocol, without ://.
/// If you want your app to handle electron:// links,
/// call this method with electron as the parameter.</param>
/// <param name="path">Defaults to process.execPath</param>
/// <returns>Whether the call succeeded.</returns>
public async Task<bool> SetAsDefaultProtocolClientAsync(string protocol, string path)
{
var taskCompletionSource = new TaskCompletionSource<bool>();
BridgeConnector.Socket.On("appSetAsDefaultProtocolClientCompleted", (success) =>
{
BridgeConnector.Socket.Off("appSetAsDefaultProtocolClientCompleted");
taskCompletionSource.SetResult((bool)success);
});
BridgeConnector.Socket.Emit("appSetAsDefaultProtocolClient", protocol, path);
return await taskCompletionSource.Task;
}
/// <summary>
/// This method sets the current executable as the default handler for a protocol
/// (aka URI scheme). It allows you to integrate your app deeper into the operating
/// system.Once registered, all links with your-protocol:// will be opened with the
/// current executable. The whole link, including protocol, will be passed to your
/// application as a parameter. On Windows you can provide optional parameters path,
/// the path to your executable, and args, an array of arguments to be passed to
/// your executable when it launches.Note: On macOS, you can only register
/// protocols that have been added to your app's info.plist, which can not be
/// modified at runtime.You can however change the file with a simple text editor
/// or script during build time. Please refer to Apple's documentation for details.
/// The API uses the Windows Registry and LSSetDefaultHandlerForURLScheme
/// internally.
/// </summary>
/// <param name="protocol">The name of your protocol, without ://.
/// If you want your app to handle electron:// links,
/// call this method with electron as the parameter.</param>
/// <param name="path">Defaults to process.execPath</param>
/// <param name="args">Defaults to an empty array</param>
/// <returns>Whether the call succeeded.</returns>
public async Task<bool> SetAsDefaultProtocolClientAsync(string protocol, string path, string[] args)
{
var taskCompletionSource = new TaskCompletionSource<bool>();
BridgeConnector.Socket.On("appSetAsDefaultProtocolClientCompleted", (success) =>
{
BridgeConnector.Socket.Off("appSetAsDefaultProtocolClientCompleted");
taskCompletionSource.SetResult((bool)success);
});
BridgeConnector.Socket.Emit("appSetAsDefaultProtocolClient", protocol, path, args);
return await taskCompletionSource.Task;
}
/// <summary>
/// This method checks if the current executable as the default handler for a
/// protocol(aka URI scheme). If so, it will remove the app as the default handler.
/// </summary>
/// <param name="protocol">The name of your protocol, without ://.</param>
/// <returns>Whether the call succeeded.</returns>
public async Task<bool> RemoveAsDefaultProtocolClientAsync(string protocol)
{
var taskCompletionSource = new TaskCompletionSource<bool>();
BridgeConnector.Socket.On("appRemoveAsDefaultProtocolClientCompleted", (success) =>
{
BridgeConnector.Socket.Off("appRemoveAsDefaultProtocolClientCompleted");
taskCompletionSource.SetResult((bool)success);
});
BridgeConnector.Socket.Emit("appRemoveAsDefaultProtocolClient", protocol);
return await taskCompletionSource.Task;
}
/// <summary>
/// This method checks if the current executable as the default handler for a
/// protocol(aka URI scheme). If so, it will remove the app as the default handler.
/// </summary>
/// <param name="protocol">The name of your protocol, without ://.</param>
/// <param name="path">Defaults to process.execPath.</param>
/// <returns>Whether the call succeeded.</returns>
public async Task<bool> RemoveAsDefaultProtocolClientAsync(string protocol, string path)
{
var taskCompletionSource = new TaskCompletionSource<bool>();
BridgeConnector.Socket.On("appRemoveAsDefaultProtocolClientCompleted", (success) =>
{
BridgeConnector.Socket.Off("appRemoveAsDefaultProtocolClientCompleted");
taskCompletionSource.SetResult((bool)success);
});
BridgeConnector.Socket.Emit("appRemoveAsDefaultProtocolClient", protocol, path);
return await taskCompletionSource.Task;
}
/// <summary>
/// This method checks if the current executable as the default handler for a
/// protocol(aka URI scheme). If so, it will remove the app as the default handler.
/// </summary>
/// <param name="protocol">The name of your protocol, without ://.</param>
/// <param name="path">Defaults to process.execPath.</param>
/// <param name="args">Defaults to an empty array.</param>
/// <returns>Whether the call succeeded.</returns>
public async Task<bool> RemoveAsDefaultProtocolClientAsync(string protocol, string path, string[] args)
{
var taskCompletionSource = new TaskCompletionSource<bool>();
BridgeConnector.Socket.On("appRemoveAsDefaultProtocolClientCompleted", (success) =>
{
BridgeConnector.Socket.Off("appRemoveAsDefaultProtocolClientCompleted");
taskCompletionSource.SetResult((bool)success);
});
BridgeConnector.Socket.Emit("appRemoveAsDefaultProtocolClient", protocol, path, args);
return await taskCompletionSource.Task;
}
/// <summary>
/// This method checks if the current executable is the default handler for a
/// protocol(aka URI scheme). If so, it will return true. Otherwise, it will return
/// false. Note: On macOS, you can use this method to check if the app has been
/// registered as the default protocol handler for a protocol.You can also verify
/// this by checking ~/Library/Preferences/com.apple.LaunchServices.plist on the
/// macOS machine.Please refer to Apple's documentation for details. The API uses
/// the Windows Registry and LSCopyDefaultHandlerForURLScheme internally.
/// </summary>
/// <param name="protocol">The name of your protocol, without ://.</param>
/// <returns>Returns Boolean</returns>
public async Task<bool> IsDefaultProtocolClientAsync(string protocol)
{
var taskCompletionSource = new TaskCompletionSource<bool>();
BridgeConnector.Socket.On("appIsDefaultProtocolClientCompleted", (success) =>
{
BridgeConnector.Socket.Off("appIsDefaultProtocolClientCompleted");
taskCompletionSource.SetResult((bool)success);
});
BridgeConnector.Socket.Emit("appIsDefaultProtocolClient", protocol);
return await taskCompletionSource.Task;
}
/// <summary>
/// This method checks if the current executable is the default handler for a
/// protocol(aka URI scheme). If so, it will return true. Otherwise, it will return
/// false. Note: On macOS, you can use this method to check if the app has been
/// registered as the default protocol handler for a protocol.You can also verify
/// this by checking ~/Library/Preferences/com.apple.LaunchServices.plist on the
/// macOS machine.Please refer to Apple's documentation for details. The API uses
/// the Windows Registry and LSCopyDefaultHandlerForURLScheme internally.
/// </summary>
/// <param name="protocol">The name of your protocol, without ://.</param>
/// <param name="path">Defaults to process.execPath.</param>
/// <returns>Returns Boolean</returns>
public async Task<bool> IsDefaultProtocolClientAsync(string protocol, string path)
{
var taskCompletionSource = new TaskCompletionSource<bool>();
BridgeConnector.Socket.On("appIsDefaultProtocolClientCompleted", (success) =>
{
BridgeConnector.Socket.Off("appIsDefaultProtocolClientCompleted");
taskCompletionSource.SetResult((bool)success);
});
BridgeConnector.Socket.Emit("appIsDefaultProtocolClient", protocol, path);
return await taskCompletionSource.Task;
}
/// <summary>
/// This method checks if the current executable is the default handler for a
/// protocol(aka URI scheme). If so, it will return true. Otherwise, it will return
/// false. Note: On macOS, you can use this method to check if the app has been
/// registered as the default protocol handler for a protocol.You can also verify
/// this by checking ~/Library/Preferences/com.apple.LaunchServices.plist on the
/// macOS machine.Please refer to Apple's documentation for details. The API uses
/// the Windows Registry and LSCopyDefaultHandlerForURLScheme internally.
/// </summary>
/// <param name="protocol">The name of your protocol, without ://.</param>
/// <param name="path">Defaults to process.execPath.</param>
/// <param name="args">Defaults to an empty array.</param>
/// <returns>Returns Boolean</returns>
public async Task<bool> IsDefaultProtocolClientAsync(string protocol, string path, string[] args)
{
var taskCompletionSource = new TaskCompletionSource<bool>();
BridgeConnector.Socket.On("appIsDefaultProtocolClientCompleted", (success) =>
{
BridgeConnector.Socket.Off("appIsDefaultProtocolClientCompleted");
taskCompletionSource.SetResult((bool)success);
});
BridgeConnector.Socket.Emit("appIsDefaultProtocolClient", protocol, path, args);
return await taskCompletionSource.Task;
}
/// <summary>
/// Adds tasks to the Tasks category of the JumpList on Windows. tasks is an array
/// of Task objects.Note: If you'd like to customize the Jump List even more use
/// app.setJumpList(categories) instead.
/// </summary>
/// <param name="userTasks">Array of Task objects.</param>
/// <returns>Whether the call succeeded.</returns>
public async Task<bool> SetUserTasksAsync(UserTask[] userTasks)
{
var taskCompletionSource = new TaskCompletionSource<bool>();
BridgeConnector.Socket.On("appSetUserTasksCompleted", (success) =>
{
BridgeConnector.Socket.Off("appSetUserTasksCompleted");
taskCompletionSource.SetResult((bool)success);
});
BridgeConnector.Socket.Emit("appSetUserTasks", JObject.FromObject(userTasks, _jsonSerializer));
return await taskCompletionSource.Task;
}
/// <summary>
/// Jump List settings for the application.
/// </summary>
/// <returns></returns>
public async Task<JumpListSettings> GetJumpListSettingsAsync()
{
var taskCompletionSource = new TaskCompletionSource<JumpListSettings>();
BridgeConnector.Socket.On("appGetJumpListSettingsCompleted", (success) =>
{
BridgeConnector.Socket.Off("appGetJumpListSettingsCompleted");
taskCompletionSource.SetResult(JObject.Parse(success.ToString()).ToObject<JumpListSettings>());
});
BridgeConnector.Socket.Emit("appGetJumpListSettings");
return await taskCompletionSource.Task;
}
/// <summary>
/// Sets or removes a custom Jump List for the application, and returns one of the
/// following strings: If categories is null the previously set custom Jump List(if
/// any) will be replaced by the standard Jump List for the app(managed by
/// Windows). Note: If a JumpListCategory object has neither the type nor the name
/// property set then its type is assumed to be tasks.If the name property is set
/// but the type property is omitted then the type is assumed to be custom. Note:
/// Users can remove items from custom categories, and Windows will not allow a
/// removed item to be added back into a custom category until after the next
/// successful call to app.setJumpList(categories). Any attempt to re-add a removed
/// item to a custom category earlier than that will result in the entire custom
/// category being omitted from the Jump List. The list of removed items can be
/// obtained using app.getJumpListSettings().
/// </summary>
/// <param name="jumpListCategories"></param>
public void SetJumpList(JumpListCategory[] jumpListCategories)
{
BridgeConnector.Socket.Emit("appSetJumpList", JObject.FromObject(jumpListCategories, _jsonSerializer));
}
/// <summary>
/// This method makes your application a Single Instance Application - instead of
/// allowing multiple instances of your app to run, this will ensure that only a
/// single instance of your app is running, and other instances signal this instance
/// and exit.callback will be called by the first instance with callback(argv,
/// workingDirectory) when a second instance has been executed.argv is an Array of
/// the second instance's command line arguments, and workingDirectory is its
/// current working directory.Usually applications respond to this by making their
/// primary window focused and non-minimized.The callback is guaranteed to be
/// executed after the ready event of app gets emitted.This method returns false if
/// your process is the primary instance of the application and your app should
/// continue loading.And returns true if your process has sent its parameters to
/// another instance, and you should immediately quit.On macOS the system enforces
/// single instance automatically when users try to open a second instance of your
/// app in Finder, and the open-file and open-url events will be emitted for that.
/// However when users start your app in command line the system's single instance
/// mechanism will be bypassed and you have to use this method to ensure single
/// instance.
/// </summary>
/// <param name="newInstanceOpened">Lambda with an array of the second instances command line arguments.
/// The second parameter is the working directory path.</param>
/// <returns>This method returns false if your process is the primary instance of
/// the application and your app should continue loading. And returns true if your
/// process has sent its parameters to another instance, and you should immediately quit.</returns>
public async Task<bool> MakeSingleInstanceAsync(Action<string[], string> newInstanceOpened)
{
var taskCompletionSource = new TaskCompletionSource<bool>();
BridgeConnector.Socket.On("appMakeSingleInstanceCompleted", (success) =>
{
BridgeConnector.Socket.Off("appMakeSingleInstanceCompleted");
taskCompletionSource.SetResult((bool)success);
});
BridgeConnector.Socket.Off("newInstanceOpened");
BridgeConnector.Socket.On("newInstanceOpened", (result) =>
{
JArray results = (JArray)result;
string[] args = results.First.ToObject<string[]>();
string workdirectory = results.Last.ToObject<string>();
newInstanceOpened(args, workdirectory);
});
BridgeConnector.Socket.Emit("appMakeSingleInstance");
return await taskCompletionSource.Task;
}
/// <summary>
/// Releases all locks that were created by makeSingleInstance. This will allow
/// multiple instances of the application to once again run side by side.
/// </summary>
public void ReleaseSingleInstance()
{
BridgeConnector.Socket.Emit("appReleaseSingleInstance");
}
/// <summary>
/// Creates an NSUserActivity and sets it as the current activity. The activity is
/// eligible for Handoff to another device afterward.
/// </summary>
/// <param name="type">Uniquely identifies the activity. Maps to NSUserActivity.activityType.</param>
/// <param name="userInfo">App-specific state to store for use by another device.</param>
public void SetUserActivity(string type, object userInfo)
{
BridgeConnector.Socket.Emit("appSetUserActivity", type, userInfo);
}
/// <summary>
/// Creates an NSUserActivity and sets it as the current activity. The activity is
/// eligible for Handoff to another device afterward.
/// </summary>
/// <param name="type">Uniquely identifies the activity. Maps to NSUserActivity.activityType.</param>
/// <param name="userInfo">App-specific state to store for use by another device.</param>
/// <param name="webpageURL">The webpage to load in a browser if no suitable app is installed on the resuming device. The scheme must be http or https.</param>
public void SetUserActivity(string type, object userInfo, string webpageURL)
{
BridgeConnector.Socket.Emit("appSetUserActivity", type, userInfo, webpageURL);
}
/// <summary>
/// The type of the currently running activity.
/// </summary>
/// <returns></returns>
public async Task<string> GetCurrentActivityTypeAsync()
{
var taskCompletionSource = new TaskCompletionSource<string>();
BridgeConnector.Socket.On("appGetCurrentActivityTypeCompleted", (activityType) =>
{
BridgeConnector.Socket.Off("appGetCurrentActivityTypeCompleted");
taskCompletionSource.SetResult(activityType.ToString());
});
BridgeConnector.Socket.Emit("appGetCurrentActivityType");
return await taskCompletionSource.Task;
}
/// <summary>
/// Changes the Application User Model ID to id.
/// </summary>
/// <param name="id"></param>
public void SetAppUserModelId(string id)
{
BridgeConnector.Socket.Emit("appSetAppUserModelId", id);
}
/// <summary>
/// Imports the certificate in pkcs12 format into the platform certificate store.
/// callback is called with the result of import operation, a value of 0 indicates
/// success while any other value indicates failure according to chromium net_error_list.
/// </summary>
/// <param name="options"></param>
/// <returns>Result of import. Value of 0 indicates success.</returns>
public async Task<int> ImportCertificateAsync(ImportCertificateOptions options)
{
var taskCompletionSource = new TaskCompletionSource<int>();
BridgeConnector.Socket.On("appImportCertificateCompleted", (result) =>
{
BridgeConnector.Socket.Off("appImportCertificateCompleted");
taskCompletionSource.SetResult((int)result);
});
BridgeConnector.Socket.Emit("appImportCertificate", JObject.FromObject(options, _jsonSerializer));
return await taskCompletionSource.Task;
}
/// <summary>
/// Memory and cpu usage statistics of all the processes associated with the app.
/// </summary>
/// <returns></returns>
public async Task<ProcessMetric[]> GetAppMetricsAsync()
{
var taskCompletionSource = new TaskCompletionSource<ProcessMetric[]>();
BridgeConnector.Socket.On("appGetAppMetricsCompleted", (result) =>
{
BridgeConnector.Socket.Off("appGetAppMetricsCompleted");
var processMetrics = ((JArray)result).ToObject<ProcessMetric[]>();
taskCompletionSource.SetResult(processMetrics);
});
BridgeConnector.Socket.Emit("appGetAppMetrics");
return await taskCompletionSource.Task;
}
/// <summary>
/// The Graphics Feature Status from chrome://gpu/.
/// </summary>
/// <returns></returns>
public async Task<GPUFeatureStatus> GetGpuFeatureStatusAsync()
{
var taskCompletionSource = new TaskCompletionSource<GPUFeatureStatus>();
BridgeConnector.Socket.On("appGetGpuFeatureStatusCompleted", (result) =>
{
BridgeConnector.Socket.Off("appGetGpuFeatureStatusCompleted");
var gpuFeatureStatus = ((JObject)result).ToObject<GPUFeatureStatus>();
taskCompletionSource.SetResult(gpuFeatureStatus);
});
BridgeConnector.Socket.Emit("appGetGpuFeatureStatus");
return await taskCompletionSource.Task;
}
/// <summary>
/// Sets the counter badge for current app. Setting the count to 0 will hide the
/// badge. On macOS it shows on the dock icon. On Linux it only works for Unity
/// launcher, Note: Unity launcher requires the existence of a.desktop file to
/// work, for more information please read Desktop Environment Integration.
/// </summary>
/// <param name="count"></param>
/// <returns>Whether the call succeeded.</returns>
public async Task<bool> SetBadgeCountAsync(int count)
{
var taskCompletionSource = new TaskCompletionSource<bool>();
BridgeConnector.Socket.On("appSetBadgeCountCompleted", (success) =>
{
BridgeConnector.Socket.Off("appSetBadgeCountCompleted");
taskCompletionSource.SetResult((bool)success);
});
BridgeConnector.Socket.Emit("appSetBadgeCount", count);
return await taskCompletionSource.Task;
}
/// <summary>
/// The current value displayed in the counter badge.
/// </summary>
/// <returns></returns>
public async Task<int> GetBadgeCountAsync()
{
var taskCompletionSource = new TaskCompletionSource<int>();
BridgeConnector.Socket.On("appGetBadgeCountCompleted", (count) =>
{
BridgeConnector.Socket.Off("appGetBadgeCountCompleted");
taskCompletionSource.SetResult((int)count);
});
BridgeConnector.Socket.Emit("appGetBadgeCount");
return await taskCompletionSource.Task;
}
/// <summary>
/// Whether the current desktop environment is Unity launcher.
/// </summary>
/// <returns></returns>
public async Task<bool> IsUnityRunningAsync()
{
var taskCompletionSource = new TaskCompletionSource<bool>();
BridgeConnector.Socket.On("appIsUnityRunningCompleted", (isUnityRunning) =>
{
BridgeConnector.Socket.Off("appIsUnityRunningCompleted");
taskCompletionSource.SetResult((bool)isUnityRunning);
});
BridgeConnector.Socket.Emit("appIsUnityRunning");
return await taskCompletionSource.Task;
}
/// <summary>
/// If you provided path and args options to app.setLoginItemSettings then you need
/// to pass the same arguments here for openAtLogin to be set correctly. Note: This
/// API has no effect on MAS builds.
/// </summary>
/// <returns></returns>
public async Task<LoginItemSettings> GetLoginItemSettingsAsync()
{
var taskCompletionSource = new TaskCompletionSource<LoginItemSettings>();
BridgeConnector.Socket.On("appGetLoginItemSettingsCompleted", (loginItemSettings) =>
{
BridgeConnector.Socket.Off("appGetLoginItemSettingsCompleted");
taskCompletionSource.SetResult((LoginItemSettings)loginItemSettings);
});
BridgeConnector.Socket.Emit("appGetLoginItemSettings");
return await taskCompletionSource.Task;
}
/// <summary>
/// If you provided path and args options to app.setLoginItemSettings then you need
/// to pass the same arguments here for openAtLogin to be set correctly. Note: This
/// API has no effect on MAS builds.
/// </summary>
/// <param name="options"></param>
/// <returns></returns>
public async Task<LoginItemSettings> GetLoginItemSettingsAsync(LoginItemSettingsOptions options)
{
var taskCompletionSource = new TaskCompletionSource<LoginItemSettings>();
BridgeConnector.Socket.On("appGetLoginItemSettingsCompleted", (loginItemSettings) =>
{
BridgeConnector.Socket.Off("appGetLoginItemSettingsCompleted");
taskCompletionSource.SetResult((LoginItemSettings)loginItemSettings);
});
BridgeConnector.Socket.Emit("appGetLoginItemSettings", JObject.FromObject(options, _jsonSerializer));
return await taskCompletionSource.Task;
}
/// <summary>
/// Set the app's login item settings. To work with Electron's autoUpdater on
/// Windows, which uses Squirrel, you'll want to set the launch path to Update.exe,
/// and pass arguments that specify your application name.
/// </summary>
/// <param name="loginSettings"></param>
public void SetLoginItemSettings(LoginSettings loginSettings)
{
BridgeConnector.Socket.Emit("appSetLoginItemSettings", JObject.FromObject(loginSettings, _jsonSerializer));
}
/// <summary>
/// This API will return true if the use of assistive technologies,
/// such as screen readers, has been detected.
/// See https://www.chromium.org/developers/design-documents/accessibility for more details.
/// </summary>
/// <returns>true if Chromes accessibility support is enabled, false otherwise.</returns>
public async Task<bool> IsAccessibilitySupportEnabledAsync()
{
var taskCompletionSource = new TaskCompletionSource<bool>();
BridgeConnector.Socket.On("appIsAccessibilitySupportEnabledCompleted", (isAccessibilitySupportEnabled) =>
{
BridgeConnector.Socket.Off("appIsAccessibilitySupportEnabledCompleted");
taskCompletionSource.SetResult((bool)isAccessibilitySupportEnabled);
});
BridgeConnector.Socket.Emit("appIsAccessibilitySupportEnabled");
return await taskCompletionSource.Task;
}
/// <summary>
/// Set the about panel options. This will override the values defined in the app's
/// .plist file. See the Apple docs for more details.
/// </summary>
/// <param name="options"></param>
public void SetAboutPanelOptions(AboutPanelOptions options)
{
BridgeConnector.Socket.Emit("appSetAboutPanelOptions", JObject.FromObject(options, _jsonSerializer));
}
/// <summary>
/// Append a switch (with optional value) to Chromium's command line. Note: This
/// will not affect process.argv, and is mainly used by developers to control some
/// low-level Chromium behaviors.
/// </summary>
/// <param name="theSwtich">A command-line switch.</param>
public void CommandLineAppendSwitch(string theSwtich)
{
BridgeConnector.Socket.Emit("appCommandLineAppendSwitch", theSwtich);
}
/// <summary>
/// Append a switch (with optional value) to Chromium's command line. Note: This
/// will not affect process.argv, and is mainly used by developers to control some
/// low-level Chromium behaviors.
/// </summary>
/// <param name="theSwtich">A command-line switch.</param>
/// <param name="value">A value for the given switch.</param>
public void CommandLineAppendSwitch(string theSwtich, string value)
{
BridgeConnector.Socket.Emit("appCommandLineAppendSwitch", theSwtich, value);
}
/// <summary>
/// Append an argument to Chromium's command line. The argument will be quoted
/// correctly.Note: This will not affect process.argv.
/// </summary>
/// <param name="value">The argument to append to the command line.</param>
public void CommandLineAppendArgument(string value)
{
BridgeConnector.Socket.Emit("appCommandLineAppendArgument", value);
}
/// <summary>
/// Enables mixed sandbox mode on the app. This method can only be called before app is ready.
/// </summary>
public void EnableMixedSandbox()
{
BridgeConnector.Socket.Emit("appEnableMixedSandbox");
}
/// <summary>
/// When critical is passed, the dock icon will bounce until either the application
/// becomes active or the request is canceled.When informational is passed, the
/// dock icon will bounce for one second.However, the request remains active until
/// either the application becomes active or the request is canceled.
/// </summary>
/// <param name="type"></param>
/// <returns></returns>
public async Task<int> DockBounceAsync(DockBounceType type)
{
var taskCompletionSource = new TaskCompletionSource<int>();
BridgeConnector.Socket.On("appDockBounceCompleted", (id) =>
{
BridgeConnector.Socket.Off("appDockBounceCompleted");
taskCompletionSource.SetResult((int)id);
});
BridgeConnector.Socket.Emit("appDockBounce", type.ToString());
return await taskCompletionSource.Task;
}
/// <summary>
/// Cancel the bounce of id.
/// </summary>
/// <param name="id"></param>
public void DockCancelBounce(int id)
{
BridgeConnector.Socket.Emit("appDockCancelBounce", id);
}
/// <summary>
/// Bounces the Downloads stack if the filePath is inside the Downloads folder.
/// </summary>
/// <param name="filePath"></param>
public void DockDownloadFinished(string filePath)
{
BridgeConnector.Socket.Emit("appDockDownloadFinished", filePath);
}
/// <summary>
/// Sets the string to be displayed in the docks badging area.
/// </summary>
/// <param name="text"></param>
public void DockSetBadge(string text)
{
BridgeConnector.Socket.Emit("appDockSetBadge", text);
}
/// <summary>
/// Gets the string to be displayed in the docks badging area.
/// </summary>
/// <returns></returns>
public async Task<string> DockGetBadgeAsync()
{
var taskCompletionSource = new TaskCompletionSource<string>();
BridgeConnector.Socket.On("appDockGetBadgeCompleted", (text) =>
{
BridgeConnector.Socket.Off("appDockGetBadgeCompleted");
taskCompletionSource.SetResult((string)text);
});
BridgeConnector.Socket.Emit("appDockGetBadge");
return await taskCompletionSource.Task;
}
/// <summary>
/// Hides the dock icon.
/// </summary>
public void DockHide()
{
BridgeConnector.Socket.Emit("appDockHide");
}
/// <summary>
/// Shows the dock icon.
/// </summary>
public void DockShow()
{
BridgeConnector.Socket.Emit("appDockShow");
}
/// <summary>
/// Whether the dock icon is visible. The app.dock.show() call is asynchronous
/// so this method might not return true immediately after that call.
/// </summary>
/// <returns></returns>
public async Task<bool> DockIsVisibleAsync()
{
var taskCompletionSource = new TaskCompletionSource<bool>();
BridgeConnector.Socket.On("appDockIsVisibleCompleted", (isVisible) =>
{
BridgeConnector.Socket.Off("appDockIsVisibleCompleted");
taskCompletionSource.SetResult((bool)isVisible);
});
BridgeConnector.Socket.Emit("appDockIsVisible");
return await taskCompletionSource.Task;
}
// TODO: Menu lösung muss gemacht werden und imeplementiert
/// <summary>
/// Sets the application's dock menu.
/// </summary>
public void DockSetMenu()
{
BridgeConnector.Socket.Emit("appDockSetMenu");
}
/// <summary>
/// Sets the image associated with this dock icon.
/// </summary>
/// <param name="image"></param>
public void DockSetIcon(string image)
{
BridgeConnector.Socket.Emit("appDockSetIcon", image);
}
/// <summary>
/// Sets the image associated with this dock icon.
/// </summary>
/// <param name="image"></param>
//public static void DockSetIcon(NativeImage image)
//{
// BridgeConnector.Socket.Emit("appDockSetIcon", JObject.FromObject(image, _jsonSerializer));
//}
}
}