Circuit JavaScript SDK

API Docs for version 1.3.1808

NodeSDK

Module: Circuit

Summary

Object defining Node.js SDK specific options.

Methods

removeMentionHtml

Syntax

removeMentionHtml

(
  • content
)
String

Summary

Span element for mention is removed and only the mentioned user's name is shown.

Parameters:

  • content String

    Mention text with the span element.

Returns:

String:

Returns the mention without the Html.

Example:

const mention = Circuit.Utils.removeMentionHtml('<span class="mention" abbr="0e372ae0-2dff-4439-8f87-1b8a6562f80e">@Roger</span>');

Properties

Active - Client is active

Syntax

Active - Client is active

Unknown

Summary

Client Idle state

EMOTICON_MAPPING

Syntax

EMOTICON_MAPPING

Enum final static

Summary

Emoticon mapping used when Circuit.Client is configured with emoticonMode standard. Can be enhanced or overwritten if needed.

proxyAgent

Syntax

proxyAgent

Object

Summary

HttpsProxyAgent object as defined in https://www.npmjs.com/package/https-proxy-agent. Agent will be used on HTTP(S) request and WebSocket connection within Node SDK. Only applicable to Node.js SDK.

Example:

 // export http_proxy=http://172.20.1.100:8080
                     var HttpsProxyAgent = require('https-proxy-agent');
                     NodeSDK.proxyAgent = new HttpsProxyAgent(url.parse(process.env.http_proxy));

rejectUnauthorized

Syntax

rejectUnauthorized

Boolean

Summary

If true, the server certificate is verified against the list of supplied CAs. An error event is emitted if verification fails; err.code contains the OpenSSL error code. Default: false. Only applicable to Node.js SDK.

Example:

NodeSDK.rejectUnauthorized = true;