API

getTime(date): Returns the date's time in seconds.
main(): Runs the program, parsing any command line options first.
runBridge(source, project, options, command): Creates a new Bridge from the source, copying the source files to the given project and excluding them from repo commits and package publishing.
getDomain(url) ⇒ String: Returns the base domain from the given URL.
formatApiVersion(version) ⇒: Formats the given version number, e.g., "51.0".
getQueryPath(version) ⇒: Returns the query path, e.g., "services/data/v51.0/query".
getSalesforceObjectsPath(version) ⇒: Returns the Salesforce objects path, e.g., "services/data/v51.0/sobjects".
getServicesPath(version) ⇒: Returns the services path, e.g., "services/data/v44.0"

Typedefs

CommandConfig : Object

Command configuration

Message : Object

A message

Message : Object

A message

Command : Object

A command

IntentConfig : Object

Intent configuration

User : Object

User data.

Responses sent from the bot are not sent to a particular user, but to a Webex Teams space. In order to track events from the User's perspective, we need to internally track user data.

space : Object

Partial known space data.

Spaces : Map

Known spaces. Keys are of type Space.space_id. Properties are of type Space.

UserProp : Object

Map of user property names and formatting functions.

MinimalSpace : Object

The space with the message. This space has only one property: an ID.

ShouldTrack : Object

If and why an event should be tracked or not tracked

MinimalUser : Object

The user (person, bot) receiving a message. This user has a minimal number of properties.

UserInfo : Object

User information for an analytics event

CredentialBody : Object

A Google Auth CredentialBody

IntentConfig : Object

Intent configuration

PhoneNumber : Object

Person's phone number.

Person : Object

A typical bot user

People : Map

Known people.

Keys are of type Person.id. Properties are of type Person.

WebexPerson : Object

A Webex user

Properties beginning with an underscore denote those not normally in a Botkit Person object.

BridgeConfig : Object

Configuration options

Rollback : Object

Rollback information

AdaptiveCard : Object

Adaptive Card

Adaptive Card based on the Adaptive Card schema.

ChoicesConfig

Choice

CredentialBody : Object

Google Auth CredentialBody

ReleaseConfig : Object

Release configuration

SalesforceUser : Object

Salesforce user data.

AnalyticsEvent

Creates a new AnalyticsEvent.

Kind: global class

AnalyticsEvent
- new AnalyticsEvent(name, properties)
- .updateProperty(name, value)

new AnalyticsEvent(name, properties)

Param	Type	Description
name	`String`	Event name
properties	`Object`	Event properties

analyticsEvent.updateProperty(name, value)

Adds the given property and value to the event. Converts the property name to snake_case to adhere to best practices.

Kind: instance method of AnalyticsEvent

Param	Type	Description
name	`String`	Property name
value	`String`	Property value

Command

Creates a new base Command that handles a particular intent. Specific commands

Kind: global class

Command
- new Command(config)
- instance
  - .controller
  - .updateController(controller)
  - .defaultHandleText()
  - .defaultHandleAttachment()
  - .getIntent(message) ⇒ boolean
  - ._matchNamedIntent(intent) ⇒ Boolean
- static
  - .getPhraseExpression(phrases) ⇒ RegExp
  - .matchPhrase(message, phrase) ⇒ boolean

new Command(config)

Creates a new command. Listens to direct and group messages by default.

Param	Type	Description
config	`CommandConfig`	optional configuration

command.controller

See "Getters and Setters":

Kind: instance property of Command
See: https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Objects/Inheritance

command.updateController(controller)

Configures the controller to listen for the command phrases and attachment actions, e.g., Adaptive Card actions.

Kind: instance method of Command

Param	Type
controller	`Botkit`

command.defaultHandleText()

Handles text commands by default. Prints a debug statement.

Kind: instance method of Command

command.defaultHandleAttachment()

Handles attachments by default. Prints a debug statement.

Kind: instance method of Command

command.getIntent(message) ⇒ `boolean`

Returns the detected intent of the message. If there is no "official" intent attached, uses pattern-matching to determine the intent from the command's list of phrases.

Kind: instance method of Command
Returns: boolean - true if intent was detected, false if not
Emits: Intent#event:detected
See: https://botkit.ai/docs/v4/reference/core.html#hears

Param	Type
message	`Message`

command._matchNamedIntent(intent) ⇒ `Boolean`

Returns true if the intent name matches this intent, false otherwise.

Kind: instance method of Command
Returns: Boolean - true if the intent name matches this intent
See: https://stackoverflow.com/a/9436948/154065

Param	Type
intent	`String` \| `Object`

Command.getPhraseExpression(phrases) ⇒ `RegExp`

Joins the given phrases into a regular expression.

Kind: static method of Command
Returns: RegExp - joined phrases

Param	Type	Description
phrases	`Array`	The phrases to join

Command.matchPhrase(message, phrase) ⇒ `boolean`

Returns true if the user's message text matches the list of command phrases.

Kind: static method of Command
Returns: boolean - true if the user's message matches a known command

Param	Type	Description
message	`Message` \| `string`	the user's message or message text
phrase	`RegExp`	the phrase to match

Analytics

Middleware to track user events.

Properties sent to the analytics service are in snake_case, based on Segment naming conventions.

Some properties are encrypted or excluded, based on Webex Teams recommendations.

Users identified by Webex Teams' hashed ID
Org names/domain names are reported (not org ID)
Single event records do not include both sides of a communication

Kind: global class

Analytics
- new Analytics(apiKey, config)
- instance
  - .userProps
  - .trackUserMessage(bot, message, next)
  - .trackBotMessage(bot, message, next)
  - ._getAdditionalUserProps(user) ⇒ Object
  - ._getSpaceInfo(minimalSpace) ⇒ Object
  - ._getUserInfo(user) ⇒ UserInfo
  - ._getStandardInfo(timestamp) ⇒ Object
- static
  - .PROPERTY_VALUES

new Analytics(apiKey, config)

Param	Type	Description
apiKey	`String`	the analytics service API key
config	`Object`	configuration details
config.appEnvironment	`Object`	application environment, e.g., development, staging
config.appVersion	`Object`	application version
config.url	`String`	the analytics service URL
config.userProps	`Array.<(String\|UserProps)>`	the additional user properties to track

analytics.userProps

Sets additional user properties to pick from each incoming message.

Kind: instance property of Analytics

Param	Type	Description
props	`Map` \| `Array.<Array.<String>>`	user property names and friendly names

analytics.trackUserMessage(bot, message, next)

Tracks messages from the user to the bot.

Kind: instance method of Analytics
Note: Use with the middleware receive function.

Param	Type
bot	`*`
message	`*`
next	`*`

Example

const analyticsMiddleware = new Analytics();
 controller.middleware.receive.use(analyticsMiddleware.trackUserMessage);

analytics.trackBotMessage(bot, message, next)

Tracks messages from the bot to the user.

Kind: instance method of Analytics
Note: Use with the middleware send function.

Param	Type
bot	`*`
message	`*`
next	`*`

Example

const analyticsMiddleware = new Analytics();
 controller.middleware.send.use(analyticsMiddleware.trackBotMessage);

analytics._getAdditionalUserProps(user) ⇒ `Object`

Get the additional, desired user properties.

Kind: instance method of Analytics
Returns: Object - additional user properties

Param	Type	Description
user	`Object`	additional user info attached to the message

analytics._getSpaceInfo(minimalSpace) ⇒ `Object`

Gets more space information.

Kind: instance method of Analytics
Returns: Object - space with more details

Param	Type	Description
minimalSpace	`MinimalSpace`	space with the message

analytics._getUserInfo(user) ⇒ `UserInfo`

Gets the user properties for the analytics event.

Kind: instance method of Analytics
Returns: UserInfo - user information for an analytics event

Param	Type
user	`MinimalUser`

analytics._getStandardInfo(timestamp) ⇒ `Object`

Gets information standard to all analytics events.

Kind: instance method of Analytics
Returns: Object - app version and time

Param	Type	Description
timestamp	`number`	time in seconds

Analytics.PROPERTY_VALUES

Attach "static" property to the class.

Kind: static property of Analytics
See: https://stackoverflow.com/a/48012789/154065

Bridge

Kind: global class

Bridge
- new Bridge(source, project, config)
- instance
  - .source
  - .project
  - .copy() ⇒ String
  - .gitIgnore()
  - ._rollbackFile(original, backup) ⇒ Rollback
  - .publishIgnore()
- static
  - .isMonoRepo(project) ⇒ boolean
  - .copy() ⇒ String
  - .isDirectory(dir) ⇒ boolean

new Bridge(source, project, config)

Creates a new Bridge from the source to the destination project.

Param	Type	Description
source	`String`	the source directory
project	`String`	the destination project directory
config	`BridgeConfig`	configuration options

bridge.source

Sets the source directory.

Kind: instance property of Bridge
Throws:

DirectoryError

bridge.project

Sets the project directory.

Kind: instance property of Bridge
Throws:

DirectoryError
ProjectError

bridge.copy() ⇒ `String`

Copies files from the source directory to the project destination directory.

Kind: instance method of Bridge
Returns: String - the destination path where files were copied
Throws:

SourceIsDestError

bridge.gitIgnore()

Adds destination and backup file paths to .gitignore so the files are not committed to the project repo.

Kind: instance method of Bridge

bridge._rollbackFile(original, backup) ⇒ `Rollback`

Rolls back the file to the original copy.

Kind: instance method of Bridge
Returns: Rollback - rollback information
Throws:

RollbackError

Param	Type	Description
original	`*`	the original file path
backup	`*`	the backup file path

bridge.publishIgnore()

Adds destination file paths to the monorepo config. These files will be ignored when publishing packages.

Kind: instance method of Bridge

Bridge.isMonoRepo(project) ⇒ `boolean`

Returns true if the project is a valid monorepo, false otherwise.

Kind: static method of Bridge
Returns: boolean - true if the project is a valid monorepo, false otherwise

Param	Type	Description
project	`String`	the project directory

Bridge.copy() ⇒ `String`

Copies files from the source to the destination.

Kind: static method of Bridge
Returns: String - the destination path where files were copied

Bridge.isDirectory(dir) ⇒ `boolean`

Returns true if the given path is a directory, false otherwise.

Kind: static method of Bridge
Returns: boolean - true if the given path is a directory, false otherwise
See: https://stackoverflow.com/a/32749571/154065

Param	Type	Description
dir	`String`	the directory path

Input

Text input.

Kind: global class
See: https://shoelace.style/components/form

Auth

Kind: global class
See: https://www.npmjs.com/package/google-auth-library

Auth
- .getCredentials(credentials) ⇒ CredentialBody
- .parseCredentials(credentials) ⇒ CredentialBody

Auth.getCredentials(credentials) ⇒ `CredentialBody`

Gets the authorization credentials.

Kind: static method of Auth
Returns: CredentialBody - credentials

Param	Type	Description
credentials	`String`	file path or JSON string containing credentials

Auth.parseCredentials(credentials) ⇒ `CredentialBody`

Parses the given credentials.

Kind: static method of Auth
Returns: CredentialBody - credentials needed to authorize

Param	Type	Description
credentials	`String`	file path or JSON string containing credentials

DeploymentConfigError

Kind: global class

new DeploymentError(message)

Param	Type	Description
message	`String`	error message

SalesforceError

Kind: global class

new SalesforceError(message)

Param	Type	Description
message	`String`	error message

Salesforce

Kind: global class

new Salesforce(url, adapter)

Create instance of Salesforce controller

Param	Type	Description
url	`String`	Salesforce host address
adapter	`Object`	Salesforce adapter

UNKNOWN : `String`

Placeholder for unknown property value.

Kind: global constant

UNKNOWN_NUMBER : `number`

Placeholder for unknown number property value.

Kind: global constant

MESSAGE_SENT : `String`

Event name when a message is sent by the user.

Kind: global constant

MESSAGE_RECEIVED : `String`

Event name when a bot sends a message to the user and the user (presumably) receives it.

Kind: global constant

REGEX_NEVER_MATCH : `RegExp`

A regular expression that never matches anything.

Kind: global constant
See: https://2ality.com/2012/09/empty-regexp.html

ATTACHMENT_EVENT : `string`

Name of the event fired when a user engages with an attachment, e.g., an Adaptive Card.

Kind: global constant

INTENT_DETECTED_EVENT : `string`

Event name to emit when an intent is detected.

Kind: global constant

MESSAGE : `String`

Message sent to a bot in a group space.

Kind: global constant

DIRECT_MESSAGE : `String`

Message sent to a bot in a one-on-one space.

Kind: global constant

STANDARD_MESSAGE_TYPES : `Object`

Most common bot message types, e.g., "message", "direct_message". Most bots will want to listen for both group and direct messages.

Kind: global constant

INTENT_MATCHING_TYPES : `Object`

Ways that a message intent can be detected - with an official intent property, or through pattern-matching.

Kind: global constant

analyticsEvent

Analytics event.

Kind: global constant

searchOptions

Giphy search options

Kind: global constant
See: https://developers.giphy.com/docs/api/endpoint/

eventTemplate

Custom event and properties for analytics.

Kind: global constant

TEXT_LIMIT

Text limit to avoid DialogFlow error: INVALID_ARGUMENT: Input text exceeds 256 characters.

Kind: global constant

BASIC_PROPS : `Array.<String>`

A person must have all of these properties defined to be considered "data complete".

Kind: global constant

DRY_RUN

Perform a dry run.

Kind: global constant

IGNORE_TIMESTAMPS

Ignore timestamps to force overwriting similar destination files.

Kind: global constant

RSYNC_OPTIONS

Use these options for rysnc backup.

Kind: global constant

DEFAULT_CONFIG : `BridgeConfig`

Default configuration

Kind: global constant

GOOGLE_CLOUD_PROJECT

Kind: global constant
See: https://github.com/googleapis/google-auth-library-nodejs/blob/1ca3b733427d951ed624e1129fca510d84d5d0fe/src/auth/googleauth.ts#L646

DEFAULT_RELEASES_DIRECTORY : `String`

Release configuration directory.

Kind: global constant

DOCKER_COMPOSE_ORIG

"docker-compose build" command

"docker compose" and "docker-compose" are different. Use docker-compose to enable builds with ARGS.

Kind: global constant
See: https://stackoverflow.com/a/67853849/154065

KUBERNETES_DEPLOYMENT

Deployment kinds

Kind: global constant

SOQL_WILDCARD

Encoded wildcard character for SOQL queries.

Kind: global constant

SOQL_WILDCARD

Encoded wildcard character for SOQL queries.

Kind: global constant

getTime(date)

Returns the date's time in seconds.

Kind: global function

Param	Type	Description
date	`Date`	the date to convert

main()

Runs the program, parsing any command line options first.

Kind: global function

runBridge(source, project, options, command)

Creates a new Bridge from the source, copying the source files to the given project and excluding them from repo commits and package publishing.

Kind: global function
See: https://github.com/tj/commander.js#action-handler

Param	Type	Default	Description
source	`String`		the source directory
project	`String`	`.`	the destination project directory
options	`Object`		the program options from the command line
command	`Object`		the program command

getDomain(url) ⇒ `String`

Returns the base domain from the given URL.

Kind: global function
Returns: String - domain of the URL

Param	Type
url	`URL` \| `String`

formatApiVersion(version) ⇒

Formats the given version number, e.g., "51.0".

Kind: global function
Returns: formatted API version number

Param	Type	Description
version	`String` \| `number`	API version number

getQueryPath(version) ⇒

Returns the query path, e.g., "services/data/v51.0/query".

Kind: global function
Returns: the Salesforce query path

Param	Type	Description
version	`String`	formatted API version number

getSalesforceObjectsPath(version) ⇒

Returns the Salesforce objects path, e.g., "services/data/v51.0/sobjects".

Kind: global function
Returns: the Salesforce objects path

Param	Type	Description
version	`String`	formatted API version number

getServicesPath(version) ⇒

Returns the services path, e.g., "services/data/v44.0"

Kind: global function
Returns: the services path

Param	Type	Description
version	`String`	formatted API version number

CommandConfig : `Object`

Command configuration

Kind: global typedef
Properties

Name	Type	Description
intent	`String`	name of the intent
messageTypes	`Array.<string>`	Types of messages to listen for, e.g., a direct (1-on-1) message
phrases	`Array.<string>`	Phrases to listen for
handleText	`function`	Handles message text
handleAttachment	`function`	Handles message attachment actions, e.g., Adaptive Card clicks
friendlyName	`string`	Friendly name of the command

Message : `Object`

A message

Kind: global typedef
Properties

Name	Type	Description
_intent	`Object`	The detected user intent
text	`string`	The message text

Message : `Object`

A message

Kind: global typedef

Command : `Object`

A command

Kind: global typedef
Properties

Name	Type
friendlyName	`String`

Command : Object
- new Command(config)
- instance
  - .controller
  - .updateController(controller)
  - .defaultHandleText()
  - .defaultHandleAttachment()
  - .getIntent(message) ⇒ boolean
  - ._matchNamedIntent(intent) ⇒ Boolean
- static
  - .getPhraseExpression(phrases) ⇒ RegExp
  - .matchPhrase(message, phrase) ⇒ boolean

new Command(config)

Creates a new command. Listens to direct and group messages by default.

Param	Type	Description
config	`CommandConfig`	optional configuration

command.controller

See "Getters and Setters":

Kind: instance property of Command
See: https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Objects/Inheritance

command.updateController(controller)

Configures the controller to listen for the command phrases and attachment actions, e.g., Adaptive Card actions.

Kind: instance method of Command

Param	Type
controller	`Botkit`

command.defaultHandleText()

Handles text commands by default. Prints a debug statement.

Kind: instance method of Command

command.defaultHandleAttachment()

Handles attachments by default. Prints a debug statement.

Kind: instance method of Command

command.getIntent(message) ⇒ `boolean`

Returns the detected intent of the message. If there is no "official" intent attached, uses pattern-matching to determine the intent from the command's list of phrases.

Param	Type
message	`Message`

command._matchNamedIntent(intent) ⇒ `Boolean`

Returns true if the intent name matches this intent, false otherwise.

Kind: instance method of Command
Returns: Boolean - true if the intent name matches this intent
See: https://stackoverflow.com/a/9436948/154065

Param	Type
intent	`String` \| `Object`

Command.getPhraseExpression(phrases) ⇒ `RegExp`

Joins the given phrases into a regular expression.

Kind: static method of Command
Returns: RegExp - joined phrases

Param	Type	Description
phrases	`Array`	The phrases to join

Command.matchPhrase(message, phrase) ⇒ `boolean`

Returns true if the user's message text matches the list of command phrases.

Kind: static method of Command
Returns: boolean - true if the user's message matches a known command

Param	Type	Description
message	`Message` \| `string`	the user's message or message text
phrase	`RegExp`	the phrase to match

IntentConfig : `Object`

Intent configuration

Kind: global typedef
Properties

Name	Type	Description
projectId	`String`	the project ID
knowledgeBaseId	`String`	the knowledge base ID
credentials	`CredentialBody`	credentials needed to sign into the intent API

User : `Object`

User data.

Responses sent from the bot are not sent to a particular user, but to a Webex Teams space. In order to track events from the User's perspective, we need to internally track user data.

Kind: global typedef
Properties

Name	Type	Description
user_id	`String`	Encrypted user ID
domain	`String`	Domain of the user, e.g., cisco.com

space : `Object`

Partial known space data.

Kind: global typedef
Properties

Name	Type	Description
space_id	`String`	space ID
space_type	`String`	space type, e.g., "direct" or "group"

Spaces : `Map`

Known spaces. Keys are of type Space.space_id. Properties are of type Space.

Kind: global typedef

UserProp : `Object`

Map of user property names and formatting functions.

Kind: global typedef
Properties

Name	Type	Description
name	`String`	user property name
format	`function`	function to format the user property name

MinimalSpace : `Object`

The space with the message. This space has only one property: an ID.

Kind: global typedef

Param	Type	Description
id	`String`	ID of the space with the message

ShouldTrack : `Object`

If and why an event should be tracked or not tracked

Kind: global typedef
Properties

Name	Type	Description
shouldTrack	`boolean`	true if an event should be tracked, false otherwise
reason	`String`	reason an event is tracked or not tracked

MinimalUser : `Object`

The user (person, bot) receiving a message. This user has a minimal number of properties.

Kind: global typedef

Param	Type	Description
id	`String`	ID of the user receiving the message
name	`String`	email of the user receiving the message

UserInfo : `Object`

User information for an analytics event

Kind: global typedef
Properties

Name	Type	Description
user_id	`string`	user ID
user_properties	`Object`	user properties
user_properties.app_environment	`string`	the app environment, e.g., "development", "staging"
user_properties.domain	`string`	the domain of the user, e.g., "cisco.com"

CredentialBody : `Object`

A Google Auth CredentialBody

Kind: global typedef
See

Properties

Name	Type
client_email	`String`
private_key	`String`
project_id	`String`

IntentConfig : `Object`

Intent configuration

Kind: global typedef
Properties

Name	Type	Description
projectId	`String`	the project ID
knowledgeBaseId	`String`	the knowledge base ID
credentials	`CredentialBody`	credentials needed to sign into the intent API

PhoneNumber : `Object`

Person's phone number.

Kind: global typedef
Properties

Name	Type	Description
type	`String`	type of phone number, e.g., work, home
value	`String`	phone number itself, e.g., '+1 555 867 5309'

Person : `Object`

A typical bot user

Kind: global typedef
Properties

Name	Type	Description
id	`String`	Encrypted person ID
emails	`Array.<String>`	email addresses
phoneNumbers	`Array.<PhoneNumber>`	phone numbers
displayName	`String`	display name
nickName	`String`	nickname
firstName	`String`	first name
lastName	`String`	last name
avatar	`String`	URL of person's avatar at 1600px
orgId	`String`	encrypted organization ID
created	`Date`	date person was created in Webex Teams, e.g., 2014-06-20T20:35:16.172Z
type	`String`	type of user, e.g., "person"

People : `Map`

Known people.

Keys are of type Person.id. Properties are of type Person.

Kind: global typedef

WebexPerson : `Object`

A Webex user

Properties beginning with an underscore denote those not normally in a Botkit Person object.

Kind: global typedef
Properties

Name	Type	Description
_cecId	`String`	Cisco Employee Connection ID
_cecEmail	`String`	Cisco Employee Connection email, e.g., cecid@cisco.com
_contactType	`String`	type of contact, e.g., "Cisco" or "Partner"
_domain	`String`	domain name, e.g., cisco.com
_roles	`Array.<String>`	user's roles

BridgeConfig : `Object`

Configuration options

Kind: global typedef
Properties

Name	Type	Description
dryRun	`boolean`	perform a dry run

Rollback : `Object`

Rollback information

Kind: global typedef

Param	Type	Description
original	`String`	the original file path
backup	`String`	the backup file path

AdaptiveCard : `Object`

Adaptive Card

Adaptive Card based on the Adaptive Card schema.

Kind: global typedef

ChoicesConfig

Kind: global typedef

Param	Type	Description
getChoiceTitle	`function`	determine the title displayed on the UI
getChoiceValue	`function`	determine the value

Choice

Kind: global typedef

Param	Type	Description
choice	`String`	title of the choice as it appears in the UI
value	`String`	value of the choice "behind-the-scenes"

CredentialBody : `Object`

Google Auth CredentialBody

Kind: global typedef
See

Properties

Name	Type	Description
client_email	`String`
private_key	`String`
project_id	`String`	project ID (optional)

ReleaseConfig : `Object`

Release configuration

Kind: global typedef
Properties

Name	Type	Description
releasesDir	`String`	path to a releases directory

SalesforceUser : `Object`

Salesforce user data.

Kind: global typedef
Properties

Name	Type	Description
id	`String`	user ID
username	`String`	username
accessToken	`String`	user's API access token
organizationId	`String`	user's organization ID
url	`String`	full URL after signing in, e.g, https://SUBDOMAIN.my.salesforce.com/id/ORGANIZATION-ID/USER-ID

Classes
Constants
Functions
Typedefs
AnalyticsEvent
- new AnalyticsEvent(name, properties)
- analyticsEvent.updateProperty(name, value)
Command
- new Command(config)
- command.controller
- command.updateController(controller)
- command.defaultHandleText()
- command.defaultHandleAttachment()
- command.getIntent(message) ⇒ boolean
- command._matchNamedIntent(intent) ⇒ Boolean
- Command.getPhraseExpression(phrases) ⇒ RegExp
- Command.matchPhrase(message, phrase) ⇒ boolean
Analytics
- new Analytics(apiKey, config)
- analytics.userProps
- analytics.trackUserMessage(bot, message, next)
- analytics.trackBotMessage(bot, message, next)
- analytics._getAdditionalUserProps(user) ⇒ Object
- analytics._getSpaceInfo(minimalSpace) ⇒ Object
- analytics._getUserInfo(user) ⇒ UserInfo
- analytics._getStandardInfo(timestamp) ⇒ Object
- Analytics.PROPERTY_VALUES
Bridge
- new Bridge(source, project, config)
- bridge.source
- bridge.project
- bridge.copy() ⇒ String
- bridge.gitIgnore()
- bridge._rollbackFile(original, backup) ⇒ Rollback
- bridge.publishIgnore()
- Bridge.isMonoRepo(project) ⇒ boolean
- Bridge.copy() ⇒ String
- Bridge.isDirectory(dir) ⇒ boolean
Input
Auth
- Auth.getCredentials(credentials) ⇒ CredentialBody
- Auth.parseCredentials(credentials) ⇒ CredentialBody
DeploymentConfigError
- new DeploymentError(message)
SalesforceError
- new SalesforceError(message)
Salesforce
- new Salesforce(url, adapter)
UNKNOWN : String
UNKNOWN_NUMBER : number
MESSAGE_SENT : String
MESSAGE_RECEIVED : String
REGEX_NEVER_MATCH : RegExp
ATTACHMENT_EVENT : string
INTENT_DETECTED_EVENT : string
MESSAGE : String
DIRECT_MESSAGE : String
STANDARD_MESSAGE_TYPES : Object
INTENT_MATCHING_TYPES : Object
analyticsEvent
searchOptions
eventTemplate
TEXT_LIMIT
BASIC_PROPS : Array.<String>
ARCHIVE
DRY_RUN
IGNORE_TIMESTAMPS
RSYNC_OPTIONS
DEFAULT_CONFIG : BridgeConfig
GOOGLE_CLOUD_PROJECT
DEFAULT_RELEASES_DIRECTORY : String
DOCKER_COMPOSE_ORIG
KUBERNETES_DEPLOYMENT
SOQL_WILDCARD
SOQL_WILDCARD
getTime(date)
main()
runBridge(source, project, options, command)
getDomain(url) ⇒ String
formatApiVersion(version) ⇒
getQueryPath(version) ⇒
getSalesforceObjectsPath(version) ⇒
getServicesPath(version) ⇒
CommandConfig : Object
Message : Object
Message : Object
Command : Object
- new Command(config)
- command.controller
- command.updateController(controller)
- command.defaultHandleText()
- command.defaultHandleAttachment()
- command.getIntent(message) ⇒ boolean
- command._matchNamedIntent(intent) ⇒ Boolean
- Command.getPhraseExpression(phrases) ⇒ RegExp
- Command.matchPhrase(message, phrase) ⇒ boolean
IntentConfig : Object
User : Object
space : Object
Spaces : Map
UserProp : Object
MinimalSpace : Object
ShouldTrack : Object
MinimalUser : Object
UserInfo : Object
CredentialBody : Object
IntentConfig : Object
PhoneNumber : Object
Person : Object
People : Map
WebexPerson : Object
BridgeConfig : Object
Rollback : Object
AdaptiveCard : Object
ChoicesConfig
Choice
CredentialBody : Object
ReleaseConfig : Object
SalesforceUser : Object

Classes​

Constants​

Functions​

Typedefs​

AnalyticsEvent​

new AnalyticsEvent(name, properties)​

analyticsEvent.updateProperty(name, value)​

Command​

new Command(config)​

command.controller​

command.updateController(controller)​

command.defaultHandleText()​

command.defaultHandleAttachment()​

command.getIntent(message) ⇒ boolean​

command._matchNamedIntent(intent) ⇒ Boolean​

Command.getPhraseExpression(phrases) ⇒ RegExp​

Command.matchPhrase(message, phrase) ⇒ boolean​

Analytics​

new Analytics(apiKey, config)​

analytics.userProps​

analytics.trackUserMessage(bot, message, next)​

analytics.trackBotMessage(bot, message, next)​

analytics._getAdditionalUserProps(user) ⇒ Object​

analytics._getSpaceInfo(minimalSpace) ⇒ Object​

analytics._getUserInfo(user) ⇒ UserInfo​

analytics._getStandardInfo(timestamp) ⇒ Object​

Analytics.PROPERTY_VALUES​

Bridge​

new Bridge(source, project, config)​

bridge.source​

bridge.project​

bridge.copy() ⇒ String​

bridge.gitIgnore()​

bridge._rollbackFile(original, backup) ⇒ Rollback​

bridge.publishIgnore()​

Bridge.isMonoRepo(project) ⇒ boolean​

Bridge.copy() ⇒ String​

Bridge.isDirectory(dir) ⇒ boolean​

Input​

Auth​

Auth.getCredentials(credentials) ⇒ CredentialBody​

Auth.parseCredentials(credentials) ⇒ CredentialBody​

DeploymentConfigError​

new DeploymentError(message)​

SalesforceError​

new SalesforceError(message)​

Salesforce​

new Salesforce(url, adapter)​

UNKNOWN : String​

UNKNOWN_NUMBER : number​

MESSAGE_SENT : String​

MESSAGE_RECEIVED : String​

REGEX_NEVER_MATCH : RegExp​

ATTACHMENT_EVENT : string​

INTENT_DETECTED_EVENT : string​

MESSAGE : String​

DIRECT_MESSAGE : String​

STANDARD_MESSAGE_TYPES : Object​

INTENT_MATCHING_TYPES : Object​

analyticsEvent​

searchOptions​

eventTemplate​

TEXT_LIMIT​

BASIC_PROPS : Array.<String>​

ARCHIVE​

DRY_RUN​

IGNORE_TIMESTAMPS​

RSYNC_OPTIONS​

DEFAULT_CONFIG : BridgeConfig​

GOOGLE_CLOUD_PROJECT​

DEFAULT_RELEASES_DIRECTORY : String​

DOCKER_COMPOSE_ORIG​

KUBERNETES_DEPLOYMENT​

SOQL_WILDCARD​

SOQL_WILDCARD​

getTime(date)​

main()​

runBridge(source, project, options, command)​

getDomain(url) ⇒ String​

formatApiVersion(version) ⇒​

Classes

Constants

Functions

Typedefs

AnalyticsEvent

new AnalyticsEvent(name, properties)

analyticsEvent.updateProperty(name, value)

Command

new Command(config)

command.controller

command.updateController(controller)

command.defaultHandleText()

command.defaultHandleAttachment()

command.getIntent(message) ⇒ `boolean`

command._matchNamedIntent(intent) ⇒ `Boolean`

Command.getPhraseExpression(phrases) ⇒ `RegExp`

Command.matchPhrase(message, phrase) ⇒ `boolean`

Analytics

new Analytics(apiKey, config)

analytics.userProps

analytics.trackUserMessage(bot, message, next)

analytics.trackBotMessage(bot, message, next)

analytics._getAdditionalUserProps(user) ⇒ `Object`

analytics._getSpaceInfo(minimalSpace) ⇒ `Object`

analytics._getUserInfo(user) ⇒ `UserInfo`

analytics._getStandardInfo(timestamp) ⇒ `Object`

Analytics.PROPERTY_VALUES

Bridge

new Bridge(source, project, config)

bridge.source

bridge.project

bridge.copy() ⇒ `String`

bridge.gitIgnore()

bridge._rollbackFile(original, backup) ⇒ `Rollback`

bridge.publishIgnore()

Bridge.isMonoRepo(project) ⇒ `boolean`

Bridge.copy() ⇒ `String`

Bridge.isDirectory(dir) ⇒ `boolean`

Input

Auth

Auth.getCredentials(credentials) ⇒ `CredentialBody`

Auth.parseCredentials(credentials) ⇒ `CredentialBody`

DeploymentConfigError

new DeploymentError(message)

SalesforceError

new SalesforceError(message)

Salesforce

new Salesforce(url, adapter)

UNKNOWN : `String`

UNKNOWN_NUMBER : `number`

MESSAGE_SENT : `String`

MESSAGE_RECEIVED : `String`

REGEX_NEVER_MATCH : `RegExp`

ATTACHMENT_EVENT : `string`

INTENT_DETECTED_EVENT : `string`

MESSAGE : `String`

DIRECT_MESSAGE : `String`

STANDARD_MESSAGE_TYPES : `Object`

INTENT_MATCHING_TYPES : `Object`

analyticsEvent

searchOptions

eventTemplate

TEXT_LIMIT

BASIC_PROPS : `Array.<String>`

ARCHIVE

DRY_RUN

IGNORE_TIMESTAMPS

RSYNC_OPTIONS

DEFAULT_CONFIG : `BridgeConfig`

GOOGLE_CLOUD_PROJECT

DEFAULT_RELEASES_DIRECTORY : `String`

DOCKER_COMPOSE_ORIG

KUBERNETES_DEPLOYMENT

SOQL_WILDCARD

SOQL_WILDCARD

getTime(date)

main()

runBridge(source, project, options, command)

getDomain(url) ⇒ `String`

formatApiVersion(version) ⇒