Open the folder where the file is located, which is usually selected as well.

9.1.2 shell. OpenItem (fullPath)

Open the file in default mode.

9.1.3 shell. OpenExternal (url)

Enable external protocols with system default Settings (for example,mailto: [email protected] opens the user’s default mail client).

9.1.4 shell. MoveItemToTrash (fullPath)

Deletes the specified path file and returns the status value for this operation (Boolean type).

9.1.5 shell. Beep ()

Play beep sounds (aka beeps).

The Display object represents a physical connection to the system. A fake Display may exist in a headless system, or a Display may be equivalent to a remote, virtual Display.

The Screen module triggers three kinds of events: Event: ‘display-added’

Returns:

Event Event newDisplay Object Emits an event when newDisplay is added

Event: ‘display-removed’

Returns:

Event Event oldDisplay Object Emits an event when oldDisplay is removed

Event: ‘display-metrics-changed’

Returns:

event Event display Object changedMetrics Array

9.2.1 screen. GetCursorScreenPoint ()

Returns the absolute path of the current mouse.

screen.getPrimaryDisplay()

Return the primary display.

screen.getAllDisplays()

Return a currently available display array.

9.2.2 screen. GetDisplayNearestPoint (point)

point Object x Integer y Integer

Returns the display closest to the specified point.

9.2.3 screen. GetDisplayMatching (the rect)

rect Object x Integer y Integer width Integer height Integer

Returns the display most closely related to the supplied boundary range.

Type String (Optional)

Returns content from clipBoard in plain text

9.3.2 clipboard. WriteText (text [type])

Text String Type String (Optional)

Add content to clipboard in plain text

9.3.3 clipboard. ReadHtml ([type])

Type String (Optional)

Returns the tag content in clipBoard

9.3.4 clipboard. WriteHtml (markup [type])

Markup String Type String (optional)

Add markup content to the Clipboard

9.3.5 clipboard. ReadImage ([type])

Type String (Optional)

Return the NativeImage content from the Clipboard

9.3.6 shall clipboard. WriteImage (image [type])

Image NativeImage Type String (Optional)

Writes an image to the Clipboard

9.3.7 clipboard. The clear ([type])

Type String (Optional)

Clear the clipBoard

options:

companyName String

SubmitURL String – The path to send the crash report, in post mode.

ProductName String (Optional) – The default is Electron.

AutoSubmit Boolean – Whether to automatically submit. The default is true.

IgnoreSystemCrashHandler Boolean – Default is false.

Extra Object – An Object that you can define and send along with the crash report. Only string attributes can be sent correctly; nested objects are not supported.

Note: This method can only be used before using the other crashReporter APIs.

9.4.2 crashReporter. GetLastCrashReport ()

Returns the date and ID of the last crash report. Null is returned if no crash report has been sent or if crash report collection has not started.

9.4.3 crashReporter. GetUploadedReports ()

Returns a crash report for all uploads, each containing the upload date and ID.

9.5.1 nativeImage. CreateEmpty ()

Create an empty instance of nativeImage.

9.5.2 nativeImage. CreateFromPath (path)

path String

Creates a new instance of nativeImage from the specified path.

9.5.3 nativeImage. CreateFromBuffer (buffer, scaleFactor [])

Buffer Buffer scaleFactor Double (optional)

Create a new instance of nativeImage from buffer. The default scaleFactor is 1.0.

9.5.4 nativeImage. CreateFromDataURL (dataURL)

dataURL String

Create a new instance of nativeImage from the dataURL.

9.6.1 ipcRenderer. On (channel, the listener)

channel String listener Function

Listen for a channel and use listener(Event, args…) when a new message arrives. Call the listener.

9.6.2 ipcRenderer. Once (channel, the listener)

channel String listener Function

Add a one-time listener function for this event. This listener will be called the next time a new message is sent to a channel and then deleted.

9.6.3 ipcRenderer. RemoveListener (channel, the listener)

channel String listener Function

Removes the specified listener from the listener array in the specified channel.

9.6.4 ipcRenderer. RemoveAllListeners ([channel])

channel String (optional)

Deletes all listeners, or all listeners in a specified channel.

9.6.5 ipcRenderer. Send (channel [, arg1] [arg2], […]. )

Channel String ARG (optional)

Send an asynchronous message to the main process through a channel, or you can send arbitrary parameters. The parameters are serialized by JSON, and then there are no functions or prototype chains.

The main process processes messages by listening for channels using the ipcMain module.

Ipcrenderer. sendToHost(channel[, arg1][, arg2][,… )

Channel String ARG (optional)

Similar to ipcrenderer.send, but its events are sent to the element of the host page, not the main process.

9.7.1 desktopCapturer. GetSources (options, callback)

Options Object types Array – A String Array, ThumbnailSize Object (optional) – Suggests the size of the thumbnail that can be scaled. Default is {width: 150, height: 150}. callback Function

Make a request for all desktop resources and call callback(error, sources) when the request is complete.

9.8.1 remote. The require (module)

module String

Returns the object returned by executing require(Module) in the main process.

9.8.2 remote. GetCurrentWindow ()

Returns the BrowserWindow object to which the page belongs.

9.8.3 remote. GetCurrentWebContents ()

Returns the WebContents object for the web page

9.8.4 remote. GetGlobal (name)

name String

Returns the global variable named name in the main process (that is, global[name]).

9.8.5 remote.process

Returns the Process object in the main process. Equivalent to remote.getGlobal(‘process’) but cached.

9.9.1 webFrame. SetZoomFactor (factor)

Factor Number – Scaling parameter.

Modifies the zoom parameter to the specified parameter value. The scaling parameter is a percent scale, so 300% = 3.0.

9.9.2 webFrame. GetZoomFactor ()

Returns the current scale parameter value.

9.9.3 webFrame. RegisterURLSchemeAsSecure (scheme)

scheme String

Register scheme as a secure scheme.

Safe Schemes do not raise mixed content warnings. For example, HTTPS and data are safe schemes that cannot be disabled by active network attacks.

9.9.4 webFrame. RegisterURLSchemeAsBypassingCSP (scheme)

scheme String

Ignore the security policy for the current web page content and load it directly from Scheme.

9.9.4 webFrame. ExecuteJavaScript (code [userGesture])

Code String userGesture Boolean (Optional) – Default: false.

Evaluate the page code.

In the browser window, some HTML APIs, such as requestFullScreen, can only be used with user gestures. Setting userGesture to true breaks this limitation

Event: ‘ready’

Triggered when Electron completes initialization.

Event: ‘window – all – closed’

Triggered when all Windows are closed.

This time can only be triggered if the application has not yet quit. If the user presses Cmd + Q or the developer calls app.quit(), Electron will attempt to close all Windows before firing the will-quit event, in which case window-all-closed will not be triggered.

Event: ‘before – quit’

Returns:

event Event

Triggered when the application starts to close its window. Calling event.preventDefault() will prevent the default behavior of terminating the application.

Event: ‘browser window – – focus’

Returns:

event Event

window BrowserWindow

Emitted when a BrowserWindow gets focus.

Event: ‘browser – Windows – created’

Returns:

event Event

window BrowserWindow

Emitted when a BrowserWindow is created.

9.10.1 app. The quit ()

Try to close all Windows. The before-quit event will be fired first. If all Windows are successfully closed, the Will-quit event will be fired and the application will be closed by default.

This method ensures that all beforeUnload and unload event handlers are executed correctly. If a window’s beforeUnload event handler returns false, the entire application may cancel the exit.

OS X 9.10.2 app. Hide ()

Hide all application Windows, not minimize them.

9.10.3 app. GetAppPath ()

Returns the file path of the current application.

9.10.4 APP.ClearRecentDocuments () OS X Windows

Clears the list of recently accessed documents.

9.10.5 app. IsAeroGlassEnabled () the Windows

This method returns true if DWM Composition (Aero Glass) is enabled, false otherwise. You can use this method to decide whether to enable transparent window effects, because if the user has not enabled DWM, transparent window effects are not effective.

You can also create Windows without using Chrome, using the Frameless Window API.

Event: ‘page-title-updated’

Returns:

event Event

Triggered when the document’s title changes, use event.preventDefault() to prevent the original window’s title from changing.

Event: ‘close’

Returns:

Event The event is emitted when the window is about to close. It fires before the beforeUnload and unload events of the DOM. To cancel this, use event.preventdefault ()

Normally you want to decide whether to close a window by using the beforeUnload handler, but it will also be triggered when the window reloads. In Electron, returning an empty string or false can cancel the closure.

Event: ‘unresponsive’

Trigger event when interface freezes.

Event: ‘minimize’

Triggered when the window is minimized.

Event: ‘scroll-touch-begin’ OS X

Triggered when the scrollbar event starts.

BrowserWindow.getAllWindows()

Returns an array of all objects with open Windows.

BrowserWindow.getFocusedWindow()

Returns the application’s current focus window, or NULL if it does not.

An instance object created with new BrowserWindow has the following properties:

// In this example `win` is our instance
var win = new BrowserWindow({ width: 800, height: 600 });
Copy the code

win.webContents

The WebContents object of this window, through which all interface related events and methods are done.

Check webContents Documentation for methods and events.

win.id

The unique ID of the window.

Instance methods

Instance objects created using new BrowserWindow have the following methods:

win.destroy()

Forcing a window close, unload and beforeunload does not fire, and close does not fire, but it guarantees closed firing.

win.close()

Try closing the window as if the user had clicked the close button. Although the page may cancel to close, check out the Close Event.

win.focus()

The window gets focus.

win.show()

Show and bring the window into focus.

win.hide()

Hide the window.

win.maximize()

Maximize the window.

win.minimize()

The window is minimized. On some OS, it will display in the Dock.

win.setBounds(options[, animate])

options Object

x Integer

y Integer

width Integer

height Integer

Animate Boolean (Optional) OS X

Resets the width and height of the window and moves it to the specified x and y positions.

win.getBounds()

Returns an object containing the width, height, x, and y coordinates of the window.

win.setSize(width, height[, animate])

width Integer

height Integer

Animate Boolean (Optional) OS X

Resets the width and height of the window.

win.setContentSize(width, height[, animate])

width Integer

height Integer

Animate Boolean (Optional) OS X

Resets the width and height of the window client (for example, the web interface).

win.center()

The window is centered.

The webContents object can emit the following events:

Event: ‘did-finish-load’

The event is emitted when the navigation completes, and the onLoad event completes.

Event: ‘did-start-loading’

When TAB’s spinner starts spinning.

Event: ‘did-stop-loading’

When TAB’s spinner finishes spinning.

Event: ‘new-window’

Returns:

event Event

url String

frameName String

Disposition String – Can be default, foreground- TAB, background-tab, new-window and other.

Options Object – Arguments to use when creating a new BrowserWindow.

Raises an event when a page request opens the specified URL window. This can be through window.open or an external connection such as a request made.

A BrowserWindow specifying the URL is created by default.

The call event.preventDefault() can be used to prevent the window from opening.

Event: ‘will-navigate’ returns:

event Event

url String

Emits an event when the user or page wants to start navigation. It can happen when the window.location object changes or when the user clicks on a link in the page.

This event is not emitted when navigation is initiated programmatically using apis such as webcontents.loadURL and webcontents.back.

It also doesn’t happen within the page to jump, such as clicking on the anchor link or updating window.location.hash. The did-navigation-in-page event will do the trick.

Call event.preventDefault() to prevent navigation.

Event: ‘did-navigate’

Returns:

event Event

url String

Emits an event when a navigation ends.

This event is not emitted for in-page jumps, such as clicking an anchor link or updating window.location.hash. The did-navigation-in-page event will do the trick.

Event: ‘crashed’

Emits an event when the renderer crashes.

Event: ‘destroyed’

Emits an event when webContents is deleted

Event: ‘login’

Returns:

event Event

request Object

method String

url URL

referrer URL

authInfo Object

isProxy Boolean

scheme String

host String

port Integer

realm String

callback Function

Emits an event when webContents wants to do basic validation.

The usage method is similar to the Login Event of app.

Instance methods

The webContents object has the following instance methods:

9.12.1 webContents. LoadURL (url [options])

url URL

Options Object (Optional)

httpReferrer String – A HTTP Referrer url.

UserAgent String – the userAgent that generates the request

ExtraHeaders String – extraHeaders separated by “\n”

Load a url in a window that must contain a protocol prefix such as http:// or file://. If the load wants to ignore the HTTP cache, you can use the pragma header to do so.

const options = {"extraHeaders" : "pragma: no-cache\n"}
webContents.loadURL(url, options)
Copy the code

9.12.2 webContents. IsLoading ()

Returns a Boolean value that identifies whether the current page is being loaded.

9.12.3 webContents. IsLoading ()

Returns a Boolean value that identifies whether the current page is being loaded.

9.12.4 webContents. Reload ()

Reload the current page.

9.12.5 webContents. ReloadIgnoringCache ()

Reload the current page, ignoring the cache.

9.12.6 webContents. GoBack ()

Rewind the browser to the previous page.

9.12.7 webContents. GoForward ()

Tell the browser to go back to the next page.

9.12.8 webContents. GoToIndex (index)

index Integer

Causes the browser to return to the page of the specified index.

Instance attributes

The WebContents object also has the following properties:

webContents.session

Returns the session object used by this webContents.

webContents.hostWebContents

Returns the parent webContents of this webContents.

Send a message

You can also send a message from the main process to the renderer to see more webcontents.send.

Sends a message with the event name channel.

In response to synchronous messages, you can set event. ReturnValue.

To respond to asynchronous messages, you can use event.sender.send(…). .

An example of sending and processing messages between the main and renderer processes:

// In main process.
const ipcMain = require('electron').ipcMain;
ipcMain.on('asynchronous-message', function(event, arg) {
  console.log(arg);  // prints "ping"
  event.sender.send('asynchronous-reply', 'pong');
});

ipcMain.on('synchronous-message', function(event, arg) {
  console.log(arg);  // prints "ping"
  event.returnValue = 'pong';
});
// In renderer process (web page).
const ipcRenderer = require('electron').ipcRenderer;
console.log(ipcRenderer.sendSync('synchronous-message', 'ping')); // prints "pong"

ipcRenderer.on('asynchronous-reply', function(event, arg) {
  console.log(arg); // prints "pong"
});
ipcRenderer.send('asynchronous-message', 'ping');
Copy the code

Listen to the message

The ipcMain module has the following listening event methods:

9.13.1 ipcMain. On (channel, the listener)

channel String

listener Function

Listen on a channel. When a new message arrives, the listener(Event, args…) Call the listener.

9.13.2 ipcMain. Once (channel, the listener)

channel String

listener Function

Add a one-time listener function for the event. This listener is invoked only the next time a message arrives at a channel, after which it is deleted.

9.13.3 ipcMain. RemoveListener (channel, the listener)

channel String

listener Function

Removes a specific listener from the listener queue for a specific channel.

9.13.4 ipcMain. RemoveAllListeners ([channel])

Channel String (Optional)

Deletes all listeners, or all listeners for a specified channel.

The event object

The event object passed to callback has the following methods:

event.returnValue

Set this to the value returned in a synchronous message.

event.sender

Return the webContents that sent the message. You can call Event.sender. send to reply to the asynchronous message

9.14.1 dialog. ShowOpenDialog ([browserWindow,] options [, callback])

BrowserWindow browserWindow (optional)

options Object

title String

defaultPath String

filters Array

Properties Array – Contains the feature values for the dialog box. The options are openFile, openDirectory, multiSelections and createDirectory

Callback Function (Optional)

This method returns an array of file paths that the user can choose on success, and undefined on failure.

Filters Specifies an array of files for the user to display or select when it needs to restrict the user’s behavior. Such as:

{
  filters: [
    { name: 'Images', extensions: ['jpg', 'png', 'gif'] },
    { name: 'Movies', extensions: ['mkv', 'avi', 'mp4'] },
    { name: 'Custom File Type', extensions: ['as'] },
    { name: 'All Files', extensions: ['*'] }
  ]
}
Copy the code

The Extensions array should contain only the extension and should not contain wildcards or ‘.’ numbers (e.g.’ PNG ‘is correct, but ‘.png’ and ‘.png’ are not). To display all files, use the ” wildcard (other wildcards are not supported).

If callback is called, the API is called asynchronously, and the result is displayed using callback(Filenames).

Note: On Windows and Linux, An open Dialog cannot be both a file selection box and a directory selection box, so setting properties to [‘openFile’, ‘openDirectory’] on these platforms will display a directory selection box.

9.14.2 dialog. ShowErrorBox (title, content)

Displays a traditional error message dialog box.

This API can be safely called before the APP module fires the ready event, and is usually used to report errors in the early stages of startup. On Linux, if called before the APP module triggers the ready event, Message will be triggered to display the STderr (output file) without the actual GUI box.

9.15.1 Menu. SetApplicationMenu (Menu)

menu Menu

On OS X, set application menu. On Windows and Linux, set menu at the top of each window.

9.15.2 Menu. SendActionToFirstResponder OS X (action)

action String

Sends the action to the first responder of the application. This is used to mimic the default behavior of Cocoa menus. Usually you only need to use the MenuItem attribute role.

9.15.3 Menu. BuildFromTemplate (template)

template Array

Normally, template is just an array parameter used to create a MenuItem.

You can also add other things to the template element, and they become properties of existing menu items.

Instance methods

The menu object has the following instance methods:

menu.popup([browserWindow, x, y, positioningItem])

BrowserWindow browserWindow (Optional) – Null by default.

X Number (Optional) – The default value is -1.

Y Number (must be if x is set) – Default is -1.

PositioningItem Number (Optional) OS X – Index of the menu item below the mouse position at the specified coordinates. Default is -1. The Context Menu is displayed in browserWindow. You can optionally provide specified X, y to set where the menu should be placed, otherwise it will default to the current mouse position.

menu.append(menuItem)

menuItem MenuItem

Add menu items.

menu.insert(pos, menuItem)

pos Integer

menuItem MenuItem

Adds a menu item at the specified location.

menu.items()

Gets an array of menu items.

9.16.1 protocol. RegisterStandardSchemes (schemes)

Schemes Array – Registers a custom schema as a standard schema.

A standard scheme follows the Generic URI Syntax standard of RFC 3986. This includes file: and filesystem:.

9.16.2 protocol. RegisterServiceWorkerSchemes (schemes)

Schemes Array – Registers a custom schema to handle service workers.

9.16.3 protocol. UnregisterProtocol (scheme [, completion])

scheme String

Completion Function (Optional)

Deregister the user-defined protocol scheme.

Examples of event

Instance Session has the following events:

Event: ‘will-download’

event Event

item DownloadItem

webContents WebContents

Triggered when Electron is about to download an item from webContents.

Call event.preventDefault() to cancel the download and prevent this item from being available in the process’s next tick.

session.defaultSession.on('will-download', function(event, item, webContents) {
  event.preventDefault();
  require('request')(item.getURL(), function(data) {
    require('fs').writeFileSync('/somewhere', data);
  });
});
Copy the code

Instance methods

9.17.1 ses. Cookies

Cookies give you the power to query and modify cookies. For example:

/ / query all the cookies, session. The defaultSession. Cookies, get ({}, function (error, cookies) {the console. The log (cookies); }); / / queries related to the specified url all cookies, session. The defaultSession. Cookies, get ({url: "http://www.github.com" }, function(error, cookies) { console.log(cookies); }); / / setting cookies; // may overwrite equivalent cookies if they exist. var cookie = { url : "http://www.github.com", name : "dummy_name", value : "dummy" }; session.defaultSession.cookies.set(cookie, function(error) { if (error) console.error(error); });Copy the code

9.17.2 ses. Cookies. Get (filter, the callback)

filter Object

Url String (Optional) – The URL associated with obtaining cookies. Otherwise, cookies are retrieved from all urls.

Name String (Optional) – Filter cookies by name.

Domain String (Optional) – Obtain cookies of the domain name or subdomain name.

Path String (Optional) – Obtains cookies of the corresponding path.

Secure Boolean (Optional) – Filter cookies by security.

Session Boolean (Optional) – Filter session or persistent cookies.

callback Function

Send a request to get cookies for all matching details, and when done, callback(error, cookies) is called.

A cookie is a cookie object.

cookie Object

Name String – Cookie name.

Value String – Cookie value.

Domain string-cookie domain name.

HostOnly String – Indicates whether cookie is a host-only cookie.

Path String – Cookie path.

Secure Boolean – Whether it is a secure cookie.

HttpOnly Boolean – Whether it is only an HTTP cookie.

Session Boolean – Cookie specifies whether a session cookie or a persistent cookie with an expiration date.

ExpirationDate Double (optional)- expirationDate of a cookie. The value is the number of seconds since the UNIX era. Session cookies are not provided.

9.17.3 ses. Cookies. Set (the details, the callback)

details Object

Url String – The URL associated with obtaining cookies.

Name String – Cookie name. Ignore the default is null.

Value String – Cookie value. Ignore the default is null.

Domain String – Indicates the domain name of cookie. Ignore the default is null.

Path String – Path of the cookie. Ignore the default is null.

Secure Boolean – Whether security identification has been performed. The default is false.

Session Boolean – Indicates whether the HttpOnly identity is present. The default is false.

ExpirationDate double-cookie expirationDate. The value is the number of seconds since the UNIX era. If ignored, the cookie becomes a session cookie.

Callback Function Sets the cookie using details, and drops a callback(error) when done.

9.17.4 ses. Cookies. Remove (url, name, the callback)

Url String – Url associated with cookies.

Name String – Name of the cookie to be deleted.

callback Function

Delete the cookie that matches the URL and name, and call callback with callback() when done.

9.17.5 ses. GetCacheSize (the callback)

callback Function

Size Integer – Specifies the size of the cache in bytes.

Returns the current cache size of the session.

9.17.6 ses. ClearCache (the callback)

Callback Function – called when the operation is complete

Clear the HTTP cache of the session.

Platform limitations:

On Linux, use application indicators if they are supported, and GtkStatusIcon instead.

On Linux, configured only with application indicator support, you must install LibAppindicator1 for Tray Icon to execute.

The application indicator is displayed only if it has context Menu.

Click events are ignored when application indicators are used on Linux.

On Linux, setContextMenu needs to be called again for the individual MenuItem to take effect. Such as:

contextMenu.items[2].checked = false;
appIcon.setContextMenu(contextMenu);
Copy the code

If you want to maintain exactly the same behavior across all platforms, you should not rely on click events, but always add a Context Menu to the Tray Icon.

9.18.1 Tray. Destroy ()

Delete the Tray Icon immediately.

9.18.2 Tray. SetImage (image)

image NativeImage

Associate the Image with the Tray Icon.

OS X 9.18.3 Tray. SetPressedImage (image)

image NativeImage

Associate image with Tray Icon when pressing tray Icon on OS X.

9.18.4 Tray. SetToolTip (toolTip)

toolTip String

Set hover Text for tray Icon.

OS X 9.18.5 Tray. SetTitle (title)

title String

Set the title along the Tray Icon in the status bar.

OS X 9.18.6 Tray. SetHighlightMode (highlight)

highlight Boolean

Set the background color of tray Icon to highlight blue when it is clicked. The default is true.

9.18.7 Tray. SetContextMenu (menu)

menu Menu

Set context Menu for this icon.

9.19.1 globalShortcut. Register (accelerator, the callback)

accelerator Accelerator

callback Function

Register the Accelerator shortcut. The callback function is called when the user presses the registered shortcut key.

9.19.2 globalShortcut. IsRegistered (accelerator)

accelerator Accelerator

Querying whether the Accelerator shortcut is already registered will return true(registered) or false(unregistered).

9.19.3 globalShortcut. Unregister (accelerator)

accelerator Accelerator

Deactivate the global shortcut accelerator.

9.19.4 globalShortcut. UnregisterAll ()

Unregister all global shortcuts registered for the application.

9.20.1 contentTracing. From getCategories was an (the callback)

callback Function

Get a set of classification groups. Classification groups can be changed to new code paths.

Once all child processes have received the getCategories method request, the categories group calls callback.

9.20.2 contentTracing. StartRecording (options, callback)

options Object

categoryFilter String

traceOptions String

callback Function

Start recording all processes.

As soon as a request is received to start recording, the recording is started immediately and the child process is heard asynchronously. Callback will be called when all child processes have received the startRecording request.

CategoryFilter is a filter that controls which category groups should be used for lookup. Filters should have an optional – prefix to exclude matching classification groups. The same list is not allowed to be both included and excluded.

9.20.3 contentTracing. StopRecording (resultFilePath, callback)

resultFilePath String

callback Function

Stops recording of all child processes.

Child processes typically cache lookup data and simply intercept and send the data to the main process. This helps reduce the running overhead of the lookup before sending the lookup data through IPC, which is valuable. Therefore, to send the lookup data, we should asynchronously notify all child processes to intercept any lookup data.

Once all child processes have received a stopRecording request, callback is called and a file containing the lookup data is returned.

If resultFilePath is not empty, the lookup data is written to it, otherwise a temporary file is written. If the actual file path is not empty, callback is called.

9.21.1 powerSaveBlocker. Start (type)

Type String – Forcibly saves the blocking type.

Prevent-app-suspension – Prevents the application from being suspended. Keep the system active, but allow the screen to remain dark. Use case: Download files or play audio.

Prevent-display-sleep – Prevents the application from sleeping. Keep the system and screen active and the screen always lit. Use case: Play audio.

Start blocking the system from going into sleep mode. Returns an integer that identifies the blocker that remains active.

Note: Prevent-display-sleep has a higher precedence of prevent-app-suspension. Only the highest priority takes effect. In other words, prevent-display-sleep always has a higher priority than Prevent-app-suspension.

For example, prevent-app-suspension is called in request A, and prevent-display-sleep is called in request B. Prevent-display-sleep will work until B stops calling. After that, Prevent-app-suspension came into effect.

9.21.2 powerSaveBlocker. Stop (id)

Id Integer – The active Blocker ID returned by powerSaveBlocker.start. Deactivate the specified Blocker.

9.21.3 powerSaveBlocker. IsStarted (id)

Id Integer – The active Blocker ID returned by powerSaveBlocker.start. Returns Boolean if the corresponding powerSaveBlocker has been started.

The power-Monitor module can fire the following events:

Event: ‘suspend’

Triggered when the system is suspended.

Event: ‘resume’

Triggered when the system resumes working. Emitted when system is resuming.

Event: ‘on-ac’

Triggered when the system is using ac. Emitted when the system changes to AC power.

Event: ‘on-battery’

Triggered when the system is running on battery power. Emitted when system changes to battery power.

9.23.1 autoUpdater. SetFeedURL (url)

url String

Set up the URL to check for updates and initiate automatic updates. This URL cannot be changed once set.

9.23.2 autoUpdater. CheckForUpdates ()

Check with the server to see if any updates are available now. Before calling this method, you must first call setFeedURL.

9.23.3 autoUpdater. QuitAndInstall ()

After downloading, restart the current application and install the update. This method should be called only after the update-Downloaded event is triggered.