uTools-Manuals/index/utools.json

1 line
4.7 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

[{"name":"onPluginReady(callback)","type":"事件","path":"utools/事件.html#onPluginReady(callback)","desc":"当插件装载成功uTools将会主动调用这个方法生命周期内仅调用一次"},{"name":"onPluginEnter(callback)","type":"事件","path":"utools/事件.html#onPluginEnter(callback)","desc":"每当插件从后台进入到前台时uTools将会主动调用这个方法"},{"name":"onPluginOut(callback)","type":"事件","path":"utools/事件.html#onPluginOut(callback)","desc":"每当插件从前台进入到后台时uTools将会主动调用这个方法"},{"name":"onPluginDetach(callback)","type":"事件","path":"utools/事件.html#onPluginDetach(callback)","desc":"用户对插件进行分离操作时uTools将会主动调用这个方法"},{"name":"onDbPull(callback)","type":"事件","path":"utools/事件.html#onDbPull(callback)","desc":"当此插件的数据在其他设备上被更改后同步到此设备时uTools将会主动调用这个方法必须在插件可视的情况下才会触发"},{"name":"utools.db.put(Object)","type":"数据库","path":"utools/数据库.html#utools.db.put(Object)","desc":"执行该方法将会创建或更新数据库文档"},{"name":"utools.db.get(string)","type":"数据库","path":"utools/数据库.html#utools.db.get(string)","desc":"执行该方法将会根据文档ID获取数据"},{"name":"utools.db.remove(string | Object)","type":"数据库","path":"utools/数据库.html#utools.db.remove(string | Object)","desc":"执行该方法将会删除数据库文档可以传入文档对象或文档id进行操作"},{"name":"utools.db.bulkDocs(Array)","type":"数据库","path":"utools/数据库.html#utools.db.bulkDocs(Array)","desc":"执行该方法将会批量更新数据库文档,传入需要更改的文档对象合并成数组进行批量更新"},{"name":"utools.db.allDocs(String|Array)","type":"数据库","path":"utools/数据库.html#utools.db.allDocs(String|Array)","desc":"执行该方法将会获取所有数据库文档如果传入字符串则会返回以字符串开头的文档也可以传入指定ID的数组不传入则为获取所有文档"},{"name":"hideMainWindow","type":"窗口管理","path":"utools/窗口管理.html#hideMainWindow","desc":"执行该方法将会隐藏uTools主窗口包括此时正在主窗口运行的插件分离的插件不会被隐藏"},{"name":"showMainWindow","type":"窗口管理","path":"utools/窗口管理.html#showMainWindow","desc":"执行该方法将会显示uTools主窗口包括此时正在主窗口运行的插件"},{"name":"setExpendHeight","type":"窗口管理","path":"utools/窗口管理.html#setExpendHeight","desc":"执行该方法将会修改插件窗口的高度"},{"name":"setSubInput","type":"窗口管理","path":"utools/窗口管理.html#setSubInput","desc":"设置子输入框进入插件后原本uTools的搜索条主输入框将会变成子输入框设置完子输入框搜索条子输入框可以为插件所使用"},{"name":"removeSubInput","type":"窗口管理","path":"utools/窗口管理.html#removeSubInput","desc":"移出先前设置的子输入框,在插件切换到其他页面时可以重新设置子输入框为其所用"},{"name":"setSubInputValue","type":"窗口管理","path":"utools/窗口管理.html#setSubInputValue","desc":"直接对子输入框的值进行设置"},{"name":"outPlugin","type":"窗口管理","path":"utools/窗口管理.html#outPlugin","desc":"执行该方法将会退出当前插件"},{"name":"showNotification","type":"窗口管理","path":"utools/窗口管理.html#showNotification","desc":"执行该方法将会弹出一个系统通知"},{"name":"getFeatures","type":"动态增减功能","path":"utools/动态增减功能.html#getFeatures","desc":"很多时候插件中会提供一些功能供用户进行个性化设置例如网页快开插件这部分配置无法在plugin.json事先定义好所以我们提供了以下方法对插件功能进行动态增减"},{"name":"setFeature","type":"动态增减功能","path":"utools/动态增减功能.html#setFeature","desc":"返回本插件所有动态增加的功能"},{"name":"removeFeature","type":"动态增减功能","path":"utools/动态增减功能.html#removeFeature","desc":"为本插件动态新增某个功能"},{"name":"isHadPrivilege","type":"其他","path":"utools/其他.html#isHadPrivilege","desc":"该方法只适用于在macOS下执行用于判断uTools是否拥有辅助权限如果没有可以调用API方法requestPrivilege请求"},{"name":"requestPrivilege","type":"其他","path":"utools/其他.html#requestPrivilege","desc":"该方法只适用于在macOS下执行该方法调用后会弹出窗口向用户申请辅助权限"},{"name":"getPath","type":"其他","path":"utools/其他.html#getPath","desc":"返回系统的特殊路径"}]