BBCore.combined.md

Classes

BBCore

contacts

videoOptions

Objects

BBCore : object

Functions

responseSuccess(responseObject, jqXHR)

reponseSuccess

Typedefs

responseSuccess : Object

responseObject : Object

OAuthClientCredentials : Object

responseSuccess : function

This callback is displayed as a global member.

requestParameters : object

customVideoEmailOptions : object

responseSuccess : function

This callback is displayed as a global member.

contactProperties : Object

videoProperties : object

BBCore

Kind: global class

• BBCore
  • instance
    • .resumeStoredSession
    • .getServerUrl() ⇒ BBCore.apiServer | * | BBCore.CONFIG.SERVER_API_URL
    • .getRequestUrl() ⇒ string
    • .sendRequest(method, [params], [success], [error])
    • .login(uid, pwd, success)
    • .credentialsSaved() ⇒ boolean
    • .saveCredentials(uid, pwd)
    • .validateSession(onSuccess, onError)
    • .validateAccessToken(onSuccess)
    • .isAccessToken()
    • .isAuthenticated() ⇒ boolean | *
    • .invalidateSession() ⇒ boolean | *
    • .verifyKey(key, complete)
    • .storeKey(key)
    • .verifyJsonWebToken(key, complete)
    • .storeOAuthTokens(key)
    • .getOAuthPayload() ⇒ string
    • .validateOAuthCode(authCode, onSuccess, onError)
    • .refreshOAuthToken()
    • .storeJsonWebToken(key)
    • .getValidJsonWebTokenAsync(callback)
    • .getLists(success)
    • .createList(listName, success)
    • .getContact(contactId, success)
    • .getListContacts(listId, success)
    • .addContact(contact, success)
    • .bulkAddContacts(opts, success)
    • .updateContact(opts, success)
    • .getImportAddressesByType(opts, success)
    • .addContactImportAddress(opts, success)
    • .getEmails(success)
    • .sendCustomVideoEmail(opts, success)
    • .getDrips(opts, success)
    • .getForms(opts, success)
    • .getClientIntegrations(opts, success)
    • .deleteVideo(videoId, success)
    • .videoQuickSend(opts, onSuccess)
    • .getEmbeddedRecorderUrl([options], onComplete)
    • .getVideoRecorder(opts, onComplete)
    • .saveRecordedVideo(title, videoId, videoFilename, success)
    • .saveRecording(options)
  • static
    • .video
      • new video(properties)
    • .contact
      • new contact(properties)
    • .video
      • new video(properties)
    • .CONFIG : Object

bbCore.resumeStoredSession

DEPRECATED - Use validateSession

Kind: instance property of BBCore

bbCore.getServerUrl() ⇒ BBCore.apiServer | * | BBCore.CONFIG.SERVER_API_URL

Kind: instance method of BBCore

bbCore.getRequestUrl() ⇒ string

Returns the fully qualified URL for BB API

Kind: instance method of BBCore

bbCore.sendRequest(method, [params], [success], [error])

Sends a request to the specified method of the BombBomb API

Kind: instance method of BBCore

Param	Type	Description
method	string	The method name to call
[params]	requestParameters	The parameters to send with the request
[success]	responseSuccess	A callback when the request succeeds
[error]	responseSuccess	A callback when the request fails

bbCore.login(uid, pwd, success)

Authenticates a user using their Email Address (User Id) and Password

Kind: instance method of BBCore

Param	Type
uid	string
pwd	string
success	responseSuccess

bbCore.credentialsSaved() ⇒ boolean

Returns bool for whether or not a prior authentication is stored locally

Kind: instance method of BBCore

bbCore.saveCredentials(uid, pwd)

Save credentials to local storage (not recommended)

Kind: instance method of BBCore

Param	Type	Description
uid	string	User ID/Email Address
pwd	string	Password

bbCore.validateSession(onSuccess, onError)

Authenticates from previously stored credentials

Kind: instance method of BBCore

Param	Type
onSuccess	responseSuccess
onError	responseSuccess

bbCore.validateAccessToken(onSuccess)

Kind: instance method of BBCore

Param
onSuccess

bbCore.isAccessToken()

Detects if accessToken provided is an api_key or an accessToken

Kind: instance method of BBCore

bbCore.isAuthenticated() ⇒ boolean | *

Returns bool for authentication state

Kind: instance method of BBCore

bbCore.invalidateSession() ⇒ boolean | *

Invalidates and clears the active session, similar to logout

Kind: instance method of BBCore

bbCore.verifyKey(key, complete)

Validates the given key

Kind: instance method of BBCore

Param	Type
key	string
complete	responseSuccess

bbCore.storeKey(key)

Stores the give session key, typically used so a session can be resumed later on.

Kind: instance method of BBCore

Param
key

bbCore.verifyJsonWebToken(key, complete)

Validates the given key

Kind: instance method of BBCore

Param	Type
key	string
complete	responseSuccess

bbCore.storeOAuthTokens(key)

Stores the OAuth Token for API calls

Kind: instance method of BBCore

Param
key

bbCore.getOAuthPayload() ⇒ string

Kind: instance method of BBCore

bbCore.validateOAuthCode(authCode, onSuccess, onError)

Kind: instance method of BBCore

Param
authCode
onSuccess
onError

bbCore.refreshOAuthToken()

Kind: instance method of BBCore

bbCore.storeJsonWebToken(key)

Stores the give session key, typically used so a session can be resumed later on.

Kind: instance method of BBCore

Param
key

bbCore.getValidJsonWebTokenAsync(callback)

Attempts to always return a valid JWT which makes an async verification request

Kind: instance method of BBCore

Param	Description
callback	handler given a valid JWT. If the JWT is null then the user is NOT authenticated.

bbCore.getLists(success)

Retrieves Contact Lists

Kind: instance method of BBCore

Param	Type
success	responseSuccess

bbCore.createList(listName, success)

Creates a Contact List and returns the Guid

Kind: instance method of BBCore

Param	Type
listName	string
success	responseSuccess

bbCore.getContact(contactId, success)

Retrieves a Contact

Kind: instance method of BBCore

Param	Type
contactId	string
success	responseSuccess

bbCore.getListContacts(listId, success)

Retrieves Contacts from a Contact List

Kind: instance method of BBCore

Param	Type
listId	string
success	responseSuccess

bbCore.addContact(contact, success)

Adds a Contact to a Contact List

Kind: instance method of BBCore

Param	Type
contact	contact
success	responseSuccess

bbCore.bulkAddContacts(opts, success)

Adds a batch of Contacts

Kind: instance method of BBCore

Param	Type
opts	object
success	responseSuccess

bbCore.updateContact(opts, success)

Kind: instance method of BBCore

Param	Type
opts	object
success	responseSuccess

bbCore.getImportAddressesByType(opts, success)

Retrieves an Import Address by a Type

Kind: instance method of BBCore

Param	Type
opts
success	responseSuccess

bbCore.addContactImportAddress(opts, success)

Retrieves an Import Address by a Type

Kind: instance method of BBCore

Param	Type
opts	object
success	responseSuccess

bbCore.getEmails(success)

Retrieves a list of Emails from the current authenticated session

Kind: instance method of BBCore

Param	Type
success	responseSuccess

bbCore.sendCustomVideoEmail(opts, success)

Kind: instance method of BBCore

Param	Type
opts	customVideoEmailOptions
success	function

bbCore.getDrips(opts, success)

Kind: instance method of BBCore

Param	Type
opts	object
success	responseSuccess

bbCore.getForms(opts, success)

Kind: instance method of BBCore

Param	Type
opts	object
success	responseSuccess

bbCore.getClientIntegrations(opts, success)

Kind: instance method of BBCore

Param
opts
success

bbCore.deleteVideo(videoId, success)

Deletes a Video

Kind: instance method of BBCore

Param	Type
videoId	string
success	responseSuccess

bbCore.videoQuickSend(opts, onSuccess)

Kind: instance method of BBCore

Param	Type
opts	object
onSuccess	responseSuccess

bbCore.getEmbeddedRecorderUrl([options], onComplete)

Kind: instance method of BBCore

Param	Type
[options]	Object
onComplete	function

bbCore.getVideoRecorder(opts, onComplete)

Kind: instance method of BBCore

Param	Type
opts	object
onComplete	function

bbCore.saveRecordedVideo(title, videoId, videoFilename, success)

Kind: instance method of BBCore

Param	Type
title	string
videoId	string
videoFilename	string
success	function

bbCore.saveRecording(options)

Kind: instance method of BBCore

Param	Type
options	Object

BBCore.video

{Object} BBCore.videos

Kind: static class of BBCore

new video(properties)

Param	Type
properties	videoProperties

BBCore.contact

stuff

Kind: static class of BBCore
Properties

Name	Type	Description
email	string	Email Address
firstname	string	First Name
lastname	string	Last Name
phone_number	string	Phone Number
address_line_1	string	Address 1
address_line_2	string	Address 2
city	string	City
state	string	State
country	string	Country`
postal_code	string	Postal Code
company	string	Company
position	string	Position
comments	string	Comments
listlist	string	Array of List Ids the Contact is subscribed to
id	string	Contact Id

new contact(properties)

Contact Object

Param	Type	Description
properties	contactProperties	contactProperties

BBCore.video

BBCore.video

Kind: static class of BBCore
Properties

Name	Type
vid_id	string
title	string
filename	string

new video(properties)

Param	Type
properties	videoProperties

BBCore.CONFIG : Object

Kind: static constant of BBCore
Properties

Name
VERSION
API_END_POINT
SERVER_API_URL

contacts

Kind: global class

• contacts
  • .add(contact) ⇒ contacts
  • .find(fieldName, value) ⇒ * | contact

contacts.add(contact) ⇒ contacts

Adds a Contact contact to Contacts collection

Kind: instance method of contacts

Param	Type
contact	contact

contacts.find(fieldName, value) ⇒ * | contact

Returns the first matched contact from

Kind: instance method of contacts

Param	Type	Description
fieldName	string	Name of the field to search for the value
value	string	Value to search for in the contacts

videoOptions

Kind: global class
Properties

Name	Type
vid_id	string

BBCore : object

Kind: global namespace

• BBCore : object
  • instance
    • .resumeStoredSession
    • .getServerUrl() ⇒ BBCore.apiServer | * | BBCore.CONFIG.SERVER_API_URL
    • .getRequestUrl() ⇒ string
    • .sendRequest(method, [params], [success], [error])
    • .login(uid, pwd, success)
    • .credentialsSaved() ⇒ boolean
    • .saveCredentials(uid, pwd)
    • .validateSession(onSuccess, onError)
    • .validateAccessToken(onSuccess)
    • .isAccessToken()
    • .isAuthenticated() ⇒ boolean | *
    • .invalidateSession() ⇒ boolean | *
    • .verifyKey(key, complete)
    • .storeKey(key)
    • .verifyJsonWebToken(key, complete)
    • .storeOAuthTokens(key)
    • .getOAuthPayload() ⇒ string
    • .validateOAuthCode(authCode, onSuccess, onError)
    • .refreshOAuthToken()
    • .storeJsonWebToken(key)
    • .getValidJsonWebTokenAsync(callback)
    • .getLists(success)
    • .createList(listName, success)
    • .getContact(contactId, success)
    • .getListContacts(listId, success)
    • .addContact(contact, success)
    • .bulkAddContacts(opts, success)
    • .updateContact(opts, success)
    • .getImportAddressesByType(opts, success)
    • .addContactImportAddress(opts, success)
    • .getEmails(success)
    • .sendCustomVideoEmail(opts, success)
    • .getDrips(opts, success)
    • .getForms(opts, success)
    • .getClientIntegrations(opts, success)
    • .deleteVideo(videoId, success)
    • .videoQuickSend(opts, onSuccess)
    • .getEmbeddedRecorderUrl([options], onComplete)
    • .getVideoRecorder(opts, onComplete)
    • .saveRecordedVideo(title, videoId, videoFilename, success)
    • .saveRecording(options)
  • static
    • .video
      • new video(properties)
    • .contact
      • new contact(properties)
    • .video
      • new video(properties)
    • .CONFIG : Object

bbCore.resumeStoredSession

DEPRECATED - Use validateSession

Kind: instance property of BBCore

bbCore.getServerUrl() ⇒ BBCore.apiServer | * | BBCore.CONFIG.SERVER_API_URL

Kind: instance method of BBCore

bbCore.getRequestUrl() ⇒ string

Returns the fully qualified URL for BB API

Kind: instance method of BBCore

bbCore.sendRequest(method, [params], [success], [error])

Sends a request to the specified method of the BombBomb API

Kind: instance method of BBCore

Param	Type	Description
method	string	The method name to call
[params]	requestParameters	The parameters to send with the request
[success]	responseSuccess	A callback when the request succeeds
[error]	responseSuccess	A callback when the request fails

bbCore.login(uid, pwd, success)

Authenticates a user using their Email Address (User Id) and Password

Kind: instance method of BBCore

Param	Type
uid	string
pwd	string
success	responseSuccess

bbCore.credentialsSaved() ⇒ boolean

Returns bool for whether or not a prior authentication is stored locally

Kind: instance method of BBCore

bbCore.saveCredentials(uid, pwd)

Save credentials to local storage (not recommended)

Kind: instance method of BBCore

Param	Type	Description
uid	string	User ID/Email Address
pwd	string	Password

bbCore.validateSession(onSuccess, onError)

Authenticates from previously stored credentials

Kind: instance method of BBCore

Param	Type
onSuccess	responseSuccess
onError	responseSuccess

bbCore.validateAccessToken(onSuccess)

Kind: instance method of BBCore

Param
onSuccess

bbCore.isAccessToken()

Detects if accessToken provided is an api_key or an accessToken

Kind: instance method of BBCore

bbCore.isAuthenticated() ⇒ boolean | *

Returns bool for authentication state

Kind: instance method of BBCore

bbCore.invalidateSession() ⇒ boolean | *

Invalidates and clears the active session, similar to logout

Kind: instance method of BBCore

bbCore.verifyKey(key, complete)

Validates the given key

Kind: instance method of BBCore

Param	Type
key	string
complete	responseSuccess

bbCore.storeKey(key)

Stores the give session key, typically used so a session can be resumed later on.

Kind: instance method of BBCore

Param
key

bbCore.verifyJsonWebToken(key, complete)

Validates the given key

Kind: instance method of BBCore

Param	Type
key	string
complete	responseSuccess

bbCore.storeOAuthTokens(key)

Stores the OAuth Token for API calls

Kind: instance method of BBCore

Param
key

bbCore.getOAuthPayload() ⇒ string

Kind: instance method of BBCore

bbCore.validateOAuthCode(authCode, onSuccess, onError)

Kind: instance method of BBCore

Param
authCode
onSuccess
onError

bbCore.refreshOAuthToken()

Kind: instance method of BBCore

bbCore.storeJsonWebToken(key)

Stores the give session key, typically used so a session can be resumed later on.

Kind: instance method of BBCore

Param
key

bbCore.getValidJsonWebTokenAsync(callback)

Attempts to always return a valid JWT which makes an async verification request

Kind: instance method of BBCore

Param	Description
callback	handler given a valid JWT. If the JWT is null then the user is NOT authenticated.

bbCore.getLists(success)

Retrieves Contact Lists

Kind: instance method of BBCore

Param	Type
success	responseSuccess

bbCore.createList(listName, success)

Creates a Contact List and returns the Guid

Kind: instance method of BBCore

Param	Type
listName	string
success	responseSuccess

bbCore.getContact(contactId, success)

Retrieves a Contact

Kind: instance method of BBCore

Param	Type
contactId	string
success	responseSuccess

bbCore.getListContacts(listId, success)

Retrieves Contacts from a Contact List

Kind: instance method of BBCore

Param	Type
listId	string
success	responseSuccess

bbCore.addContact(contact, success)

Adds a Contact to a Contact List

Kind: instance method of BBCore

Param	Type
contact	contact
success	responseSuccess

bbCore.bulkAddContacts(opts, success)

Adds a batch of Contacts

Kind: instance method of BBCore

Param	Type
opts	object
success	responseSuccess

bbCore.updateContact(opts, success)

Kind: instance method of BBCore

Param	Type
opts	object
success	responseSuccess

bbCore.getImportAddressesByType(opts, success)

Retrieves an Import Address by a Type

Kind: instance method of BBCore

Param	Type
opts
success	responseSuccess

bbCore.addContactImportAddress(opts, success)

Retrieves an Import Address by a Type

Kind: instance method of BBCore

Param	Type
opts	object
success	responseSuccess

bbCore.getEmails(success)

Retrieves a list of Emails from the current authenticated session

Kind: instance method of BBCore

Param	Type
success	responseSuccess

bbCore.sendCustomVideoEmail(opts, success)

Kind: instance method of BBCore

Param	Type
opts	customVideoEmailOptions
success	function

bbCore.getDrips(opts, success)

Kind: instance method of BBCore

Param	Type
opts	object
success	responseSuccess

bbCore.getForms(opts, success)

Kind: instance method of BBCore

Param	Type
opts	object
success	responseSuccess

bbCore.getClientIntegrations(opts, success)

Kind: instance method of BBCore

Param
opts
success

bbCore.deleteVideo(videoId, success)

Deletes a Video

Kind: instance method of BBCore

Param	Type
videoId	string
success	responseSuccess

bbCore.videoQuickSend(opts, onSuccess)

Kind: instance method of BBCore

Param	Type
opts	object
onSuccess	responseSuccess

bbCore.getEmbeddedRecorderUrl([options], onComplete)

Kind: instance method of BBCore

Param	Type
[options]	Object
onComplete	function

bbCore.getVideoRecorder(opts, onComplete)

Kind: instance method of BBCore

Param	Type
opts	object
onComplete	function

bbCore.saveRecordedVideo(title, videoId, videoFilename, success)

Kind: instance method of BBCore

Param	Type
title	string
videoId	string
videoFilename	string
success	function

bbCore.saveRecording(options)

Kind: instance method of BBCore

Param	Type
options	Object

BBCore.video

{Object} BBCore.videos

Kind: static class of BBCore

new video(properties)

Param	Type
properties	videoProperties

BBCore.contact

stuff

Kind: static class of BBCore
Properties

Name	Type	Description
email	string	Email Address
firstname	string	First Name
lastname	string	Last Name
phone_number	string	Phone Number
address_line_1	string	Address 1
address_line_2	string	Address 2
city	string	City
state	string	State
country	string	Country`
postal_code	string	Postal Code
company	string	Company
position	string	Position
comments	string	Comments
listlist	string	Array of List Ids the Contact is subscribed to
id	string	Contact Id

new contact(properties)

Contact Object

Param	Type	Description
properties	contactProperties	contactProperties

BBCore.video

BBCore.video

Kind: static class of BBCore
Properties

Name	Type
vid_id	string
title	string
filename	string

new video(properties)

Param	Type
properties	videoProperties

BBCore.CONFIG : Object

Kind: static constant of BBCore
Properties

Name
VERSION
API_END_POINT
SERVER_API_URL

responseSuccess(responseObject, jqXHR)

reponseSuccess

Kind: global function

Param
responseObject
jqXHR

responseSuccess : Object

Kind: global typedef
Properties

Name	Type
status	string
method	string
info	Object

responseObject : Object

Kind: global typedef
Properties

Name	Type
status	string
method	string
info	Object

OAuthClientCredentials : Object

Kind: global typedef
Properties

Name	Type	Description
clientIdentifier	string
clientSecret	string
redirectUri	string
type	string	'implicit'

responseSuccess : function

This callback is displayed as a global member.

Kind: global typedef

Param	Type
responseObject	Object
[jqXHR]	Object

requestParameters : object

Kind: global typedef
Properties

Name	Type
[method]	string
[api_key]	string
[async]	string
[url]	string
[url]	string

customVideoEmailOptions : object

Kind: global typedef
Properties

Name	Type
from_name	string
email_id	string
email	string
subject	string
html_content	string

responseSuccess : function

This callback is displayed as a global member.

Kind: global typedef

Param	Type
responseObject	Object
[jqXHR]	Object

contactProperties : Object

Kind: global typedef
Properties

Name	Type	Description
email	string	Email Address
firstname	string	First Name
lastname	string	Last Name
phone_number	string	Phone Number
address_line_1	string	Address 1
address_line_2	string	Address 2
city	string	City
state	string	State
country	string	Country`
postal_code	string	Postal Code
company	string	Company
position	string	Position
comments	string	Comments
listlist	string	Array of List Ids the Contact is subscribed to
id	string	Contact Id

videoProperties : object

Kind: global typedef
Properties

Name	Type
vid_id	string
title	string
filename	string