Class Index | File Index

Classes


Function Namespace kocujPLV12aCBackendAddThanks

kocujPLV12aCBackendAddThanks
Defined in: add-thanks.js.

Function Namespace Summary
Constructor Attributes Constructor Name and Description
 
Add thanks prototype constructor
Field Summary
Field Attributes Field Name and Description
<private>  
Object kocujILV12aAllJsAjax
<private>  
Object kocujILV12aHelper
<private>  
Projects list
<private>  
Saved styles
<private>  
Styles are saved (true) or not (false)
<private>  
Current script filename
<private>  
Script settings - text for loading URL
<private>  
Script settings - prefix
<private>  
Script settings - prefix for Kocuj Internal Lib
<private>  
Script settings - security string
<private>  
Script settings - text for error
<private>  
Script settings - text for data which already exists
<private>  
Script settings - text for error with no more retries
<private>  
Script settings - text for wrong response from server (line 1)
<private>  
Script settings - text for wrong response from server (line 2)
<private>  
Script settings - text for more information link
<private>  
Script settings - text for sending
<private>  
Script settings - text for success
<private>  
Script settings - throw errors (true) or not (false)
<private>  
Script settings - website description
<private>  
Script settings - website title
<private>  
Script settings - website URL
Method Summary
Method Attributes Method Name and Description
<private>  
_addThanks(projectId)
Add thanks
<private>  
Change HTML elements before sending AJAX for adding thanks
<private>  
_checkAddProject(projectId, windowFunction, projectApiUrl, projectApiLogin, projectApiPassword)
Check arguments for adding project
<private>  
Get HTML name for adding thanks div in page about
<private>  
Get HTML name for loading div in page about
<private>  
Get HTML name for more information link in page about
<private>  
Get HTML name for sending button in page about
<private>  
Get HTML name for status div in page about
<private>  
Get HTML name for loading image in review message
<private>  
Get HTML name for more information link in review message
<private>  
Get HTML name for more information link div in review message
<private>  
Get HTML name for sending button in review message
<private>  
Get HTML name for style
<private>  
Get HTML name for close message in review message
<private>  
Get HTML name for review message div
<private>  
_getHTMLPrefix(projectId)
Get HTML prefix
<private>  
Get HTML prefix for Kocuj Internal Lib
<private>  
_parseProjectId(projectId)
Parse project identifier
<private>  
Remove of loading image element from review message
<private>  
Show close element for review message
<private>  
_throwError(codeString, param)
Throw an error if debugging is enabled
 
addProject(projectId, windowFunction, projectApiUrl, projectApiLogin, projectApiPassword)
Add project
 
addProjectIfNotExists(projectId, windowFunction, projectApiUrl, projectApiLogin, projectApiPassword)
Add project if not exists
 
ajaxAddThanksErrorCallback(projectId, connectionId, obj, status, err)
AJAX loading error callback for adding thanks
 
ajaxAddThanksRetryNowCallback(projectId, connectionId, retries, obj, status, err)
Doing something at the beginning of AJAX request retry callback for adding thanks
 
ajaxAddThanksRetryWaitCallback(projectId, connectionId, retries, obj, status, err)
Doing something before waiting for AJAX request retry callback for adding thanks
 
ajaxAddThanksSuccessCallback(projectId, connectionId, data, status, obj)
AJAX loading success callback for adding thanks
 
Get HTML selector for adding thanks div in about page
 
Get HTML selector for loading div in about page
 
Get HTML selector for more information link in about page
 
Get HTML selector for sending button in about page
 
Get HTML selector for status div in about page
 
Get HTML selector for loading image in review message
 
Get HTML selector for more information link in review message
 
Get HTML selector for more information link div in review message
 
Get HTML selector for send button in review message
 
Get HTML selector for style
 
Get HTML selector for close message in review message
 
Get HTML selector for review message
 
Set adding thanks for about page
 
Set adding thanks for review message
Function Namespace Detail
kocujPLV12aCBackendAddThanks()
Add thanks prototype constructor
Returns:
{void}
Field Detail
<private> _objAllJsAjax
Object kocujILV12aAllJsAjax

<private> _objHelper
Object kocujILV12aHelper

<private> _prj
Projects list

<private> _styles
Saved styles

<private> _stylesSaved
Styles are saved (true) or not (false)

<private> _thisFilename
Current script filename

<private> _valsImageLoadingUrl
Script settings - text for loading URL

<private> _valsPrefix
Script settings - prefix

<private> _valsPrefixKocujIL
Script settings - prefix for Kocuj Internal Lib

<private> _valsSecurity
Script settings - security string

<private> _valsTextError
Script settings - text for error

<private> _valsTextErrorAlreadyExists
Script settings - text for data which already exists

<private> _valsTextErrorNoRetries
Script settings - text for error with no more retries

<private> _valsTextErrorWrongResponse1
Script settings - text for wrong response from server (line 1)

<private> _valsTextErrorWrongResponse2
Script settings - text for wrong response from server (line 2)

<private> _valsTextMoreInfoLink
Script settings - text for more information link

<private> _valsTextSending
Script settings - text for sending

<private> _valsTextSuccess
Script settings - text for success

<private> _valsThrowErrors
Script settings - throw errors (true) or not (false)

<private> _valsWebsiteDescription
Script settings - website description

<private> _valsWebsiteTitle
Script settings - website title

<private> _valsWebsiteUrl
Script settings - website URL
Method Detail
<private> {void} _addThanks(projectId)
Add thanks
Parameters:
{string} projectId
Project identifier
Returns:
{void}

<private> {void} _changeElementsBeforeAddThanksAjaxSend(projectId)
Change HTML elements before sending AJAX for adding thanks
Parameters:
{string} projectId
Project identifier
Returns:
{void}

<private> {Object} _checkAddProject(projectId, windowFunction, projectApiUrl, projectApiLogin, projectApiPassword)
Check arguments for adding project
Parameters:
{string} projectId
Project identifier
{string} windowFunction
Function name for window
{string} projectApiUrl
Project API URL
{string} projectApiLogin
Project API login
{string} projectApiPassword Optional
Project API password
Throws:
{kocujILV12aCException}
kocujILV12aExceptionCode.EMPTY_PROJECT_ID if project identifier entered in projectId is empty
{kocujILV12aCException}
kocujILV12aExceptionCode.ADD_THANKS_EMPTY_API_URL if API URL entered in projectApiUrl is empty
{kocujILV12aCException}
kocujILV12aExceptionCode.ADD_THANKS_EMPTY_API_LOGIN if API login entered in projectApiLogin is empty
Returns:
{Object} Parsed arguments for adding project

<private> {string} _getHTMLNameAddThanksPageAboutDiv(projectId)
Get HTML name for adding thanks div in page about
Parameters:
{string} projectId
Project identifier
Returns:
{string} HTML name for adding thanks div in page about

<private> {string} _getHTMLNameAddThanksPageAboutLoadingDiv(projectId)
Get HTML name for loading div in page about
Parameters:
{string} projectId
Project identifier
Returns:
{string} HTML name for loading div in page about

<private> {string} _getHTMLNameAddThanksPageAboutMoreInfoLink(projectId)
Get HTML name for more information link in page about
Parameters:
{string} projectId
Project identifier
Returns:
{string} HTML name for more information link in page about

<private> {string} _getHTMLNameAddThanksPageAboutSend(projectId)
Get HTML name for sending button in page about
Parameters:
{string} projectId
Project identifier
Returns:
{string} HTML name for sending button in page about

<private> {string} _getHTMLNameAddThanksPageAboutStatusDiv(projectId)
Get HTML name for status div in page about
Parameters:
{string} projectId
Project identifier
Returns:
{string} HTML name for status div in page about

<private> {string} _getHTMLNameAddThanksReviewMessageLoadingImage(projectId)
Get HTML name for loading image in review message
Parameters:
{string} projectId
Project identifier
Returns:
{string} HTML name for loading image in review message

<private> {string} _getHTMLNameAddThanksReviewMessageMoreInfoLink(projectId)
Get HTML name for more information link in review message
Parameters:
{string} projectId
Project identifier
Returns:
{string} HTML name for more information link in review message

<private> {string} _getHTMLNameAddThanksReviewMessageMoreInfoLinkDiv(projectId)
Get HTML name for more information link div in review message
Parameters:
{string} projectId
Project identifier
Returns:
{string} HTML name for more information link div in review message

<private> {string} _getHTMLNameAddThanksReviewMessageSend(projectId)
Get HTML name for sending button in review message
Parameters:
{string} projectId
Project identifier
Returns:
{string} HTML name for sending button in review message

<private> {string} _getHTMLNameAddThanksStyle(projectId)
Get HTML name for style
Parameters:
{string} projectId
Project identifier
Returns:
{string} HTML name for style

<private> {string} _getHTMLNameReviewMessageClose(projectId)
Get HTML name for close message in review message
Parameters:
{string} projectId
Project identifier
Returns:
{string} HTML name for close message in review message

<private> {string} _getHTMLNameReviewMessageDiv(projectId)
Get HTML name for review message div
Parameters:
{string} projectId
Project identifier
Returns:
{string} HTML name for review message div

<private> {string} _getHTMLPrefix(projectId)
Get HTML prefix
Parameters:
{string} projectId
Project identifier
Returns:
{string} HTML prefix

<private> {string} _getHTMLPrefixKocujIL(projectId)
Get HTML prefix for Kocuj Internal Lib
Parameters:
{string} projectId
Project identifier
Returns:
{string} HTML prefix for Kocuj Internal Lib

<private> {string} _parseProjectId(projectId)
Parse project identifier
Parameters:
{string} projectId
Project identifier
Throws:
{kocujILV12aCException}
kocujILV12aExceptionCode.EMPTY_PROJECT_ID if project identifier entered in projectId is empty
{kocujILV12aCException}
kocujILV12aExceptionCode.PROJECT_DOES_NOT_EXIST if project identifier entered in projectId does not exist
Returns:
{string} Parsed project identifier

<private> {void} _removeReviewMessageLoadingImageElement(projectId)
Remove of loading image element from review message
Parameters:
{string} projectId
Project identifier
Returns:
{void}

<private> {void} _showReviewMessageCloseElement(projectId)
Show close element for review message
Parameters:
{string} projectId
Project identifier
Returns:
{void}

<private> {void} _throwError(codeString, param)
Throw an error if debugging is enabled
Parameters:
{string} codeString
Error code in string format
{string} param Optional
Parameter for error information
Returns:
{void}

{void} addProject(projectId, windowFunction, projectApiUrl, projectApiLogin, projectApiPassword)
Add project
Parameters:
{string} projectId
Project identifier
{string} windowFunction
Function name for window
{string} projectApiUrl
Project API URL
{string} projectApiLogin
Project API login
{string} projectApiPassword Optional
Project API password
Throws:
{kocujILV12aCException}
kocujILV12aExceptionCode.PROJECT_ALREADY_EXISTS if project identifier entered in projectId already exists
Returns:
{void}

{void} addProjectIfNotExists(projectId, windowFunction, projectApiUrl, projectApiLogin, projectApiPassword)
Add project if not exists
Parameters:
{string} projectId
Project identifier
{string} windowFunction
Function name for window
{string} projectApiUrl
Project API URL
{string} projectApiLogin
Project API login
{string} projectApiPassword Optional
Project API password
Returns:
{void}

{void} ajaxAddThanksErrorCallback(projectId, connectionId, obj, status, err)
AJAX loading error callback for adding thanks
Parameters:
{string} projectId
Project identifier
{string} connectionId
Connection identifier
{Object} obj
Request object
{string} status
Text status
{string} err
Error
Returns:
{void}

{void} ajaxAddThanksRetryNowCallback(projectId, connectionId, retries, obj, status, err)
Doing something at the beginning of AJAX request retry callback for adding thanks
Parameters:
{string} projectId
Project identifier
{string} connectionId
Connection identifier
{numeric} retries
Connection retries
{Object} obj
Request object
{string} status
Text status
{string} err
Error
Returns:
{void}

{void} ajaxAddThanksRetryWaitCallback(projectId, connectionId, retries, obj, status, err)
Doing something before waiting for AJAX request retry callback for adding thanks
Parameters:
{string} projectId
Project identifier
{string} connectionId
Connection identifier
{numeric} retries
Connection retries
{Object} obj
Request object
{string} status
Text status
{string} err
Error
Returns:
{void}

{void} ajaxAddThanksSuccessCallback(projectId, connectionId, data, status, obj)
AJAX loading success callback for adding thanks
Parameters:
{string} projectId
Project identifier
{string} connectionId
Connection identifier
{anything} data
Data
{string} status
Text status
{Object} obj
Request object
Returns:
{void}

{string} getHTMLSelectorAddThanksPageAboutDiv(projectId)
Get HTML selector for adding thanks div in about page
Parameters:
{string} projectId
Project identifier
Returns:
{string} HTML selector for adding thanks div in about page

{string} getHTMLSelectorAddThanksPageAboutLoadingDiv(projectId)
Get HTML selector for loading div in about page
Parameters:
{string} projectId
Project identifier
Returns:
{string} HTML selector for loading div in about page

{string} getHTMLSelectorAddThanksPageAboutMoreInfoLink(projectId)
Get HTML selector for more information link in about page
Parameters:
{string} projectId
Project identifier
Returns:
{string} HTML selector for more information link in about page

{string} getHTMLSelectorAddThanksPageAboutSend(projectId)
Get HTML selector for sending button in about page
Parameters:
{string} projectId
Project identifier
Returns:
{string} HTML selector for sending button in about page

{string} getHTMLSelectorAddThanksPageAboutStatusDiv(projectId)
Get HTML selector for status div in about page
Parameters:
{string} projectId
Project identifier
Returns:
{string} HTML selector for status div in about page

{string} getHTMLSelectorAddThanksReviewMessageLoadingImage(projectId)
Get HTML selector for loading image in review message
Parameters:
{string} projectId
Project identifier
Returns:
{string} HTML selector for loading image in review message

{string} getHTMLSelectorAddThanksReviewMessageMoreInfoLink(projectId)
Get HTML selector for more information link in review message
Parameters:
{string} projectId
Project identifier
Returns:
{string} HTML selector for more information link in review message

{string} getHTMLSelectorAddThanksReviewMessageMoreInfoLinkDiv(projectId)
Get HTML selector for more information link div in review message
Parameters:
{string} projectId
Project identifier
Returns:
{string} HTML selector for more information link div in review message

{string} getHTMLSelectorAddThanksReviewMessageSend(projectId)
Get HTML selector for send button in review message
Parameters:
{string} projectId
Project identifier
Returns:
{string} HTML selector for send button in review message

{string} getHTMLSelectorAddThanksStyle(projectId)
Get HTML selector for style
Parameters:
{string} projectId
Project identifier
Returns:
{string} HTML selector for style

{string} getHTMLSelectorReviewMessageClose(projectId)
Get HTML selector for close message in review message
Parameters:
{string} projectId
Project identifier
Returns:
{string} HTML selector for close message in review message

{string} getHTMLSelectorReviewMessageDiv(projectId)
Get HTML selector for review message
Parameters:
{string} projectId
Project identifier
Returns:
{string} HTML selector for review message

{void} setPageAboutAddThanks(projectId)
Set adding thanks for about page
Parameters:
{string} projectId
Project identifier
Returns:
{void}

{void} setReviewMessageAddThanks(projectId)
Set adding thanks for review message
Parameters:
{string} projectId
Project identifier
Returns:
{void}

Documentation generated by JsDoc Toolkit 2.4.0 on Thu Mar 08 2018 21:48:58 GMT+0100 (CET)