chat-engine-unread-messages
v0.0.9
Published
Adds the ability to count unread messages in a ChatEngine Chat
Downloads
14
Maintainers
Keywords
Readme
Unread Messages Plugin
Adds the ability to count unread messages in a ChatEngine Chat
Quick Start
- Have ChatEngine instantiated and connected, and have a channel you want to count unread messages on
const ChatEngine = ChatEngineCore.create({
publishKey: 'pub-key-here',
subscribeKey: 'sub-key-here',
});
ChatEngine.connect('Username');
ChatEngine.on('$.ready', () => { ... });
- Attach this plugin to the channel you want, in this case global
ChatEngine.global.plugin(ChatEngineCore.plugin['chat-engine-unread-messages']());
- The plugin needs to be notified when the user is considered active or inactive to properly count messages
// sets unreadCount to 0, stops counting unread messages and stops emitting events
ChatEngine.global.unreadMessages.active();
// starts counting unread messages and starts emitting events - default state
ChatEngine.global.unreadMessages.inactive();
- Listen for the
$unread
events that emit whenever your channel recieves a message while it is marked as inactive
ChatEngine.global.on('$unread', () => {
console.log(ChatEngine.global.unreadCount);
});
Support
- If you need help, have a general question a feature request or to file a bug, contact [email protected]