Home
Guides
Concepts
Installing
Initialization
Connect
Connect to ChatEngine
Set user state
Update user state
Users
Find a user
Get state for online users
Online and offline status
Chat rooms
Create a chat room
Invite a user to a private chat room
Show users in a chat room
Leave a chat room
Messages
Send messages
Receive messages
Send a direct message to a user
Retrieve past messages
Network events
Disconnect from ChatEngine
Reconnect To ChatEngine
Security
Encryption
Authorization
Advanced Concepts
Access Publish and Subscribe API
Advanced Security
Setup Third Party Authentication
AES Encryption Architecture
Authentication
Authentication Guide
Build a Plugin
Connect Deep Dive
Connect User to ChatEngine
Connect ChatEngine.Global
Connect ChatEngine.Me
Errors
Integrate with PubNub Functions
Integrate with Server SDKs
Namespaces
PubNub Channel Topology
Global Channel
Direct Channel
Feed Channel
Public Channel
Private Channel
Templating
Wildcards
Global
ChatEngineCore
Plugins
chat-engine-emoji
Chat
parseEmoji()
render()
search()
chat-engine-gravatar
User
state.gravatar
chat-engine-markdown
chat-engine-mute
Chat
muter.isMuted()
muter.mute()
muter.unmute()
chat-engine-online-user-search
Chat
search()
chat-engine-typing-indicator
Chat
typingindicator.startTyping()
typingindicator.stopTyping()
$typingIndiciator.stopTyping
chat-engine-unread-messages
Chat
unreadCount
unreadMessages.isActive
unreadMessages.unreadCount
unreadMessages.active()
unreadMessages.active()
$unread
chat-engine-uploadcare
Chat
uploadcare.bind()
$uploadcare.upload
Reference
Chat
asleep
channel
connected
hasConnected
isPrivate
meta
users
connect()
emit()
invite()
leave()
objectify()
off()
on()
onAny()
once()
plugin()
search()
update()
$.connected
$.error.chatLeave
$.error.chatMeta
$.error.getState
$.error.invite
$.error.notConnected
$.error.presence
$.error.publish
$.error.search
$.error.sync
$.offline.disconnect
$.offline.leave
$.online.here
$.online.join
ChatEngine
Chat
chats
global
me
pubnub
ready
User
users
connect()
disconnect()
off()
on()
onAny()
once()
proto()
reauthorize()
reconnect()
$.created.chat
$.created.me
$.created.user
$.network.down.badrequest
$.network.down.decryption
$.network.down.denied
$.network.down.issue
$.network.down.malformed
$.network.down.offline
$.network.down.timeout
$.network.up.connected
$.network.up.online
$.network.up.reconnected
$.ready
$.state
Emitter
off()
on()
onAny()
once()
plugin()
Event
channel
chat
event
name
off()
on()
onAny()
once()
plugin()
$.emitted
Me
direct
feed
session
state
uuid
off()
on()
onAny()
once()
plugin()
update()
$.invite
RootEmitter
off()
on()
onAny()
once()
Search
chat
config
hasMore
next()
off()
on()
onAny()
once()
plugin()
$.page.response
$.search.finish
$.search.pause
$.search.start
Session
chats
sync
off()
on()
onAny()
once()
plugin()
$.chat.join
$.chat.leave
$.group.restored
User
direct
feed
state
uuid
off()
on()
onAny()
once()
plugin()
Concepts
Installing
Initialization
Connect
Users
Chat rooms
Messages
Network events
Security
These concepts assume you've run through setup.