Skip to content

Latest commit

 

History

History
64 lines (45 loc) · 2.76 KB

jsapi.md

File metadata and controls

64 lines (45 loc) · 2.76 KB
layout
doc

JS 扩展对象概述

pyChariot 内置了扩展对象供 JavaScript 调用。因此，应用可以获得在浏览器中运行时无法获得的功能（例如读写本地文件，本地消息提醒）。

pyChariot 中所有的 JSAPI 皆考虑到跨平台，最大可能的保证在主流操作系统下行为一致。但由于操作系统的差异，某些功能存在差异或仅被限定的操作系统支持。

注意：所有 JSAPI 调用皆为异步调用模式，返回值皆为 Promise。 请使用异步编程（例如：callback, then, await, async...）， 具体请参阅 JavaScript 相关文档 。

JS 调用与返回

pyChariot 会在浏览器组件窗口装载完成之后新增对象： window.pyChariot，之后触发事件 pyChariotReady。 该准备工作完成以后就可以在 JavaScript 中调用扩展对象功能。否则，即 pyChariotReady 事件触发之前，将会出现错误，可以通过侦听事件来解决这个问题。

window.addEventListener('pyChariotReady', function () {
    alert('pyChariot 已就绪。');
})

为了方便使用，pyChariot 将扩展按功能分成了多个模块，公开于 window.pyChariot.api 下。 通过 window.pyChariot.api.<模块名>.<函数名> 这样的方式来进行调用。 所有扩展调用函数，返回值皆为 Promise，为了方便说明理解，文档中的返回值按普通方式来编写。

为了简化写法，方便偷懒，定义了一些预设变量：

__C = window.pyChariot
__A = window.pyChariot.api
__T = window.pyChariot.token

例如下面几个是等价的调用：

window.pyChariot.api.core.exit();
pyChariot.api.core.exit();
__A.core.exit();

增加与完善

pyChariot 以宁缺毋滥的态度来增加 JSAPI，现有扩展已满足大多数常见应用场景。

如果没有您需要的模块，可以 在这里提出需求 。 我们将定期整理，判断是否增加，并整理出优先顺序逐步完善。

  • 现有 API 缺陷的修复，优先级提高
  • 需求量大，多人提出的，优先级提高
  • 对项目有帮助的人员提出的，优先级提高
  • 赞助者提出的，优先级提高

请原谅我们的时间和精力有限，所有的需求都会尽量排期实现，但无法保证一定会被实现或何时实现。

系统兼容性

pyChariot 以 python 作为开发语言，本身是跨平台的，但是依然需要其他包的支持。 我们会尽量使用跨平台，一致性的python包，但是很遗憾，仍然有些功能在平台上存在差异。 我们会尽量的保证jsapi在多个操作系统上的一致性，但是依然需要开发者注意差异并做好测试。