HBuilderX API根對象可以通過require(‘hbuilderx’)引入。

  1. const hx = require('hbuilderx')

以下列出目前可用的API列表

插件API 詳情
commands commands二級模塊對象,用於處理和命令相關的邏輯詳情
hx.languages.createDiagnosticCollection() 創建一個問題列表,可用於文檔校驗時在文檔出錯區域顯示波浪線標識問題詳情

api:windows

插件API 詳情
hx.window.showErrorMessage() 在窗口右下角顯示錯誤消息通知框詳情
hx.window.showInformationMessage() 在窗口右下角顯示消息通知框詳情
hx.window.showWarningMessage() 在窗口右下角顯示警告消息通知框詳情
hx.window.showMessageBox() 在窗口顯示可供選擇的對話框詳情
hx.window.setStatusBarMessage() 設置狀態欄消息詳情
hx.window.clearStatusBarMessage() 清空狀態欄消息詳情
hx.window.showQuickPick() 在窗口中間彈出一個可搜索的建議選擇列表詳情
hx.window.getActiveTextEditor() 獲取當前激活的編輯器詳情
hx.window.showInputBox() 在窗口中間居中彈出一個輸入框,獲取用戶輸入詳情
hx.window.createOutputChannel() 創建一個輸出控制檯通道,可用於在控制檯輸出文本內容詳情
hx.window.createTreeView() 詳情
hx.window.createWebView() 詳情
hx.window.createWebViewDialog() 創建基於WebView頁面的對話框詳情
hx.window.showView() 切換指定viewId的WebView控件視圖詳情
hx.window.registerUriHandler() 註冊一個依賴hbuilderx協議的自定義網絡請求處理器(schema)詳情
hx.window.registerCustomEditorProvider() 註冊自定義編輯器詳情

api:workspace

插件API 詳情
hx.workspace.applyEdit() 根據指定的WorkspaceEdit對象編輯文檔詳情
hx.workspace.copyFileWithPrompt() 將指定文件或文件夾拷貝到目標文件夾下詳情
hx.workspace.getConfiguration() 根據指定的section獲取對應的配置詳情
hx.workspace.getWorkspaceFolders() 獲取項目管理器下所有的項目對象(不包含已關閉項目)詳情
hx.workspace.getWorkspaceFolder() 獲取某個文件所在的項目詳情
hx.workspace.openTextDocument() 通過指定的uri打開一個文檔文件詳情
hx.workspace.onDidChangeConfiguration() 詳情
hx.workspace.onDidChangeWorkspaceFolders() 詳情
hx.workspace.onDidChangeTextDocument() 詳情
hx.workspace.onDidSaveTextDocument() 詳情
hx.workspace.onDidOpenTextDocument() 詳情
hx.workspace.onWillSaveTextDocument() 文檔即將要保存的事件 詳情

api:env

插件API 詳情
env屬性 詳情
hx.authorize.login() 詳情
hx.env.clipboard 讀取剪切板內容和寫入內容到剪切板 詳情
hx.env.openExternal() 打開一個外部鏈接詳情