pubnub / chat-engine-online-user-search

Search through list of online users using string matching.

Home Page:https://www.pubnub.com/developers/chat-resource-center/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

This repository is a part of the ChatEngine Framework. For more information on building chat applications with PubNub, see our Chat Resource Center.

Online User Search Plugin for ChatEngine

Adds the ability to search for currently online users on a ChatEngine Chat

Quick Start

  1. Have a ChatEngine server running already, instantiate a client and connect it
const ChatEngine = ChatEngineCore.create({
    publishKey: 'pub-key-here',
    subscribeKey: 'sub-key-here'
};

ChatEngine.connect('Username');
ChatEngine.on('$ready', () = { ... });
  1. Attach this plugin to the channel you want, in this case global
ChatEngine.global.plugin(ChatEngineCore.plugin['chat-engine-online-user-search']());
  1. Query the channel for a search term
// returns all users with uuid's containing 'foo'
ChatEngine.global.onlineUserSearch.search('foo');

Support

  • If you need help, have a general question, have a feature request or to file a bug, contact support@pubnub.com.

About

Search through list of online users using string matching.

https://www.pubnub.com/developers/chat-resource-center/

License:Other


Languages

Language:JavaScript 70.7%Language:HTML 29.3%