- BBCore :
object
- responseSuccess(responseObject, jqXHR)
reponseSuccess
- 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
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
- instance
DEPRECATED - Use validateSession
Kind: instance property of BBCore
Kind: instance method of BBCore
Returns the fully qualified URL for BB API
Kind: instance method of BBCore
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 |
Authenticates a user using their Email Address (User Id) and Password
Kind: instance method of BBCore
Param | Type |
---|---|
uid | string |
pwd | string |
success | responseSuccess |
Returns bool for whether or not a prior authentication is stored locally
Kind: instance method of BBCore
Save credentials to local storage (not recommended)
Kind: instance method of BBCore
Param | Type | Description |
---|---|---|
uid | string |
User ID/Email Address |
pwd | string |
Password |
Authenticates from previously stored credentials
Kind: instance method of BBCore
Param | Type |
---|---|
onSuccess | responseSuccess |
onError | responseSuccess |
Kind: instance method of BBCore
Param |
---|
onSuccess |
Detects if accessToken provided is an api_key or an accessToken
Kind: instance method of BBCore
Returns bool for authentication state
Kind: instance method of BBCore
Invalidates and clears the active session, similar to logout
Kind: instance method of BBCore
Validates the given key
Kind: instance method of BBCore
Param | Type |
---|---|
key | string |
complete | responseSuccess |
Stores the give session key, typically used so a session can be resumed later on.
Kind: instance method of BBCore
Param |
---|
key |
Validates the given key
Kind: instance method of BBCore
Param | Type |
---|---|
key | string |
complete | responseSuccess |
Stores the OAuth Token for API calls
Kind: instance method of BBCore
Param |
---|
key |
Kind: instance method of BBCore
Kind: instance method of BBCore
Param |
---|
authCode |
onSuccess |
onError |
Kind: instance method of BBCore
Stores the give session key, typically used so a session can be resumed later on.
Kind: instance method of BBCore
Param |
---|
key |
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. |
Retrieves Contact Lists
Kind: instance method of BBCore
Param | Type |
---|---|
success | responseSuccess |
Creates a Contact List and returns the Guid
Kind: instance method of BBCore
Param | Type |
---|---|
listName | string |
success | responseSuccess |
Retrieves a Contact
Kind: instance method of BBCore
Param | Type |
---|---|
contactId | string |
success | responseSuccess |
Retrieves Contacts from a Contact List
Kind: instance method of BBCore
Param | Type |
---|---|
listId | string |
success | responseSuccess |
Adds a Contact to a Contact List
Kind: instance method of BBCore
Param | Type |
---|---|
contact | contact |
success | responseSuccess |
Adds a batch of Contacts
Kind: instance method of BBCore
Param | Type |
---|---|
opts | object |
success | responseSuccess |
Kind: instance method of BBCore
Param | Type |
---|---|
opts | object |
success | responseSuccess |
Retrieves an Import Address by a Type
Kind: instance method of BBCore
Param | Type |
---|---|
opts | |
success | responseSuccess |
Retrieves an Import Address by a Type
Kind: instance method of BBCore
Param | Type |
---|---|
opts | object |
success | responseSuccess |
Retrieves a list of Emails from the current authenticated session
Kind: instance method of BBCore
Param | Type |
---|---|
success | responseSuccess |
Kind: instance method of BBCore
Param | Type |
---|---|
opts | customVideoEmailOptions |
success | function |
Kind: instance method of BBCore
Param | Type |
---|---|
opts | object |
success | responseSuccess |
Kind: instance method of BBCore
Param | Type |
---|---|
opts | object |
success | responseSuccess |
Kind: instance method of BBCore
Param |
---|
opts |
success |
Deletes a Video
Kind: instance method of BBCore
Param | Type |
---|---|
videoId | string |
success | responseSuccess |
Kind: instance method of BBCore
Param | Type |
---|---|
opts | object |
onSuccess | responseSuccess |
Kind: instance method of BBCore
Param | Type |
---|---|
[options] | Object |
onComplete | function |
Kind: instance method of BBCore
Param | Type |
---|---|
opts | object |
onComplete | function |
Kind: instance method of BBCore
Param | Type |
---|---|
title | string |
videoId | string |
videoFilename | string |
success | function |
Kind: instance method of BBCore
Param | Type |
---|---|
options | Object |
{Object} BBCore.videos
Kind: static class of BBCore
Param | Type |
---|---|
properties | videoProperties |
stuff
Kind: static class of BBCore
Properties
Name | Type | Description |
---|---|---|
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 |
Contact Object
Param | Type | Description |
---|---|---|
properties | contactProperties |
contactProperties |
BBCore.video
Kind: static class of BBCore
Properties
Name | Type |
---|---|
vid_id | string |
title | string |
filename | string |
Param | Type |
---|---|
properties | videoProperties |
Kind: static constant of BBCore
Properties
Name |
---|
VERSION |
API_END_POINT |
SERVER_API_URL |
Kind: global class
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 |
Kind: global class
Properties
Name | Type |
---|---|
vid_id | string |
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
- instance
DEPRECATED - Use validateSession
Kind: instance property of BBCore
Kind: instance method of BBCore
Returns the fully qualified URL for BB API
Kind: instance method of BBCore
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 |
Authenticates a user using their Email Address (User Id) and Password
Kind: instance method of BBCore
Param | Type |
---|---|
uid | string |
pwd | string |
success | responseSuccess |
Returns bool for whether or not a prior authentication is stored locally
Kind: instance method of BBCore
Save credentials to local storage (not recommended)
Kind: instance method of BBCore
Param | Type | Description |
---|---|---|
uid | string |
User ID/Email Address |
pwd | string |
Password |
Authenticates from previously stored credentials
Kind: instance method of BBCore
Param | Type |
---|---|
onSuccess | responseSuccess |
onError | responseSuccess |
Kind: instance method of BBCore
Param |
---|
onSuccess |
Detects if accessToken provided is an api_key or an accessToken
Kind: instance method of BBCore
Returns bool for authentication state
Kind: instance method of BBCore
Invalidates and clears the active session, similar to logout
Kind: instance method of BBCore
Validates the given key
Kind: instance method of BBCore
Param | Type |
---|---|
key | string |
complete | responseSuccess |
Stores the give session key, typically used so a session can be resumed later on.
Kind: instance method of BBCore
Param |
---|
key |
Validates the given key
Kind: instance method of BBCore
Param | Type |
---|---|
key | string |
complete | responseSuccess |
Stores the OAuth Token for API calls
Kind: instance method of BBCore
Param |
---|
key |
Kind: instance method of BBCore
Kind: instance method of BBCore
Param |
---|
authCode |
onSuccess |
onError |
Kind: instance method of BBCore
Stores the give session key, typically used so a session can be resumed later on.
Kind: instance method of BBCore
Param |
---|
key |
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. |
Retrieves Contact Lists
Kind: instance method of BBCore
Param | Type |
---|---|
success | responseSuccess |
Creates a Contact List and returns the Guid
Kind: instance method of BBCore
Param | Type |
---|---|
listName | string |
success | responseSuccess |
Retrieves a Contact
Kind: instance method of BBCore
Param | Type |
---|---|
contactId | string |
success | responseSuccess |
Retrieves Contacts from a Contact List
Kind: instance method of BBCore
Param | Type |
---|---|
listId | string |
success | responseSuccess |
Adds a Contact to a Contact List
Kind: instance method of BBCore
Param | Type |
---|---|
contact | contact |
success | responseSuccess |
Adds a batch of Contacts
Kind: instance method of BBCore
Param | Type |
---|---|
opts | object |
success | responseSuccess |
Kind: instance method of BBCore
Param | Type |
---|---|
opts | object |
success | responseSuccess |
Retrieves an Import Address by a Type
Kind: instance method of BBCore
Param | Type |
---|---|
opts | |
success | responseSuccess |
Retrieves an Import Address by a Type
Kind: instance method of BBCore
Param | Type |
---|---|
opts | object |
success | responseSuccess |
Retrieves a list of Emails from the current authenticated session
Kind: instance method of BBCore
Param | Type |
---|---|
success | responseSuccess |
Kind: instance method of BBCore
Param | Type |
---|---|
opts | customVideoEmailOptions |
success | function |
Kind: instance method of BBCore
Param | Type |
---|---|
opts | object |
success | responseSuccess |
Kind: instance method of BBCore
Param | Type |
---|---|
opts | object |
success | responseSuccess |
Kind: instance method of BBCore
Param |
---|
opts |
success |
Deletes a Video
Kind: instance method of BBCore
Param | Type |
---|---|
videoId | string |
success | responseSuccess |
Kind: instance method of BBCore
Param | Type |
---|---|
opts | object |
onSuccess | responseSuccess |
Kind: instance method of BBCore
Param | Type |
---|---|
[options] | Object |
onComplete | function |
Kind: instance method of BBCore
Param | Type |
---|---|
opts | object |
onComplete | function |
Kind: instance method of BBCore
Param | Type |
---|---|
title | string |
videoId | string |
videoFilename | string |
success | function |
Kind: instance method of BBCore
Param | Type |
---|---|
options | Object |
{Object} BBCore.videos
Kind: static class of BBCore
Param | Type |
---|---|
properties | videoProperties |
stuff
Kind: static class of BBCore
Properties
Name | Type | Description |
---|---|---|
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 |
Contact Object
Param | Type | Description |
---|---|---|
properties | contactProperties |
contactProperties |
BBCore.video
Kind: static class of BBCore
Properties
Name | Type |
---|---|
vid_id | string |
title | string |
filename | string |
Param | Type |
---|---|
properties | videoProperties |
Kind: static constant of BBCore
Properties
Name |
---|
VERSION |
API_END_POINT |
SERVER_API_URL |
reponseSuccess
Kind: global function
Param |
---|
responseObject |
jqXHR |
Kind: global typedef
Properties
Name | Type |
---|---|
status | string |
method | string |
info | Object |
Kind: global typedef
Properties
Name | Type |
---|---|
status | string |
method | string |
info | Object |
Kind: global typedef
Properties
Name | Type | Description |
---|---|---|
clientIdentifier | string |
|
clientSecret | string |
|
redirectUri | string |
|
type | string |
'implicit' |
This callback is displayed as a global member.
Kind: global typedef
Param | Type |
---|---|
responseObject | Object |
[jqXHR] | Object |
Kind: global typedef
Properties
Name | Type |
---|---|
[method] | string |
[api_key] | string |
[async] | string |
[url] | string |
[url] | string |
Kind: global typedef
Properties
Name | Type |
---|---|
from_name | string |
email_id | string |
string |
|
subject | string |
html_content | string |
This callback is displayed as a global member.
Kind: global typedef
Param | Type |
---|---|
responseObject | Object |
[jqXHR] | Object |
Kind: global typedef
Properties
Name | Type | Description |
---|---|---|
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 |
Kind: global typedef
Properties
Name | Type |
---|---|
vid_id | string |
title | string |
filename | string |