Global

Methods

ChatEngineCore(pnConfig, ceConfig) → {ChatEngine}

Source:

Global object used to create an instance of ChatEngine.

Example
ChatEngine = ChatEngineCore.create({
    publishKey: 'YOUR_PUB_KEY',
    subscribeKey: 'YOUR_SUB_KEY'
});
Parameters:
Name Type Description
pnConfig Object

ChatEngine is based off PubNub. Supply your PubNub configuration parameters here. See the getting started tutorial and the PubNub docs.
ceConfig Object

A list of ChatEngine specific configuration options.

Properties
Name Type Attributes Default Description
globalChannel String <optional>
 chat-engine

The root channel. See ChatEngine.global
enableSync Boolean <optional>

Synchronizes chats between instances with the same Me#uuid. See Me#sync.
enableMeta Boolean <optional>

Persists Chat#meta on the server. See Chat#update.
throwErrors Boolean <optional>
 true

Throws errors in JS console.
endpoint String <optional>
 'https://pubsub.pubnub.com/v1/blocks/sub-key/YOUR_SUB_KEY/chat-engine-server'

The root URL of the server used to manage permissions for private channels. Set by default to match the PubNub functions deployed to your account. See privacy for more.
debug Boolean <optional>

Logs all ChatEngine events to the console This should not be enabled in production.
profile Boolean <optional>

Sums event counts and outputs a table to the console every few seconds.
Returns:

Returns an instance of ChatEngine

Type
ChatEngine

Events

Chat#$.error.auth property {String} ceError The specific error thrown by ChatEngine

Source:

There was a problem searching the chat.