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]