chat engine

折旧通知

Chatengine已被弃用，没有其他发布的计划。支持Chatengine SDK的支持将于2021年7月16日结束。如果您对Chatengine有疑问，请通过[email protected]与我们联系。请访问我们的新聊天产品PubNub聊天。

PubNub Chatengine框架

PubNub ChatEngine是一个基于面向对象的事件发射极的框架，用于在JavaScript中构建聊天应用程序。它减少了大幅度构建聊天应用程序的时间，并提供了基本组件，例如打字指标，在线影响监视和消息历史记录开箱即用。

实时服务器组件由PubNub提供。 ChatEngine设计为可扩展，并包含一个插件框架，以使添加新功能变得简单。

有关与PubNub构建聊天应用程序的更多信息，请参阅我们的聊天资源中心。

文档

您可以在文档网站上找到完整的文档。

入门

先决条件

• nodejs
• Twitter引导程序
• jQuery
• ES6

设置的PubNub帐户

要在PubNub上设置ChatEngine，必须首先设置PubNub密钥。以下步骤概述了如何手动设置PubNub密钥与Chatengine客户端SDK一起使用。

注册PubNub帐户

如果您还没有帐户，则可以在此处免费创建一个帐户。

使用PubNub功能设置REST API服务

ChatEngine框架和客户端SDK与作为PubNub功能运行的REST API服务进行交互。

您需要在PubNub帐户上设置该功能，然后才能使用SDK。

按照Chatengine服务器设置说明。

下载代码

创建一个新的NPM项目

由于我们将安装依赖项，因此创建一个新的package.json很有帮助。JSON跟踪我们要安装的所有软件包。

在您的项目目录中，运行此命令以创建一个新软件包。填写交互式设置指南，我们将准备就绪。

 npm init

这将在您的项目目录中创建一个package.json 。

{
  "name" : " chat-engine-tutorial " ,
  "version" : " 0.0.1 " ,
  "description" : " An example PubNub ChatEngine Tutorial " ,
  "main" : " index.js " ,
  "author" : " Ian Jennings "
}

安装PubNub Chatengine

好吧，现在您可能从未做过的部分！通过运行安装PubNub ChatEngine：

npm install chat-engine@latest --save

其他资源

插件

查看jQuery厨房水槽和角厨房水槽示例，以查看插件的作用。

• 图像上传 - 使用上载服务上传图像并在聊天中渲染它们。例子。
• 降低支持 - 接收消息时在HTML中渲染降压。例子。
• 静音用户 - 允许当前用户停止从其他用户接收事件。例子。
• 在线用户搜索 - 一种简单的方法，可以在聊天中在线搜索用户列表。例子。
• 键入指示器 - 提供方便方法，当用户启动或停止键入时开火。例子
• 未阅读的消息 - 允许您将聊天标记为在后台，并在将事件发送到它时会增加计数器。例子。
• 桌面通知 - 使用HTML5通知API发送“烤面包机”更新。
• 表情符号支持 - 使用图像作为可能尚不支持的设备的后备？
• 事件状态和读取收据 - 当有人读取接收和/或读取消息时，会发出其他事件。
• Gravatar支持 - 使用GraftAt服务来创建基于用户状态信息的头像。
• 随机用户名 - 一个插件，可为每个用户提供一个随机用户名，结合颜色和动物。

视频

• Chatengine简介
• 5分钟Chatengine教程
• 在30行代码网络研讨会中聊天

教程

JavaScript

• 入门教程。
• 聊天 - 非常简单的聊天示例。 Chatengine的“ Hello World”。
• 在线列表 - 没有聊天，只是在线渲染。请参阅厨房水槽，以了解如何将其与私人聊天相结合。

反应本地 +移动

• 反应本机示例 - 用create-react-app制成。
• React Native组件 - 渲染聊天，消息，用户等的预制组件。
• 集成到现有的iOS应用程序中 - 将Chatengine React Antive应用程序添加到iOS中的指南。
• 集成到现有的Android应用程序中 - 在Android中添加Chatengine React Antive应用的指南。

反应

• 反应 - 裸骨反应网络示例。

Vue

• VUE指南 - 有关使用Chatengine和Vue的指南。使用以下资源。
• VUE示例 - 完整的Chatengine Vue示例。
• VUE插件 - VUE的Chatengine插件。

角

• Angular Simple-角“ Hello World”应用。简单的应用程序使用自定义的Angular插件在任何更新时呈现。
• Angular Kitchen水槽 - 那里最大的演示应用程序，几乎是一个完整的桌面团队聊天克隆（Slack，Stride，Flowdock）。持续的URL并渲染到带有电子的真实桌面应用程序中！

jQuery

• JQuery Simple -jQuery ChatEngine“ Hello World”应用程序。一个简单的应用程序，每个人都一起聊天。
• jQuery厨房水槽 - 使用大多数Chatengine功能的大型例子。单击用户名时，有一个在线列表，可以产生新的聊天。

第三方身份验证

• Facebook登录 - 与Chatengine一起使用Facebook配置文件。

Nodejs + ChatBot

• nodejs chatbot-示例机器人响应消息并模拟键入。默认情况下，使用jQuery厨房水槽示例。

发展

克隆

克隆仓库（Chat-Engine和插件）。

所有存储库都应该是彼此的兄弟姐妹。正确渲染文档是必需的。

 chat-engine
chat-engine-desktop-notifications
chat-engine-emoji
chat-engine-examples
//...

设置环境

 nvm use v6

从我的/development目录中运行http-server该目录都有所有聊天引擎存储库：

cd chat-engine

node server.js

加载http：// localhost：8080在浏览器中，导航到/chat-engine-escamples/jquery/厨房链接

编译

运行gulp进行编译，但您可能应该运行gulp watch以进行一致的更改。

运行测试

您需要将环境变量PUB_KEY_0和SUB_KEY_0分配给您自己的pubNub键。将这些变量添加到您的.bashrc或.zshrc中。

 # pubnub chatengine keys
export PUB_KEY_0= " YOUR PUBNUB PUBLISH KEY "
export SUB_KEY_0= " YOUR PUBNUB SUBSCRIBE KEY "

然后，在根文件夹中运行：

 gulp test

释放补丁（聊天引擎和插件）

 npm version patch && git push origin master --tags

支持

• 如果您需要帮助，请提出一般性问题或提交错误，请联系[email protected]