app（アプリケーション）

Eagleアプリケーションのバージョン、アーキテクチャ、言語などの属性を取得する。

以下はappの一般的な属性の例です：

console.log(eagle.app.version);				// Eagle のバージョン
console.log(eagle.app.build);				// Eagle のビルド番号
console.log(eagle.app.locale);				// アプリケーションの言語設定, en/zh_CN/zh_TW/ja_JP
console.log(eagle.app.arch);				// x86 | x64
console.log(eagle.app.platform);			// darwin | win32
console.log(eagle.app.isWindows);			// true | false, 操作システムが Windows かどうか
console.log(eagle.app.isMac);				// true | false, 操作システムが Mac かどうか
console.log(eagle.app.runningUnderARM64Translation);	// Rosetta 変換モードで実行されているかどうか

メソッド

isDarkColors()

現在のシステムがダーク（Dark）モードであるかどうかを確認します。

• boolean を返します - 現在のシステムがダークモードであるかどうか。

eagle.app.isDarkColors();		// true | false

getPath(name)

以下のパスを名前でリクエストします。

• name string - 以下のパスを名前でリクエストします。

  • home - ユーザーのホームフォルダ（メインディレクトリ）

  • appData - 各ユーザーのアプリケーションデータディレクトリ、デフォルトでは：

  • userData - アプリケーションの設定ファイルを保存するフォルダで、デフォルトは appData フォルダにアプリケーション名が追加されます。習慣的にユーザーが保存するデータファイルはこのディレクトリに書かれるべきですが、大きなファイルをここに書くことはお勧めしません。なぜなら、いくつかの環境ではこのディレクトリがクラウドストレージにバックアップされるためです。

  • temp - 一時ファイルフォルダ

  • exe - 現在の実行ファイル

  • desktop - 現在のユーザーのデスクトップフォルダ

  • documents - ユーザーのドキュメントディレクトリへのパス

  • downloads - ユーザーのダウンロードディレクトリへのパス

  • music - ユーザーの音楽ディレクトリへのパス

  • pictures - ユーザーの画像ディレクトリへのパス

  • videos - ユーザーのビデオディレクトリへのパス

  • recent - ユーザーの最近使用したファイルのディレクトリ (Windows のみ)。

• Promise<path: string> を返します - path はクエリパスの結果です。

await eagle.app.getPath('appData');    // 'C:\Users\User\AppData\Roaming'
await eagle.app.getPath('pictures');    // 'C:\Users\User\Pictures'
await eagle.app.getPath('desktop');    // 'C:\Users\User\Desktop'

備考：この機能は、Electron APIのapp.getPathと類似しています。

getFileIcon(path[, options])

指定されたパスのファイル関連のアイコンを取得します。

• path string - アイコンを取得したいファイルのパス

• options Object（オプション）

  • size string

  • small - 16x16

  • normal - 32x32

  • large - Windowsは32x32、macOSはサポートされていません。

• 戻り値 Promise<img: NativeImage>

  • img NativeImage - NativeImageタイプのアプリアイコン。

let img = await eagle.app.getFileIcon('path_to_file', { size: 'small' });

// 画像情報を取得する
let base64 = img.toDataURL();
let size = img.getSize();    // {'width': 16, height: 16}

// コンピュータに保存する
let buffer = img.toPNG();
require('fs').writeFileSync('output_path/example.png', buffer);

備考：この機能は、Electron APIのapp.getAppIconと類似しています。

createThumbnailFromPath(path, maxSize)

指定されたパスのファイル関連のアイコンを取得します。

• path string - サムネイル画像を取得したいファイルのパス

• maxSize Size - サムネイル画像の最大幅および高さ（正数）を返します。Windowsプラットフォームでは、maxSize.heightが無視され、maxSize.widthに応じて高さが縮小されます。

• 戻り値 Promise<img: NativeImage>

  • img NativeImage - ファイルのサムネイルプレビュー画像。

let img = await eagle.app.createThumbnailFromPath('path_to_file', { 
    height: 200, 
    width: 200 
});

// 画像情報を取得する
let base64 = img.toDataURL();
let size = img.getSize();    // {'width': 200, height: 150}

// コンピュータに保存する
let buffer = img.toPNG();
require('fs').writeFileSync('output_path/example.png', buffer);

備考：この機能は、Electron APIのnativeImage.createThumbnailFromPath(path, maxSize)と類似しています。

show()

Eagle メインアプリケーションウィンドウを前面に表示します。

• Promise<boolean> を返します - 操作が成功したかどうか。

await eagle.app.show();

注意：この機能には Eagle 4.0 build18 以降が必要です。

属性

version

string属性、現在のEagleアプリケーションのバージョンを取得する。

build

number属性、現在のEagleアプリケーションのBuild Numberを取得する。

locale

string属性、現在のEagleアプリケーションのインターフェイス言語を取得する。

• en - 英語

• zh_CN - 簡体字中国語

• zh_TW - 繁体字中国語

• ja_JP - 日本語

• ko_KR - 韓国語

• es_ES - スペイン語

• de_DE - ドイツ語

• ru_RU - ロシア語

arch

string属性、オペレーティングシステムのCPUアーキテクチャを返します。

• x64

• arm64

• x86

platform

string属性、オペレーティングシステムプラットフォームを識別する文字列を返します。

• darwin - macOSオペレーティングシステム

• win32 - Windowsオペレーティングシステム

env

Object属性、環境変数のオブジェクトを返します。

console.log(eagle.app.env);

{
  APPDATA: "C:\\Users\\User\\AppData\\Roaming",
  HOMEDRIVE: "C:",
  HOMEPATH: "\\Users\\User",
  LANG: "zh_TW.UTF-8",
  TEMP: "C:\\Users\\User\\AppData\\Local\\Temp"
}

console.log(eagle.app.env['TEMP']);

"C:\\Users\\User\\AppData\\Local\\Temp"

execPath

string属性、現在のアプリケーションの実行パス。

console.log(eagle.app.execPath);

"C:\\Program Files\\Eagle\\Eagle.exe"

pid

number属性、現在のプラグインプロセスID。

isWindows

boolean属性、現在のWindowオペレーティングシステムであるかどうか。

isMac

boolean属性、現在のMacオペレーティングシステムであるかどうか。

runningUnderARM64Translation

boolean属性、trueの場合、現在のアプリケーションがARM64ランタイム環境（例えばmacOS Rosetta Translator Environment や Windows WOW を使用しています。

ヒント：Electron APIのapp.runningUnderARM64Translation と同様の機能です。このプロパティは、ユーザーが誤って変換環境の下でx64バージョンを実行している時に、アプリケーションのarm64バージョンのダウンロードを促すために使用できます。

theme

string属性、現在のテーマカラーの名前です。例：LIGHT、LIGHTGRAY、GRAY、DARK、BLUE、PURPLE。

userDataPath

string属性、現在のユーザーデータディレクトリのパス。

console.log(eagle.app.userDataPath);

"C:\\Users\\User\\AppData\\Roaming\\Eagle"

注意：この機能にはEagle 4.0 build12以降が必要です。