using ElectronNET.API.Entities;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using Newtonsoft.Json.Serialization;
using System;
using System.Threading;
using System.Threading.Tasks;
namespace ElectronNET.API
{
///
/// Control your application's event lifecycle.
///
public sealed class App
{
///
/// 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.
///
public event Action WindowAllClosed
{
add
{
if (_windowAllClosed == null)
{
BridgeConnector.Socket.On("app-window-all-closed" + GetHashCode(), () =>
{
if (!Electron.WindowManager.IsQuitOnWindowAllClosed)
{
_windowAllClosed();
}
});
BridgeConnector.Socket.Emit("register-app-window-all-closed-event", GetHashCode());
}
_windowAllClosed += value;
}
remove
{
_windowAllClosed -= value;
if(_windowAllClosed == null)
BridgeConnector.Socket.Off("app-window-all-closed" + GetHashCode());
}
}
private event Action _windowAllClosed;
///
/// 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.
///
public event Func BeforeQuit
{
add
{
if (_beforeQuit == null)
{
BridgeConnector.Socket.On("app-before-quit" + GetHashCode(), async () =>
{
await _beforeQuit(new QuitEventArgs());
if (_preventQuit)
{
_preventQuit = false;
}
else
{
if (_willQuit == null && _quitting == null)
{
Exit();
}
else if (_willQuit != null)
{
await _willQuit(new QuitEventArgs());
if (_preventQuit)
{
_preventQuit = false;
}
else
{
if (_quitting == null)
{
Exit();
}
else
{
await _quitting();
Exit();
}
}
}
else if (_quitting != null)
{
await _quitting();
Exit();
}
}
});
BridgeConnector.Socket.Emit("register-app-before-quit-event", GetHashCode());
}
_beforeQuit += value;
}
remove
{
_beforeQuit -= value;
if (_beforeQuit == null)
BridgeConnector.Socket.Off("app-before-quit" + GetHashCode());
}
}
private event Func _beforeQuit;
///
/// 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.
///
public event Func WillQuit
{
add
{
if (_willQuit == null)
{
BridgeConnector.Socket.On("app-will-quit" + GetHashCode(), async () =>
{
await _willQuit(new QuitEventArgs());
if (_preventQuit)
{
_preventQuit = false;
}
else
{
if (_quitting == null)
{
Exit();
}
else
{
await _quitting();
Exit();
}
}
});
BridgeConnector.Socket.Emit("register-app-will-quit-event", GetHashCode());
}
_willQuit += value;
}
remove
{
_willQuit -= value;
if (_willQuit == null)
BridgeConnector.Socket.Off("app-will-quit" + GetHashCode());
}
}
private event Func _willQuit;
///
/// Emitted when the application is quitting.
///
public event Func Quitting
{
add
{
if (_quitting == null)
{
BridgeConnector.Socket.On("app-will-quit" + GetHashCode() + "quitting", async () =>
{
if(_willQuit == null)
{
await _quitting();
Exit();
}
});
BridgeConnector.Socket.Emit("register-app-will-quit-event", GetHashCode() + "quitting");
}
_quitting += value;
}
remove
{
_quitting -= value;
if (_quitting == null)
BridgeConnector.Socket.Off("app-will-quit" + GetHashCode() + "quitting");
}
}
private event Func _quitting;
///
/// Emitted when a BrowserWindow gets blurred.
///
public event Action BrowserWindowBlur
{
add
{
if (_browserWindowBlur == null)
{
BridgeConnector.Socket.On("app-browser-window-blur" + GetHashCode(), () =>
{
_browserWindowBlur();
});
BridgeConnector.Socket.Emit("register-app-browser-window-blur-event", GetHashCode());
}
_browserWindowBlur += value;
}
remove
{
_browserWindowBlur -= value;
if (_browserWindowBlur == null)
BridgeConnector.Socket.Off("app-browser-window-blur" + GetHashCode());
}
}
private event Action _browserWindowBlur;
///
/// Emitted when a BrowserWindow gets focused.
///
public event Action BrowserWindowFocus
{
add
{
if (_browserWindowFocus == null)
{
BridgeConnector.Socket.On("app-browser-window-focus" + GetHashCode(), () =>
{
_browserWindowFocus();
});
BridgeConnector.Socket.Emit("register-app-browser-window-focus-event", GetHashCode());
}
_browserWindowFocus += value;
}
remove
{
_browserWindowFocus -= value;
if (_browserWindowFocus == null)
BridgeConnector.Socket.Off("app-browser-window-focus" + GetHashCode());
}
}
private event Action _browserWindowFocus;
///
/// Emitted when a new BrowserWindow is created.
///
public event Action BrowserWindowCreated
{
add
{
if (_browserWindowCreated == null)
{
BridgeConnector.Socket.On("app-browser-window-created" + GetHashCode(), () =>
{
_browserWindowCreated();
});
BridgeConnector.Socket.Emit("register-app-browser-window-created-event", GetHashCode());
}
_browserWindowCreated += value;
}
remove
{
_browserWindowCreated -= value;
if (_browserWindowCreated == null)
BridgeConnector.Socket.Off("app-browser-window-created" + GetHashCode());
}
}
private event Action _browserWindowCreated;
///
/// Emitted when a new webContents is created.
///
public event Action WebContentsCreated
{
add
{
if (_webContentsCreated == null)
{
BridgeConnector.Socket.On("app-web-contents-created" + GetHashCode(), () =>
{
_webContentsCreated();
});
BridgeConnector.Socket.Emit("register-app-web-contents-created-event", GetHashCode());
}
_webContentsCreated += value;
}
remove
{
_webContentsCreated -= value;
if (_webContentsCreated == null)
BridgeConnector.Socket.Off("app-web-contents-created" + GetHashCode());
}
}
private event Action _webContentsCreated;
///
/// Emitted when Chrome’s 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.
///
public event Action AccessibilitySupportChanged
{
add
{
if (_accessibilitySupportChanged == null)
{
BridgeConnector.Socket.On("app-accessibility-support-changed" + GetHashCode(), (state) =>
{
_accessibilitySupportChanged((bool)state);
});
BridgeConnector.Socket.Emit("register-app-accessibility-support-changed-event", GetHashCode());
}
_accessibilitySupportChanged += value;
}
remove
{
_accessibilitySupportChanged -= value;
if (_accessibilitySupportChanged == null)
BridgeConnector.Socket.Off("app-accessibility-support-changed" + GetHashCode());
}
}
private event Action _accessibilitySupportChanged;
internal App() { }
internal static App Instance
{
get
{
if (_app == null)
{
lock (_syncRoot)
{
if(_app == null)
{
_app = new App();
}
}
}
return _app;
}
}
private static App _app;
private static object _syncRoot = new object();
private JsonSerializer _jsonSerializer = new JsonSerializer()
{
ContractResolver = new CamelCasePropertyNamesContractResolver()
};
///
/// 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.
///
public void Quit()
{
BridgeConnector.Socket.Emit("appQuit");
}
///
/// All windows will be closed immediately without asking user and
/// the before-quit and will-quit events will not be emitted.
///
/// Exits immediately with exitCode. exitCode defaults to 0.
public void Exit(int exitCode = 0)
{
BridgeConnector.Socket.Emit("appExit", exitCode);
}
///
/// 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.
///
public void Relaunch()
{
BridgeConnector.Socket.Emit("appRelaunch");
}
///
/// 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.
///
///
public void Relaunch(RelaunchOptions relaunchOptions)
{
BridgeConnector.Socket.Emit("appRelaunch", JObject.FromObject(relaunchOptions, _jsonSerializer));
}
///
/// 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.
///
public void Focus()
{
BridgeConnector.Socket.Emit("appFocus");
}
///
/// Hides all application windows without minimizing them.
///
public void Hide()
{
BridgeConnector.Socket.Emit("appHide");
}
///
/// Shows application windows after they were hidden. Does not automatically focus them.
///
public void Show()
{
BridgeConnector.Socket.Emit("appShow");
}
///
/// The current application directory.
///
///
public async Task GetAppPathAsync(CancellationToken cancellationToken = default(CancellationToken))
{
cancellationToken.ThrowIfCancellationRequested();
var taskCompletionSource = new TaskCompletionSource();
using(cancellationToken.Register(() => taskCompletionSource.TrySetCanceled()))
{
BridgeConnector.Socket.On("appGetAppPathCompleted", (path) =>
{
BridgeConnector.Socket.Off("appGetAppPathCompleted");
taskCompletionSource.SetResult(path.ToString());
});
BridgeConnector.Socket.Emit("appGetAppPath");
return await taskCompletionSource.Task
.ConfigureAwait(false);
}
}
///
/// You can request the following paths by the name.
///
/// A path to a special directory or file associated with name.
public async Task GetPathAsync(PathName pathName, CancellationToken cancellationToken = default(CancellationToken))
{
cancellationToken.ThrowIfCancellationRequested();
var taskCompletionSource = new TaskCompletionSource();
using(cancellationToken.Register(() => taskCompletionSource.TrySetCanceled()))
{
BridgeConnector.Socket.On("appGetPathCompleted", (path) =>
{
BridgeConnector.Socket.Off("appGetPathCompleted");
taskCompletionSource.SetResult(path.ToString());
});
BridgeConnector.Socket.Emit("appGetPath", pathName.ToString());
return await taskCompletionSource.Task
.ConfigureAwait(false);
}
}
///
/// 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.
///
public void SetPath(string name, string path)
{
BridgeConnector.Socket.Emit("appSetPath", name, path);
}
///
/// The version of the loaded application.
/// If no version is found in the application’s package.json file,
/// the version of the current bundle or executable is returned.
///
///
public async Task GetVersionAsync(CancellationToken cancellationToken = default(CancellationToken))
{
cancellationToken.ThrowIfCancellationRequested();
var taskCompletionSource = new TaskCompletionSource();
using(cancellationToken.Register(() => taskCompletionSource.TrySetCanceled()))
{
BridgeConnector.Socket.On("appGetVersionCompleted", (version) =>
{
BridgeConnector.Socket.Off("appGetVersionCompleted");
taskCompletionSource.SetResult(version.ToString());
});
BridgeConnector.Socket.Emit("appGetVersion");
return await taskCompletionSource.Task
.ConfigureAwait(false);
}
}
///
/// 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.
///
/// The current application’s name, which is the name in the application’s package.json file.
public async Task GetNameAsync(CancellationToken cancellationToken = default(CancellationToken))
{
cancellationToken.ThrowIfCancellationRequested();
var taskCompletionSource = new TaskCompletionSource();
using(cancellationToken.Register(() => taskCompletionSource.TrySetCanceled()))
{
BridgeConnector.Socket.On("appGetNameCompleted", (name) =>
{
BridgeConnector.Socket.Off("appGetNameCompleted");
taskCompletionSource.SetResult(name.ToString());
});
BridgeConnector.Socket.Emit("appGetName");
return await taskCompletionSource.Task
.ConfigureAwait(false);
}
}
///
/// Overrides the current application's name.
///
/// Application's name
public void SetName(string name)
{
BridgeConnector.Socket.Emit("appSetName", name);
}
///
/// 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.
///
///
public async Task GetLocaleAsync(CancellationToken cancellationToken = default(CancellationToken))
{
cancellationToken.ThrowIfCancellationRequested();
var taskCompletionSource = new TaskCompletionSource();
using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled()))
{
BridgeConnector.Socket.On("appGetLocaleCompleted", (local) =>
{
BridgeConnector.Socket.Off("appGetLocaleCompleted");
taskCompletionSource.SetResult(local.ToString());
});
BridgeConnector.Socket.Emit("appGetLocale");
return await taskCompletionSource.Task
.ConfigureAwait(false);
}
}
///
/// 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.
///
public void AddRecentDocument(string path)
{
BridgeConnector.Socket.Emit("appAddRecentDocument", path);
}
///
/// Clears the recent documents list.
///
public void ClearRecentDocuments()
{
BridgeConnector.Socket.Emit("appClearRecentDocuments");
}
///
/// 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.
///
/// The name of your protocol, without ://.
/// If you want your app to handle electron:// links,
/// call this method with electron as the parameter.
/// The cancellation token.
/// Whether the call succeeded.
public async Task SetAsDefaultProtocolClientAsync(string protocol, CancellationToken cancellationToken = default(CancellationToken))
{
cancellationToken.ThrowIfCancellationRequested();
var taskCompletionSource = new TaskCompletionSource();
using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled()))
{
BridgeConnector.Socket.On("appSetAsDefaultProtocolClientCompleted", (success) =>
{
BridgeConnector.Socket.Off("appSetAsDefaultProtocolClientCompleted");
taskCompletionSource.SetResult((bool)success);
});
BridgeConnector.Socket.Emit("appSetAsDefaultProtocolClient", protocol);
return await taskCompletionSource.Task
.ConfigureAwait(false);
}
}
///
/// 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.
///
/// The name of your protocol, without ://.
/// If you want your app to handle electron:// links,
/// call this method with electron as the parameter.
/// Defaults to process.execPath
/// The cancellation token.
/// Whether the call succeeded.
public async Task SetAsDefaultProtocolClientAsync(string protocol, string path, CancellationToken cancellationToken = default(CancellationToken))
{
cancellationToken.ThrowIfCancellationRequested();
var taskCompletionSource = new TaskCompletionSource();
using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled()))
{
BridgeConnector.Socket.On("appSetAsDefaultProtocolClientCompleted", (success) =>
{
BridgeConnector.Socket.Off("appSetAsDefaultProtocolClientCompleted");
taskCompletionSource.SetResult((bool)success);
});
BridgeConnector.Socket.Emit("appSetAsDefaultProtocolClient", protocol, path);
return await taskCompletionSource.Task
.ConfigureAwait(false);
}
}
///
/// 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.
///
/// The name of your protocol, without ://.
/// If you want your app to handle electron:// links,
/// call this method with electron as the parameter.
/// Defaults to process.execPath
/// Defaults to an empty array
/// The cancellation token.
/// Whether the call succeeded.
public async Task SetAsDefaultProtocolClientAsync(string protocol, string path, string[] args, CancellationToken cancellationToken = default(CancellationToken))
{
cancellationToken.ThrowIfCancellationRequested();
var taskCompletionSource = new TaskCompletionSource();
using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled()))
{
BridgeConnector.Socket.On("appSetAsDefaultProtocolClientCompleted", (success) =>
{
BridgeConnector.Socket.Off("appSetAsDefaultProtocolClientCompleted");
taskCompletionSource.SetResult((bool)success);
});
BridgeConnector.Socket.Emit("appSetAsDefaultProtocolClient", protocol, path, args);
return await taskCompletionSource.Task
.ConfigureAwait(false);
}
}
///
/// 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.
///
/// The name of your protocol, without ://.
/// The cancellation token.
/// Whether the call succeeded.
public async Task RemoveAsDefaultProtocolClientAsync(string protocol, CancellationToken cancellationToken = default(CancellationToken))
{
cancellationToken.ThrowIfCancellationRequested();
var taskCompletionSource = new TaskCompletionSource();
using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled()))
{
BridgeConnector.Socket.On("appRemoveAsDefaultProtocolClientCompleted", (success) =>
{
BridgeConnector.Socket.Off("appRemoveAsDefaultProtocolClientCompleted");
taskCompletionSource.SetResult((bool)success);
});
BridgeConnector.Socket.Emit("appRemoveAsDefaultProtocolClient", protocol);
return await taskCompletionSource.Task
.ConfigureAwait(false);
}
}
///
/// 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.
///
/// The name of your protocol, without ://.
/// Defaults to process.execPath.
/// The cancellation token.
/// Whether the call succeeded.
public async Task RemoveAsDefaultProtocolClientAsync(string protocol, string path, CancellationToken cancellationToken = default(CancellationToken))
{
cancellationToken.ThrowIfCancellationRequested();
var taskCompletionSource = new TaskCompletionSource();
using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled()))
{
BridgeConnector.Socket.On("appRemoveAsDefaultProtocolClientCompleted", (success) =>
{
BridgeConnector.Socket.Off("appRemoveAsDefaultProtocolClientCompleted");
taskCompletionSource.SetResult((bool)success);
});
BridgeConnector.Socket.Emit("appRemoveAsDefaultProtocolClient", protocol, path);
return await taskCompletionSource.Task
.ConfigureAwait(false);
}
}
///
/// 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.
///
/// The name of your protocol, without ://.
/// Defaults to process.execPath.
/// Defaults to an empty array.
/// The cancellation token.
/// Whether the call succeeded.
public async Task RemoveAsDefaultProtocolClientAsync(string protocol, string path, string[] args, CancellationToken cancellationToken = default(CancellationToken))
{
cancellationToken.ThrowIfCancellationRequested();
var taskCompletionSource = new TaskCompletionSource();
using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled()))
{
BridgeConnector.Socket.On("appRemoveAsDefaultProtocolClientCompleted", (success) =>
{
BridgeConnector.Socket.Off("appRemoveAsDefaultProtocolClientCompleted");
taskCompletionSource.SetResult((bool)success);
});
BridgeConnector.Socket.Emit("appRemoveAsDefaultProtocolClient", protocol, path, args);
return await taskCompletionSource.Task
.ConfigureAwait(false);
}
}
///
/// 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.
///
/// The name of your protocol, without ://.
/// The cancellation token.
/// Returns Boolean
public async Task IsDefaultProtocolClientAsync(string protocol, CancellationToken cancellationToken = default(CancellationToken))
{
cancellationToken.ThrowIfCancellationRequested();
var taskCompletionSource = new TaskCompletionSource();
using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled()))
{
BridgeConnector.Socket.On("appIsDefaultProtocolClientCompleted", (success) =>
{
BridgeConnector.Socket.Off("appIsDefaultProtocolClientCompleted");
taskCompletionSource.SetResult((bool)success);
});
BridgeConnector.Socket.Emit("appIsDefaultProtocolClient", protocol);
return await taskCompletionSource.Task
.ConfigureAwait(false);
}
}
///
/// 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.
///
/// The name of your protocol, without ://.
/// Defaults to process.execPath.
/// The cancellation token.
/// Returns Boolean
public async Task IsDefaultProtocolClientAsync(string protocol, string path, CancellationToken cancellationToken = default(CancellationToken))
{
cancellationToken.ThrowIfCancellationRequested();
var taskCompletionSource = new TaskCompletionSource();
using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled()))
{
BridgeConnector.Socket.On("appIsDefaultProtocolClientCompleted", (success) =>
{
BridgeConnector.Socket.Off("appIsDefaultProtocolClientCompleted");
taskCompletionSource.SetResult((bool)success);
});
BridgeConnector.Socket.Emit("appIsDefaultProtocolClient", protocol, path);
return await taskCompletionSource.Task
.ConfigureAwait(false);
}
}
///
/// 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.
///
/// The name of your protocol, without ://.
/// Defaults to process.execPath.
/// Defaults to an empty array.
/// The cancellation token.
/// Returns Boolean
public async Task IsDefaultProtocolClientAsync(string protocol, string path, string[] args, CancellationToken cancellationToken = default(CancellationToken))
{
cancellationToken.ThrowIfCancellationRequested();
var taskCompletionSource = new TaskCompletionSource();
using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled()))
{
BridgeConnector.Socket.On("appIsDefaultProtocolClientCompleted", (success) =>
{
BridgeConnector.Socket.Off("appIsDefaultProtocolClientCompleted");
taskCompletionSource.SetResult((bool)success);
});
BridgeConnector.Socket.Emit("appIsDefaultProtocolClient", protocol, path, args);
return await taskCompletionSource.Task
.ConfigureAwait(false);
}
}
///
/// 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.
///
/// Array of Task objects.
/// The cancellation token.
/// Whether the call succeeded.
public async Task SetUserTasksAsync(UserTask[] userTasks, CancellationToken cancellationToken = default(CancellationToken))
{
cancellationToken.ThrowIfCancellationRequested();
var taskCompletionSource = new TaskCompletionSource();
using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled()))
{
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
.ConfigureAwait(false);
}
}
///
/// Jump List settings for the application.
///
///
public async Task GetJumpListSettingsAsync(CancellationToken cancellationToken = default(CancellationToken))
{
cancellationToken.ThrowIfCancellationRequested();
var taskCompletionSource = new TaskCompletionSource();
using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled()))
{
BridgeConnector.Socket.On("appGetJumpListSettingsCompleted", (jumplistSettings) =>
{
BridgeConnector.Socket.Off("appGetJumpListSettingsCompleted");
taskCompletionSource.SetResult(JObject.Parse(jumplistSettings.ToString()).ToObject());
});
BridgeConnector.Socket.Emit("appGetJumpListSettings");
return await taskCompletionSource.Task
.ConfigureAwait(false);
}
}
///
/// 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().
///
///
public void SetJumpList(JumpListCategory[] jumpListCategories)
{
BridgeConnector.Socket.Emit("appSetJumpList", JObject.FromObject(jumpListCategories, _jsonSerializer));
}
///
/// 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.
///
/// Lambda with an array of the second instance’s command line arguments.
/// The second parameter is the working directory path.
/// The cancellation token.
/// 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.
public async Task RequestSingleInstanceLockAsync(Action newInstanceOpened, CancellationToken cancellationToken = default(CancellationToken))
{
cancellationToken.ThrowIfCancellationRequested();
var taskCompletionSource = new TaskCompletionSource();
using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled()))
{
BridgeConnector.Socket.On("appRequestSingleInstanceLockCompleted", (success) =>
{
BridgeConnector.Socket.Off("appRequestSingleInstanceLockCompleted");
taskCompletionSource.SetResult((bool)success);
});
BridgeConnector.Socket.Off("secondInstance");
BridgeConnector.Socket.On("secondInstance", (result) =>
{
JArray results = (JArray)result;
string[] args = results.First.ToObject();
string workdirectory = results.Last.ToObject();
newInstanceOpened(args, workdirectory);
});
BridgeConnector.Socket.Emit("appRequestSingleInstanceLock");
return await taskCompletionSource.Task
.ConfigureAwait(false);
}
}
///
/// Releases all locks that were created by makeSingleInstance. This will allow
/// multiple instances of the application to once again run side by side.
///
public void ReleaseSingleInstanceLock()
{
BridgeConnector.Socket.Emit("appReleaseSingleInstanceLock");
}
///
/// Creates an NSUserActivity and sets it as the current activity. The activity is
/// eligible for Handoff to another device afterward.
///
/// Uniquely identifies the activity. Maps to NSUserActivity.activityType.
/// App-specific state to store for use by another device.
public void SetUserActivity(string type, object userInfo)
{
BridgeConnector.Socket.Emit("appSetUserActivity", type, userInfo);
}
///
/// Creates an NSUserActivity and sets it as the current activity. The activity is
/// eligible for Handoff to another device afterward.
///
/// Uniquely identifies the activity. Maps to NSUserActivity.activityType.
/// App-specific state to store for use by another device.
/// The webpage to load in a browser if no suitable app is installed on the resuming device. The scheme must be http or https.
public void SetUserActivity(string type, object userInfo, string webpageURL)
{
BridgeConnector.Socket.Emit("appSetUserActivity", type, userInfo, webpageURL);
}
///
/// The type of the currently running activity.
///
///
public async Task GetCurrentActivityTypeAsync(CancellationToken cancellationToken = default(CancellationToken))
{
cancellationToken.ThrowIfCancellationRequested();
var taskCompletionSource = new TaskCompletionSource();
using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled()))
{
BridgeConnector.Socket.On("appGetCurrentActivityTypeCompleted", (activityType) =>
{
BridgeConnector.Socket.Off("appGetCurrentActivityTypeCompleted");
taskCompletionSource.SetResult(activityType.ToString());
});
BridgeConnector.Socket.Emit("appGetCurrentActivityType");
return await taskCompletionSource.Task
.ConfigureAwait(false);
}
}
///
/// Changes the Application User Model ID to id.
///
///
public void SetAppUserModelId(string id)
{
BridgeConnector.Socket.Emit("appSetAppUserModelId", id);
}
///
/// 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.
///
///
/// The cancellation token.
/// Result of import. Value of 0 indicates success.
public async Task ImportCertificateAsync(ImportCertificateOptions options, CancellationToken cancellationToken = default(CancellationToken))
{
cancellationToken.ThrowIfCancellationRequested();
var taskCompletionSource = new TaskCompletionSource();
using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled()))
{
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
.ConfigureAwait(false);
}
}
///
/// Memory and cpu usage statistics of all the processes associated with the app.
///
/// Array of ProcessMetric objects that correspond to memory and cpu usage
/// statistics of all the processes associated with the app.
public async Task GetAppMetricsAsync(CancellationToken cancellationToken = default(CancellationToken))
{
cancellationToken.ThrowIfCancellationRequested();
var taskCompletionSource = new TaskCompletionSource();
using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled()))
{
BridgeConnector.Socket.On("appGetAppMetricsCompleted", (result) =>
{
BridgeConnector.Socket.Off("appGetAppMetricsCompleted");
var processMetrics = ((JArray)result).ToObject();
taskCompletionSource.SetResult(processMetrics);
});
BridgeConnector.Socket.Emit("appGetAppMetrics");
return await taskCompletionSource.Task
.ConfigureAwait(false);
}
}
///
/// The Graphics Feature Status from chrome://gpu/.
///
///
public async Task GetGpuFeatureStatusAsync(CancellationToken cancellationToken = default(CancellationToken))
{
cancellationToken.ThrowIfCancellationRequested();
var taskCompletionSource = new TaskCompletionSource();
using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled()))
{
BridgeConnector.Socket.On("appGetGpuFeatureStatusCompleted", (result) =>
{
BridgeConnector.Socket.Off("appGetGpuFeatureStatusCompleted");
var gpuFeatureStatus = ((JObject)result).ToObject();
taskCompletionSource.SetResult(gpuFeatureStatus);
});
BridgeConnector.Socket.Emit("appGetGpuFeatureStatus");
return await taskCompletionSource.Task
.ConfigureAwait(false);
}
}
///
/// 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.
///
/// Whether the call succeeded.
public async Task SetBadgeCountAsync(int count, CancellationToken cancellationToken = default(CancellationToken))
{
cancellationToken.ThrowIfCancellationRequested();
var taskCompletionSource = new TaskCompletionSource();
using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled()))
{
BridgeConnector.Socket.On("appSetBadgeCountCompleted", (success) =>
{
BridgeConnector.Socket.Off("appSetBadgeCountCompleted");
taskCompletionSource.SetResult((bool)success);
});
BridgeConnector.Socket.Emit("appSetBadgeCount");
return await taskCompletionSource.Task
.ConfigureAwait(false);
}
}
///
/// The current value displayed in the counter badge.
///
///
public async Task GetBadgeCountAsync(CancellationToken cancellationToken = default(CancellationToken))
{
cancellationToken.ThrowIfCancellationRequested();
var taskCompletionSource = new TaskCompletionSource();
using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled()))
{
BridgeConnector.Socket.On("appGetBadgeCountCompleted", (count) =>
{
BridgeConnector.Socket.Off("appGetBadgeCountCompleted");
taskCompletionSource.SetResult((int)count);
});
BridgeConnector.Socket.Emit("appGetBadgeCount");
return await taskCompletionSource.Task
.ConfigureAwait(false);
}
}
///
/// Whether the current desktop environment is Unity launcher.
///
///
public async Task IsUnityRunningAsync(CancellationToken cancellationToken = default(CancellationToken))
{
cancellationToken.ThrowIfCancellationRequested();
var taskCompletionSource = new TaskCompletionSource();
using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled()))
{
BridgeConnector.Socket.On("appIsUnityRunningCompleted", (isUnityRunning) =>
{
BridgeConnector.Socket.Off("appIsUnityRunningCompleted");
taskCompletionSource.SetResult((bool)isUnityRunning);
});
BridgeConnector.Socket.Emit("appIsUnityRunning");
return await taskCompletionSource.Task
.ConfigureAwait(false);
}
}
///
/// 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.
///
///
public async Task GetLoginItemSettingsAsync(CancellationToken cancellationToken = default(CancellationToken))
{
cancellationToken.ThrowIfCancellationRequested();
var taskCompletionSource = new TaskCompletionSource();
using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled()))
{
BridgeConnector.Socket.On("appGetLoginItemSettingsCompleted", (loginItemSettings) =>
{
BridgeConnector.Socket.Off("appGetLoginItemSettingsCompleted");
taskCompletionSource.SetResult((LoginItemSettings)loginItemSettings);
});
BridgeConnector.Socket.Emit("appGetLoginItemSettings");
return await taskCompletionSource.Task
.ConfigureAwait(false);
}
}
///
/// 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.
///
///
/// The cancellation token.
///
public async Task GetLoginItemSettingsAsync(LoginItemSettingsOptions options, CancellationToken cancellationToken = default(CancellationToken))
{
cancellationToken.ThrowIfCancellationRequested();
var taskCompletionSource = new TaskCompletionSource();
using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled()))
{
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
.ConfigureAwait(false);
}
}
///
/// 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.
///
///
public void SetLoginItemSettings(LoginSettings loginSettings)
{
BridgeConnector.Socket.Emit("appSetLoginItemSettings", JObject.FromObject(loginSettings, _jsonSerializer));
}
///
/// 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.
///
/// true if Chrome’s accessibility support is enabled, false otherwise.
public async Task IsAccessibilitySupportEnabledAsync(CancellationToken cancellationToken = default(CancellationToken))
{
cancellationToken.ThrowIfCancellationRequested();
var taskCompletionSource = new TaskCompletionSource();
using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled()))
{
BridgeConnector.Socket.On("appIsAccessibilitySupportEnabledCompleted", (isAccessibilitySupportEnabled) =>
{
BridgeConnector.Socket.Off("appIsAccessibilitySupportEnabledCompleted");
taskCompletionSource.SetResult((bool)isAccessibilitySupportEnabled);
});
BridgeConnector.Socket.Emit("appIsAccessibilitySupportEnabled");
return await taskCompletionSource.Task
.ConfigureAwait(false);
}
}
///
/// Set the about panel options. This will override the values defined in the app's
/// .plist file. See the Apple docs for more details.
///
///
public void SetAboutPanelOptions(AboutPanelOptions options)
{
BridgeConnector.Socket.Emit("appSetAboutPanelOptions", JObject.FromObject(options, _jsonSerializer));
}
///
/// 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.
///
/// A command-line switch.
public void CommandLineAppendSwitch(string theSwtich)
{
BridgeConnector.Socket.Emit("appCommandLineAppendSwitch", theSwtich);
}
///
/// 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.
///
/// A command-line switch.
/// A value for the given switch.
public void CommandLineAppendSwitch(string theSwtich, string value)
{
BridgeConnector.Socket.Emit("appCommandLineAppendSwitch", theSwtich, value);
}
///
/// Append an argument to Chromium's command line. The argument will be quoted
/// correctly.Note: This will not affect process.argv.
///
/// The argument to append to the command line.
public void CommandLineAppendArgument(string value)
{
BridgeConnector.Socket.Emit("appCommandLineAppendArgument", value);
}
///
/// 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.
///
///
///
///
public async Task DockBounceAsync(DockBounceType type, CancellationToken cancellationToken = default(CancellationToken))
{
cancellationToken.ThrowIfCancellationRequested();
var taskCompletionSource = new TaskCompletionSource();
using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled()))
{
BridgeConnector.Socket.On("appDockBounceCompleted", (id) =>
{
BridgeConnector.Socket.Off("appDockBounceCompleted");
taskCompletionSource.SetResult((int)id);
});
BridgeConnector.Socket.Emit("appDockBounce", type.ToString());
return await taskCompletionSource.Task
.ConfigureAwait(false);
}
}
///
/// Cancel the bounce of id.
///
///
public void DockCancelBounce(int id)
{
BridgeConnector.Socket.Emit("appDockCancelBounce", id);
}
///
/// Bounces the Downloads stack if the filePath is inside the Downloads folder.
///
///
public void DockDownloadFinished(string filePath)
{
BridgeConnector.Socket.Emit("appDockDownloadFinished", filePath);
}
///
/// Sets the string to be displayed in the dock’s badging area.
///
///
public void DockSetBadge(string text)
{
BridgeConnector.Socket.Emit("appDockSetBadge", text);
}
///
/// Gets the string to be displayed in the dock’s badging area.
///
///
public async Task DockGetBadgeAsync(CancellationToken cancellationToken = default(CancellationToken))
{
cancellationToken.ThrowIfCancellationRequested();
var taskCompletionSource = new TaskCompletionSource();
using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled()))
{
BridgeConnector.Socket.On("appDockGetBadgeCompleted", (text) =>
{
BridgeConnector.Socket.Off("appDockGetBadgeCompleted");
taskCompletionSource.SetResult((string)text);
});
BridgeConnector.Socket.Emit("appDockGetBadge");
return await taskCompletionSource.Task
.ConfigureAwait(false);
}
}
///
/// Hides the dock icon.
///
public void DockHide()
{
BridgeConnector.Socket.Emit("appDockHide");
}
///
/// Shows the dock icon.
///
public void DockShow()
{
BridgeConnector.Socket.Emit("appDockShow");
}
///
/// Whether the dock icon is visible. The app.dock.show() call is asynchronous
/// so this method might not return true immediately after that call.
///
///
public async Task DockIsVisibleAsync(CancellationToken cancellationToken = default(CancellationToken))
{
cancellationToken.ThrowIfCancellationRequested();
var taskCompletionSource = new TaskCompletionSource();
using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled()))
{
BridgeConnector.Socket.On("appDockIsVisibleCompleted", (isVisible) =>
{
BridgeConnector.Socket.Off("appDockIsVisibleCompleted");
taskCompletionSource.SetResult((bool)isVisible);
});
BridgeConnector.Socket.Emit("appDockIsVisible");
return await taskCompletionSource.Task
.ConfigureAwait(false);
}
}
// TODO: Menu lösung für macOS muss gemacht werden und imeplementiert
///
/// Sets the application's dock menu.
///
public void DockSetMenu()
{
BridgeConnector.Socket.Emit("appDockSetMenu");
}
///
/// Sets the image associated with this dock icon.
///
///
public void DockSetIcon(string image)
{
BridgeConnector.Socket.Emit("appDockSetIcon", image);
}
internal void PreventQuit()
{
_preventQuit = true;
}
private bool _preventQuit = false;
}
}