• Stars
    star
    149
  • Rank 248,619 (Top 5 %)
  • Language
    TypeScript
  • License
    MIT License
  • Created over 7 years ago
  • Updated about 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

🔍 Should you display a notification? Let's find out!

electron-notification-state

Should you display a notification to your user? This module allows you to check.

Usage

Do Not Disturb / Quiet Hours

const { getDoNotDisturb } from 'electron-notification-state'
// On Windows, logs `true` if "quiet hours" are enabled
// On macOS, logs `true` if "do not disturb" is enabled
console.log(getDoNotDisturb());

Session State

On Windows, you likely want to check SHQueryUserNotificationState, checking whether or not a screensaver is running, if the screen is locked, or if a presentation is running. On macOS, you likely want to check if the screen is locked and if the if the user has an active screen session.

The call below logs a different string, depending on the platform:

macOS

  • SESSION_SCREEN_IS_LOCKED The screen is locked.
  • SESSION_ON_CONSOLE_KEY The user currently has console/graphical control.

Windows

  • QUNS_NOT_PRESENT A screen saver is displayed, the machine is locked, or a nonactive Fast User Switching session is in progress.
  • QUNS_BUSY A full-screen application is running or Presentation Settings are applied. Presentation Settings allow a user to put their machine into a state fit for an uninterrupted presentation, such as a set of PowerPoint slides, with a single click.
  • QUNS_RUNNING_D3D_FULL_SCREEN A full-screen (exclusive mode) Direct3D application is running.
  • QUNS_PRESENTATION_MODE The user has activated Windows presentation settings to block notifications and pop-up messages.
  • QUNS_ACCEPTS_NOTIFICATIONS None of the other states are found, notifications can be freely sent.
  • QUNS_QUIET_TIME Introduced in Windows 7. The current user is in "quiet time", which is the first hour after a new user logs into his or her account for the first time. During this time, most notifications should not be sent or shown. This lets a user become accustomed to a new computer system without those distractions. Quiet time also occurs for each user after an operating system upgrade or clean installation, according to Windows. This is not the same as "quiet hours". Note that during quiet time, if the user is in one of the other blocked modes (QUNS_NOT_PRESENT, QUNS_BUSY, QUNS_PRESENTATION_MODE, or QUNS_RUNNING_D3D_FULL_SCREEN) SHQueryUserNotificationState returns only that value, and does not report QUNS_QUIET_TIME.
  • QUNS_APP Introduced in Windows 8. A Windows Store app is running.
const { getSessionState } from 'electron-notification-state'

console.log(getSessionState());

License

MIT. Please see LICENSE for details.

More Repositories

1

windows95

💩🚀 Windows 95 in Electron. Runs on macOS, Linux, and Windows.
TypeScript
22,225
star
2

macintosh.js

🖥 A virtual Apple Macintosh with System 8, running in Electron. I'm sorry.
JavaScript
8,280
star
3

windows-build-tools

📦 Install C++ Build Tools for Windows using npm
TypeScript
3,398
star
4

npm-windows-upgrade

🚀 Upgrade npm on Windows
JavaScript
2,539
star
5

windows-development-environment

🔭 Turning Windows into an environment ready for modern development
PowerShell
1,359
star
6

React-Dropzone-Component

📷 ReactJS Dropzone for File Uploads (using Dropzone.js)
JavaScript
1,001
star
7

React-Spreadsheet-Component

📋 Spreadsheet Component for ReactJS
JavaScript
763
star
8

electron-windows-notifications

⚡ Send native Windows WinRT notifications from Electron
JavaScript
262
star
9

slack-archive

Generate static HTML archives of Slack workspaces
TypeScript
239
star
10

project-oxford

🔭 Project Oxford for Node
JavaScript
177
star
11

electron-code-editor

⚡ A tiny code editor based on Electron, in ~100 lines of code
JavaScript
159
star
12

Ghost-Azure

👻 Install Ghost on Azure with a simple click
JavaScript
129
star
13

peer-review-bot

A little bot checking GitHub pull requests for peer reviews
JavaScript
102
star
14

vsc-ember-cli

⚡ Turn Visual Studio Code into an Ember Cli IDE
TypeScript
92
star
15

razer-chroma

🔥 Control your Razer Keyboard, right from Node
C++
90
star
16

electron-uwp-background

⚡ Sample explaining how to use UWP background tasks with Electron apps
C#
82
star
17

Node-Mayhem

💣 Multiplayer HTML5 shooter with Node.js, Socket.io and Melon.js
JavaScript
69
star
18

Ghost-Updater-Azure

👻 Update Ghost on Azure Websites / Azure Web Apps with a few clicks
JavaScript
62
star
19

electron-windows-interactive-notifications

⚡ Respond to interactive notifications on Windows, from Electron
C++
57
star
20

responsive-images-generator

Generate responsive images from Node
JavaScript
55
star
21

dennard

🔬 Tiny Node cli tool to see a local app's memory footprint, cross-platform
JavaScript
54
star
22

macos-notification-state

🔍 This native module checks if the user is active, if the screen is locked, or if "do not disturb" is enabled.
Objective-C++
53
star
23

travis-jekyll-git

Deploy Jekyll pages using Git and Travis CI
Shell
44
star
24

Reveal-PikeStreet

"Pike Street" Theme for Reveal.js, intended for Microsoft's DX's Open Source Engineers
JavaScript
44
star
25

monaco-loader

📦 Load the Monaco editor with a module loader (require, import, etc)
JavaScript
36
star
26

introducing-electron-editor

Code used in the book "Introducing Electron"
JavaScript
36
star
27

JARVIS

Node.js Personal Assistant Prototype
JavaScript
30
star
28

windows-quiet-hours

Checks if Windows 10 quiet hours are active
JavaScript
26
star
29

parse-server-azure

Adapters, tools, and documentation to use Parse-Server with Microsoft Azure
JavaScript
23
star
30

onedrive-link

Generate direct download links for OneDrive
JavaScript
23
star
31

vsc-travis-ci-status

:shipit: Check the status of your Travis CI project from Visual Studio Code
TypeScript
23
star
32

parse-docker

🚤 Run the Open Source Parse Server in Docker
JavaScript
22
star
33

electron-windows-sample

⚡ A minimal Electron sample application showing how to make an Electron app look native on Windows
JavaScript
20
star
34

ember-cli-azure-deploy

🔧 Build Ember Cli Apps on Azure Websites
Shell
19
star
35

electron-comrade

🔧 Run Electron apps with different versions or builds of Electron
TypeScript
18
star
36

parse-server-azure-storage

Use Azure Blob Storage with Parse Server
JavaScript
16
star
37

windows-shortcuts-ps

Node.js: Read Windows shortcuts without native dependencies (Windows 7 and up)
JavaScript
15
star
38

parse-docker-azure

🐳 Deploy the Open Source Parse Server on Azure, using Docker
15
star
39

iojs-azure

Running io.js on Azure Websites
Shell
15
star
40

emoji-autocomplete

📇 Node Library, turning words into emojis (turn rent into 🏠 💸)
JavaScript
14
star
41

windows-active-process

Check which process is currently in the foreground (focused / active)
C++
14
star
42

electron-winstore-auto-launch

🚀 Configure your Electron to start automatically when the user logs in
TypeScript
14
star
43

ember-cli-windows-addon

🚤 Ember Addon, Optimizing Ember Cli Performance on Windows
JavaScript
14
star
44

WinBridge

Native WinRT Controls & Features for Unity3D
C#
14
star
45

MicrosoftBand-Sample

A small sample showcasing interaction with the Microsoft Band
C#
13
star
46

sleuth

🕵️‍♂️ A Slack log viewer
TypeScript
12
star
47

windows-notification-state

SHQueryUserNotificationState, but as a native Node addon
JavaScript
11
star
48

SlackbotBender

A simple chatbot for slack.
JavaScript
10
star
49

medium-stats

You want Medium stats for traffic sources, this tool will give them to you
JavaScript
10
star
50

electron-smorgasbord

📦 A local update server for Squirrel & Electron, with a fancy GUI
TypeScript
10
star
51

lets-encrypt-iis

IIS Configurator for the wonderful Let's Encrypt project
Python
10
star
52

electron-face-detection-windows

Detect Faces in images, using Windows' very own face detection
JavaScript
9
star
53

chrome-cachetool

Chrome & Chromium's "cachetool"
TypeScript
9
star
54

Ghost-Desktop

Ghost for Desktops
JavaScript
7
star
55

azure-node4

Run Node.js 4.0 on Azure
Shell
7
star
56

modernweb

Code Demo for ModernWeb 2018 Keynote
HTML
6
star
57

javascript-course

Solutions to my little JavaScript course's exercises
JavaScript
6
star
58

electron-versions

Get Electron and Chromium versions for tags in a given repository
TypeScript
6
star
59

node-app-nap

😴 Disable macOS App Nap using Node
Objective-C++
5
star
60

electron-test-build

Take a built Electron app, replace the version of Electron
JavaScript
4
star
61

azure-npm3

Use npm3 on Azure Web Apps (formerly known as Azure Websites)
Shell
4
star
62

docker-jekyll

🐳 Jekyll with Extras for Docker
4
star
63

electron-forge-maker-nsis

An electron-forge maker for NSIS that supports electron-forge v6 and can be used as a replacement for electron-builder. Supports code-signing and basic updates with electron-updater.
TypeScript
4
star
64

electron-squirrel-s3

Update your Electron app directly from S3
TypeScript
4
star
65

UnityGettingStarted

Code for the TR Unity Presentation
C#
4
star
66

nodesummit-workshop

JavaScript
4
star
67

waffle

JavaScript
4
star
68

windows-process-info

In Node.js, quickly check if a process is running on win32. Fast, small, native.
JavaScript
4
star
69

shout-azure

🔈 Deploy Shout to Azure
3
star
70

AndroidAzureTweets

A sample Twitter-Style app using Azure Mobile Services for Android
Java
3
star
71

mountaingiantweb

JavaScript
3
star
72

find-npm-windows

📦 Find npm on Windows
JavaScript
3
star
73

dengue-research-portal

💻 A researcher's portal into dengue fever history and machine learning prediction
JavaScript
3
star
74

internet-explorer-version

Find the installed version of Internet Explorer, using Node.js
JavaScript
3
star
75

wrapped

A silly "wrapped" generator for my team
TypeScript
3
star
76

chrome-software-rendering-list

🙅 Chromium's list of blacklisted GPUs, consumable as a Node module
JavaScript
2
star
77

Unity-WinRT-WP8-PlayMovieNatively

Playing a movie on WinRT from within Unity
C#
2
star
78

atom-ghost

Write your blog posts in Atom, publish with Ghost
JavaScript
2
star
79

slack-wechat-bridge

TypeScript
2
star
80

SmoothRawMouse-UnityWindows8

Smoothened Mouse device delta readings in Unity for Windows 8 Store
C#
2
star
81

DJWindows98

A Mini Stage Show for DJ Windows 98
C#
2
star
82

node12-azure

Run Node 0.12 (Stable) on Azure Websites
Shell
2
star
83

adfreeclient

Client for AdFree, TechCrunch Disrupt Hackathon Project
CSS
2
star
84

LockLogger

A little debugging tool to log your session status
JavaScript
2
star
85

ember-visual-studio

A Visual Studio extension for Ember and Ember Cli
C#
1
star
86

ghost-arm

Ghost for ARM
JavaScript
1
star
87

sailsjs-azure

SailsJS, deployable to Azure
JavaScript
1
star
88

test-windows-linux-subsystem

⚡ We should probably test this Linux thing we just got
Shell
1
star
89

buy-my-vanagon

https://www.1979vanagon.com
HTML
1
star
90

SquirrelCLSIDForAppUserModelId

Quickly see what ToastActivatorCLSID Squirrel would generate for your AppUserModelId
C#
1
star
91

electron-drone

JavaScript
1
star
92

sanitize-xml-string

Sanitize a string for use with XML
TypeScript
1
star
93

npm-config-arguments

Parses npm_config env variables and assigns them to argv - useful for 'npm run' commands
JavaScript
1
star
94

kona

🏃 Kona A Slack Bot for Strava
TypeScript
1
star
95

tile

C++
1
star
96

electron-slack-tutorial

TypeScript
1
star
97

OxideFleet

Oxide, but for Car Management
JavaScript
1
star
98

runtime-logo

A logo for Slack's Desktop Runtime team
JavaScript
1
star
99

electron-react-playground

TypeScript
1
star
100

ember-service-worker-ghost-cache

JavaScript
1
star