matrix-angular-sdk 0.6.8

Matrix Angular SDK

本项目提供了实现客户端-服务器API在Matrix上的AngularJS服务：一个用于互操作即时消息和VoIP的开放标准。它附带Synapse：一个家庭服务器的参考实现。

本项目还提供了一个完整的独立客户端，该客户端可以使用网页浏览器与Matrix家庭服务器进行通信。

Synapse 家庭服务器提供了这个库的最新稳定版本。如果您希望它提供开发副本，则必须配置此签出来由 synapse 获取

$ python setup.py develop --user

运行

要运行独立客户端，必须托管 syweb/webclient 文件夹。这可以通过以下方式轻松实现：

cd syweb/webclient
python -m SimpleHTTPServer

导航到 http://localhost:8000 以查看客户端。

错误/功能请求

认为您发现了一个错误？想在客户端中添加新功能？请请在JIRA上打开一个问题

• 创建账户并登录到 https://matrix.org/jira

• 导航到 SYWEB 项目。

• 点击 创建问题 - 请尽可能详细描述，如有必要，请提供重现步骤。

JIRA中的所有问题都是 公开的。

贡献

想要修复错误或添加新功能？首先检查JIRA，看看是否有人正在处理此问题。如果没有人在积极处理此问题，那么在编写修复程序时，请从 develop 分支进行分叉，并在准备好时打开拉取请求。请勿基于 master 进行拉取请求。

配置

可以通过在 syweb/webclient 目录中添加 config.js 文件来配置Web客户端。这包括设置ReCaptcha的配置。示例文件可以在 syweb/webclient/config.sample.js 中找到。

结构

包含SDK的 app 目录根据代码的逻辑范围分成子文件夹。包含许多地方使用的可复用组件的 components 目录。更具体的目录，如 home 和 settings，包含针对该应用程序特定部分的代码：例如，主屏幕和设置页面。

客户端-服务器API封装为名为 matrixService 的AngularJS服务。还有处理更复杂非HTTP客户端逻辑的互补服务，如 eventStreamService。

只要满足其依赖关系，就可以独立使用服务。

• matrixService 提供在最底层，因为它只是封装了原始HTTP调用。

• modelService 允许访问matrix对象的模型，如 User、Room、RoomState 和 RoomMember，并提供便利函数来对这些对象执行HTTP调用（例如，Room.leave）。

• eventHandlerService 解析原始Matrix事件并确定需要与 modelService 一起存储的内容。

• eventStreamService 控制在 /events HTTP调用上的长轮询行为。

• typingService 控制向房间提交输入事件。

• presenceService 控制提交存在事件。

或者，您可以使用不同的控制器和html模板，让服务像现在这样协同工作。

测试

测试包含在 test 目录 中。它们需要Karma（运行PhantomJS）和Jasmine 2.x+才能运行。假设您有必要的karma插件，您可以在测试目录中运行 karma start 来运行测试。

致谢

文件图标来自 http://medialoot.com/item/free-flat-filetype-icons/，并按照付费许可协议（发票号7355）分发。

键盘和GIF图标来自icons8： http://icons8.com/