register()
ショートカットキーの操作を登録します。
Desktop.shortcutKey.register([{
componentName: "Sample Comp",
actionName: "login",
modifierKeys: "ctrlKey_altKey",
key: "r",
callback: (data: Service.shortcut.EKeyInfo) => {}
}])
名前 |
タイプ |
説明 |
必須 |
---|---|---|---|
componentName |
文字列 |
機能、コンポーネント、またはウィジェットの名前。 |
はい |
actionName |
文字列 |
割り当てられたショートカットキーによって実行されるアクションまたは操作の名前。 |
はい |
modifierKeys |
文字列 |
修飾子キーは、ホストプラットフォームのキーボードショートカットで共通して使用されます。キーボード修飾子キーの組み合わせは次のとおりです。
|
はい |
key |
文字列 |
修飾子キーと組み合わせるメインキー。たとえば、Ctrl+Shift+e では、Ctrl と Shift が修飾子キーで、e がメインキーです。 |
はい |
callback |
関数 |
クライアントコードでは、ショートカットキーの登録中にコールバック機能を追加できます。ショートカットキーのフレームワークが、キーボード keyup イベントは、キーが解放されると呼び出されます。
|
はい |
戻り値
{Array}
オブジェクトの配列。
応答の例
const register = {
[{
"widgetElement": "agentx-wc-navigation",
"group": "Navigation",
"action": "Open Home Page",
"modifierKeys": "ctrlKey_altKey",
"key": "1"
},
// widgetElement is the name of the web component
// group is the name of the functionality, component, or the widget.
{
"widgetElement": "agentx-wc-navigation",
"group": "Navigation",
"action": "Open Agent Performance Statistics Page",
"modifierKeys": "ctrlKey_altKey",
"key": "2"
},
{
"widgetElement": "agentx-wc-navigation",
"group": "Navigation",
"action": "Open Widget Using JS API Page",
"modifierKeys": "ctrlKey_altKey",
"key": "3"
}
]
}