app

app 모듈은 어플리케이션의 생명주기 제어를 책임집니다.

밑의 예제는 마지막 윈도우가 종료되었을 때, 어플리케이션을 종료시키는 예제입니다:

const app = require('electron').app;
app.on('window-all-closed', function() {
  app.quit();
});

Events

app 객체는 다음과 같은 이벤트를 가지고 있습니다:

Event: 'will-finish-launching'

어플리케이션이 기본적인 시작 준비를 마치면 발생하는 이벤트입니다. Windows, Linux 운영체제에서의 will-finish-launching 이벤트는 ready 이벤트와 동일합니다. OS X에서의 이벤트는 NSApplication의 applicationWillFinishLaunching에 대한 알림으로 표현됩니다. 대개 이곳에서 open-file과 open-url 이벤트 리스너를 설정하고 crash reporter와 auto updater를 시작합니다.

대부분의 경우, 모든 것을 ready 이벤트 핸들러로 해결해야 합니다.

Event: 'ready'

Electron이 초기화를 끝냈을 때 발생하는 이벤트입니다.

Event: 'window-all-closed'

모든 윈도우가 종료되었을 때 발생하는 이벤트입니다.

이 이벤트는 어플리케이션이 완전히 종료되지 않았을 때만 발생합니다. 만약 사용자가 Cmd + Q를 입력했거나 개발자가 app.quit()를 호출했다면, Electron은 먼저 모든 윈도우의 종료를 시도하고 will-quit 이벤트를 발생시킵니다. 그리고 will-quit 이벤트가 발생했을 땐 window-all-closed 이벤트가 발생하지 않습니다.

역주: 이 이벤트는 말 그대로 현재 어플리케이션에서 윈도우만 완전히 종료됬을 때 발생하는 이벤트 입니다. 따라서 어플리케이션을 완전히 종료하려면 이 이벤트에서 app.quit()를 호출해 주어야 합니다.

Event: 'before-quit'

Returns:

• event Event

어플리케이션 윈도우들이 닫히기 시작할 때 발생하는 이벤트입니다. event.preventDefault() 호출은 이벤트의 기본 동작을 방지하기 때문에 이를 통해 어플리케이션의 종료를 방지할 수 있습니다.

Event: 'will-quit'

Returns:

• event Event

모든 윈도우들이 종료되고 어플리케이션이 종료되기 시작할 때 발생하는 이벤트 입니다. event.preventDefault() 호출을 통해 어플리케이션의 종료를 방지할 수 있습니다.

will-quit 와 window-all-closed 이벤트의 차이점을 확인하려면 window-all-close 이벤트의 설명을 참고하세요.

Event: 'quit'

Returns:

• event Event
• exitCode Integer

어플리케이션이 종료될 때 발생하는 이벤트입니다.

Event: 'open-file' OS X

Returns:

• event Event
• path String

사용자가 어플리케이션을 통해 파일을 열고자 할 때 발생하는 이벤트입니다.

open-file 이벤트는 보통 어플리케이션이 열려 있을 때 OS가 파일을 열기 위해 어플리케이션을 재사용할 때 발생합니다. 이 이벤트는 파일을 dock에 떨어트릴 때, 어플리케이션이 실행되기 전에도 발생합니다. 따라서 이 이벤트를 제대로 처리하려면 open-file 이벤트 핸들러를 어플리케이션이 시작하기 전에 등록해 놓았는지 확실히 확인해야 합니다. (ready 이벤트가 발생하기 전에)

이 이벤트를 처리할 땐 반드시 event.preventDefault()를 호출해야 합니다.

Windows에선 process.argv (메인 프로세스에서)를 통해 파일 경로를 얻을 수 있습니다.

Event: 'open-url' OS X

Returns:

• event Event
• url String

유저가 어플리케이션을 통해 URL을 열고자 할 때 발생하는 이벤트입니다.

어플리케이션에서 URL을 열기 위해 반드시 URL 스킴이 등록되어 있어야 합니다.

이 이벤트를 처리할 땐 반드시 event.preventDefault()를 호출해야 합니다.

Event: 'activate' OS X

Returns:

• event Event
• hasVisibleWindows Boolean

어플리케이션이 활성화 되었을 때 발생하는 이벤트 입니다. 이 이벤트는 어플리케이션의 dock 아이콘을 클릭했을 때 주로 발생합니다.

Event: 'browser-window-blur'

Returns:

• event Event
• window BrowserWindow

browserWindow에 대한 포커스가 사라졌을 때 발생하는 이벤트 입니다.

Event: 'browser-window-focus'

Returns:

• event Event
• window BrowserWindow

browserWindow에 대한 포커스가 발생했을 때 발생하는 이벤트 입니다.

역주: 포커스 는 창을 클릭해서 활성화 시켰을 때를 말합니다.

Event: 'browser-window-created'

Returns:

• event Event
• window BrowserWindow

새로운 browserWindow가 생성되었을 때 발생하는 이벤트 입니다.

Event: 'certificate-error'

Returns:

• event Event
• webContents WebContents
• url URL
• error String - 에러 코드
• certificate Object
  • data Buffer - PEM 인코딩된 데이터
  • issuerName String
• callback Function

url에 대한 certificate 인증서의 유효성 검증에 실패했을 때 발생하는 이벤트입니다. 인증서를 신뢰한다면 event.preventDefault() 와 callback(true)를 호출하여 기본 동작을 방지하고 인증을 승인할 수 있습니다.

app.on('certificate-error', function(event, webContents, url, error, certificate, callback) {
  if (url == "https://github.com") {
    // Verification logic.
    event.preventDefault();
    callback(true);
  } else {
    callback(false);
  }
});

Event: 'select-client-certificate'

Returns:

• event Event
• webContents WebContents
• url URL
• certificateList [Objects]
  • data Buffer - PEM으로 인코딩된 데이터
  • issuerName String - 발급자의 공통 이름
• callback Function

클라이언트 인증이 요청되었을 때 발생하는 이벤트 입니다.

url은 클라이언트 인증서를 요청하는 탐색 항목에 해당합니다. 그리고 callback은 목록에서 필터링된 항목과 함께 호출될 필요가 있습니다. 이 이벤트에서의 event.preventDefault() 호출은 초기 인증 때 저장된 데이터를 사용하는 것을 막습니다.

app.on('select-client-certificate', function(event, webContents, url, list, callback) {
  event.preventDefault();
  callback(list[0]);
})

Event: 'login'

Returns:

• event Event
• webContents WebContents
• request Object
  • method String
  • url URL
  • referrer URL
• authInfo Object
  • isProxy Boolean
  • scheme String
  • host String
  • port Integer
  • realm String
• callback Function

webContents가 기본 인증을 요청할 때 발생하는 이벤트입니다.

기본 동작은 인증 요청을 모두 취소시킵니다. 동작을 새로 정의하려면 반드시 event.preventDefault()를 호출한 후 callback(username, password) 형태의 콜백을 호출하여 인증을 처리해야 합니다.

app.on('login', function(event, webContents, request, authInfo, callback) {
  event.preventDefault();
  callback('username', 'secret');
})

Event: 'gpu-process-crashed'

GPU가 작동하던 중 크래시가 일어났을 때 발생하는 이벤트입니다.

Methods

app 객체는 다음과 같은 메서드를 가지고 있습니다:

참고: 몇몇 메서드는 특정 플랫폼에서만 작동합니다.

app.quit()

모든 윈도우 종료를 시도합니다. before-quit 이벤트가 먼저 발생합니다. 모든 윈도우가 성공적으로 종료되면 will-quit 이벤트가 발생하고 기본 동작에 따라 어플리케이션이 종료됩니다.

이 함수는 모든 beforeunload와 unload 이벤트 핸들러가 제대로 실행됨을 보장합니다. beforeunload 이벤트 핸들러에서 false를 반환했을 때 윈도우 종료가 취소 될 수 있습니다.

app.hide() OS X

최소화를 하지 않고 어플리케이션의 모든 윈도우들을 숨깁니다.

app.show() OS X

숨긴 어플리케이션 윈도우들을 다시 보이게 만듭니다. 자동으로 포커스되지 않습니다.

app.exit(exitCode)

• exitCode Integer

exitCode와 함께 어플리케이션을 즉시 종료합니다.

모든 윈도우는 사용자의 동의 여부에 상관없이 즉시 종료되며 before-quit 이벤트와 will-quit 이벤트가 발생하지 않습니다.

app.getAppPath()

현재 어플리케이션의 디렉터리를 반환합니다.

app.getPath(name)

• name String

name에 관련한 특정 디렉터리 또는 파일의 경로를 반환합니다. 경로를 가져오는 데 실패할 경우 Error를 반환합니다.

역주: 이 메서드는 운영체제에서 지정한 특수 디렉터리를 가져오는데 사용할 수 있습니다.

name은 다음 목록에 있는 경로 중 하나를 선택해 사용할 수 있습니다:

• home - 사용자의 홈 디렉터리.
• appData - 각 사용자의 어플리케이션 데이터 디렉터리. 기본 경로는 다음과 같습니다:
  • %APPDATA% - Windows
  • $XDG_CONFIG_HOME 또는 ~/.config - Linux
  • ~/Library/Application Support - OS X
• userData - 어플리케이션의 설정을 저장하는 디렉터리. 이 디렉터리는 기본적으로 appData에 어플리케이션 이름으로 생성된 폴더가 지정됩니다.
• temp - 임시 폴더 디렉터리.
• userDesktop - 현재 사용자의 데스트탑 디렉터리.
• exe - 현재 실행중인 Electron 바이너리 파일.
• module - libchromiumcontent 라이브러리.
• desktop - 사용자의 데스크탑 디렉터리.
• documents - 사용자의 "내 문서" 디렉터리.
• downloads - 사용자의 다운로드 디렉터리.
• music - 사용자의 음악 디렉터리.
• pictures - 사용자의 사진 디렉터리.
• videos - 사용자의 동영상 디렉터리.

app.setPath(name, path)

• name String
• path String

name에 대한 특정 디렉터리나 파일의 경로인 path를 재정의합니다. 만약 지정한 디렉터리의 경로가 존재하지 않으면 디렉터리가 이 메서드를 통해 새로 생성됩니다. 재정의에 실패했을 땐 Error를 반환합니다.

이 메서드는 app.getPath에 정의되어 있는 name의 경로만 재정의할 수 있습니다.

기본적으로, 웹 페이지의 쿠키와 캐시는 userData 디렉터리에 저장됩니다. 만약 이 위치를 변경하고자 한다면, 반드시 app 모듈의 ready 이벤트가 발생하기 전에 userData 경로를 재정의해야 합니다.

app.getVersion()

로드된 어플리케이션의 버전을 반환합니다.

만약 package.json 파일에서 어플리케이션의 버전을 찾을 수 없는 경우, 현재 번들 또는 실행 파일의 버전을 반환합니다.

app.getName()

package.json에서 기술된 현재 어플리케이션의 이름을 반환합니다.

npm 모듈 규칙에 따라 대부분의 경우 package.json의 name 필드는 소문자 이름을 사용합니다. 하지만 Electron은 name대신 productName 필드를 주로 사용하기 때문에 반드시 이 필드도 같이 지정해야 합니다. 이 필드는 맨 앞글자가 대문자인 어플리케이션 전체 이름을 지정해야 합니다.

app.getLocale()

현재 어플리케이션의 로케일을 반환합니다.

app.addRecentDocument(path) OS X Windows

• path String

최근 문서 목록에 path를 추가합니다.

이 목록은 OS에 의해 관리됩니다. 최근 문서 목록은 Windows의 경우 작업 표시줄에서 찾을 수 있고, OS X의 경우 dock 메뉴에서 찾을 수 있습니다.

app.clearRecentDocuments() OS X Windows

최근 문서 목록을 모두 비웁니다.

app.setUserTasks(tasks) Windows

• tasks Array - Task 객체의 배열

Windows에서 사용할 수 있는 JumpList의 Tasks 카테고리에 task를 추가합니다.

tasks는 다음과 같은 구조를 가지는 Task 객체의 배열입니다:

Task Object:

• program String - 실행할 프로그램의 경로. 보통 현재 작동중인 어플리케이션의 경로인 process.execPath를 지정합니다.
• arguments String - program이 실행될 때 사용될 명령줄 인자.
• title String - JumpList에 표시할 문자열.
• description String - 이 작업에 대한 설명.
• iconPath String - JumpList에 표시될 아이콘의 절대 경로. 아이콘을 포함하고 있는 임의의 리소스 파일을 사용할 수 있습니다. 보통 어플리케이션의 아이콘을 그대로 사용하기 위해 process.execPath를 지정합니다.
• iconIndex Integer - 아이콘 파일의 인덱스. 만약 아이콘 파일이 두 개 이상의 아이콘을 가지고 있을 경우, 사용할 아이콘의 인덱스를 이 옵션으로 지정해 주어야 합니다. 단, 아이콘을 하나만 포함하고 있는 경우 0을 지정하면 됩니다.

app.allowNTLMCredentialsForAllDomains(allow)

• allow Boolean

항상 동적으로 HTTP NTLM 또는 Negotiate 인증에 자격 증명을 보낼 것인지 설정합니다.

기본적으로 Electron은 "로컬 인터넷" 사이트 URL에서 NTLM/Kerberos 자격 증명만을 보냅니다. (같은 도메인 내에서) 그러나 기업 네트워크가 잘못 구성된 경우 종종 작업에 실패할 수 있습니다. 이때 이 메서드를 통해 모든 URL을 허용할 수 있습니다.

app.makeSingleInstance(callback)

• callback Function

현재 어플리케이션을 Single Instance Application 으로 만들어줍니다. 이 메서드는 어플리케이션이 여러 번 실행됐을 때 다중 인스턴스가 생성되는 대신 한 개의 주 인스턴스만 유지되도록 만들 수 있습니다. 이때 중복 생성된 인스턴스는 주 인스턴스에 신호를 보내고 종료됩니다.

callback은 주 인스턴스가 생성된 이후 또 다른 인스턴스가 생성됐을 때 callback(argv, workingDirectory) 형식으로 호출됩니다. argv는 두 번째 인스턴스의 명령줄 인수이며 workingDirectory는 현재 작업중인 디렉터리입니다. 보통 대부분의 어플리케이션은 이러한 콜백이 호출될 때 주 윈도우를 포커스하고 최소화되어있으면 창 복구를 실행합니다.

callback은 app의 ready 이벤트가 발생한 후 실행됨을 보장합니다.

이 메서드는 현재 실행된 어플리케이션이 주 인스턴스인 경우 false를 반환하고 어플리케이션의 로드가 계속 진행 되도록 합니다. 그리고 두 번째 중복된 인스턴스 생성인 경우 true를 반환합니다. (다른 인스턴스에 인수가 전달됬을 때) 이 불리언 값을 통해 중복 생성된 인스턴스는 즉시 종료시켜야 합니다.

OS X에선 사용자가 Finder에서 어플리케이션의 두 번째 인스턴스를 열려고 했을 때 자동으로 Single Instance 화 하고 open-file과 open-url 이벤트를 발생시킵니다. 그러나 사용자가 어플리케이션을 CLI 터미널에서 실행하면 운영체제 시스템의 싱글 인스턴스 메커니즘이 무시되며 그대로 중복 실행됩니다. 따라서 OS X에서도 이 메서드를 통해 확실히 중복 실행을 방지하는 것이 좋습니다.

다음 예제는 두 번째 인스턴스가 생성되었을 때 중복된 인스턴스를 종료하고 주 어플리케이션 인스턴스의 윈도우를 활성화 시키는 예제입니다:

var myWindow = null;

var shouldQuit = app.makeSingleInstance(function(commandLine, workingDirectory) {
  // 어플리케이션을 중복 실행했습니다. 주 어플리케이션 인스턴스를 활성화 합니다.
  if (myWindow) {
    if (myWindow.isMinimized()) myWindow.restore();
    myWindow.focus();
  }
  return true;
});

if (shouldQuit) {
  app.quit();
  return;
}

// 윈도우를 생성하고 각종 리소스를 로드하고 작업합니다.
app.on('ready', function() {
});

app.setAppUserModelId(id) Windows

• id String

Application User Model ID를 id로 변경합니다.

app.isAeroGlassEnabled() Windows

이 메서드는 DWM 컴포지션 (Aero Glass)가 활성화 되어있을 때 true를 반환합니다. 아닌 경우 false를 반환합니다. 이 메서드는 투명한 윈도우를 만들기 위해 사용 가능 여부를 확인할 때 사용할 수 있습니다. (투명한 윈도우는 DWM 컴포지션이 비활성화되어있을 시 작동하지 않습니다)

사용 예시:

let browserOptions = {width: 1000, height: 800};

// 플랫폼이 지원하는 경우에만 투명 윈도우를 생성
if (process.platform !== 'win32' || app.isAeroGlassEnabled()) {
  browserOptions.transparent = true;
  browserOptions.frame = false;
}

// 원도우 생성
win = new BrowserWindow(browserOptions);

// 페이지 로드
if (browserOptions.transparent) {
  win.loadURL('file://' + __dirname + '/index.html');
} else {
  // 투명 윈도우 상태가 아니라면, 기본적인 폴백 스타일 사용
  win.loadURL('file://' + __dirname + '/fallback.html');
}

app.commandLine.appendSwitch(switch[, value])

Chrominum의 명령줄에 스위치를 추가합니다. value는 추가적인 값을 뜻하며 옵션입니다.

참고: 이 메서드는 process.argv에 영향을 주지 않습니다. 개발자들은 보통 Chrominum의 로우 레벨 수준의 동작을 제어하기 위해 주로 사용합니다.

app.commandLine.appendArgument(value)

Chrominum의 명령줄에 인수를 추가합니다. 인수는 올바르게 인용됩니다.

참고: 이 메서드는 process.argv에 영향을 주지 않습니다.

app.dock.bounce([type]) OS X

• type String (optional) - critical 또는 informational을 지정할 수 있습니다. 기본값은 informational 입니다.

critical이 전달되면 dock 아이콘이 어플리케이션이 활성화되거나 요청이 중지되기 전까지 통통 튑니다.

informational이 전달되면 dock 아이콘이 1초만 통통 튑니다. 하지만 어플리케이션이 활성화되거나 요청이 중지되기 전까지 요청은 계속 활성화로 유지 됩니다.

또한 요청을 취소할 때 사용할 수 있는 ID를 반환합니다.

app.dock.cancelBounce(id) OS X

• id Integer

app.dock.bounce([type]) 메서드에서 반환한 id의 통통 튀는 효과를 취소합니다.

app.dock.setBadge(text) OS X

• text String

dock의 badge에 표시할 문자열을 설정합니다.

app.dock.getBadge() OS X

dock의 badge에 설정된 문자열을 반환합니다.

app.dock.hide() OS X

dock 아이콘을 숨깁니다.

app.dock.show() OS X

dock 아이콘을 표시합니다.

app.dock.setMenu(menu) OS X

• menu Menu

어플리케이션의 dock menu를 설정합니다.

app.dock.setIcon(image) OS X

• image NativeImage

dock 아이콘의 image를 설정합니다.