Class Index | File Index

Classes


Function Namespace kocujILV12aCBackendReviewMessage

kocujILV12aCBackendReviewMessage
Defined in: review-message.js.

Function Namespace Summary
Constructor Attributes Constructor Name and Description
 
Review message prototype constructor
Field Summary
Field Attributes Field Name and Description
<private>  
Object kocujILV12aHelper
<private>  
Projects list
<private>  
Current script filename
<private>  
Script settings - prefix
<private>  
Script settings - security string
<private>  
Script settings - throw errors (true) or not (false)
Method Summary
Method Attributes Method Name and Description
<private>  
_checkAddProject(projectId, voteUrl, facebookUrl, twitterUrl, translationUrl)
Check arguments for adding project
<private>  
Get event name prefix
<private>  
Get HTML prefix for message review
<private>  
Get HTML prefix for message review by Facebook
<private>  
Get HTML prefix for message review about translation
<private>  
Get HTML prefix for message review by Twitter
<private>  
Get HTML prefix for message review by voting
<private>  
_getHTMLPrefix(projectId)
Get HTML prefix
<private>  
_parseProjectId(projectId)
Parse project identifier
<private>  
_setEvent(projectId, elementPath, eventNameSuffix, url)
Set event
<private>  
_throwError(codeString, param)
Throw an error if debugging is enabled
 
addProject(projectId, voteUrl, facebookUrl, twitterUrl, translationUrl)
Add project
 
addProjectIfNotExists(projectId, voteUrl, facebookUrl, twitterUrl, translationUrl)
Add project if not exists
 
Get HTML selector for message review
 
Get HTML selector for message review by Facebook
 
Get HTML selector for message review about translation
 
Get HTML selector for message review by Twitter
 
Get HTML selector for message review by voting
 
setEvents(projectId)
Set review message events
Function Namespace Detail
kocujILV12aCBackendReviewMessage()
Review message prototype constructor
Returns:
{void}
Field Detail
<private> _objHelper
Object kocujILV12aHelper

<private> _prj
Projects list

<private> _thisFilename
Current script filename

<private> _valsPrefix
Script settings - prefix

<private> _valsSecurity
Script settings - security string

<private> _valsThrowErrors
Script settings - throw errors (true) or not (false)
Method Detail
<private> {Object} _checkAddProject(projectId, voteUrl, facebookUrl, twitterUrl, translationUrl)
Check arguments for adding project
Parameters:
{string} projectId
Project identifier
{string} voteUrl Optional
URL for voting for
{string} facebookUrl Optional
URL for tell others on Facebook
{string} twitterUrl Optional
URL for tell others on Twitter
{string} translationUrl Optional
URL for project translation
Throws:
{kocujILV12aCException}
kocujILV12aExceptionCode.EMPTY_PROJECT_ID if project identifier entered in projectId is empty
Returns:
{Object} Parsed arguments for adding project

<private> {string} _getEventNamePrefix(projectId)
Get event name prefix
Parameters:
{string} projectId
Project identifier
Returns:
{string} Event name prefix

<private> {string} _getHTMLNameMessageReview(projectId)
Get HTML prefix for message review
Parameters:
{string} projectId
Project identifier
Returns:
{string} HTML prefix for message review

<private> {string} _getHTMLNameReviewMessageFacebook(projectId)
Get HTML prefix for message review by Facebook
Parameters:
{string} projectId
Project identifier
Returns:
{string} HTML prefix for message review by Facebook

<private> {string} _getHTMLNameReviewMessageTranslation(projectId)
Get HTML prefix for message review about translation
Parameters:
{string} projectId
Project identifier
Returns:
{string} HTML prefix for message review about translation

<private> {string} _getHTMLNameReviewMessageTwitter(projectId)
Get HTML prefix for message review by Twitter
Parameters:
{string} projectId
Project identifier
Returns:
{string} HTML prefix for message review by Twitter

<private> {string} _getHTMLNameReviewMessageVote(projectId)
Get HTML prefix for message review by voting
Parameters:
{string} projectId
Project identifier
Returns:
{string} HTML prefix for message review by voting

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

<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
Returns:
{string} Parsed project identifier

<private> {void} _setEvent(projectId, elementPath, eventNameSuffix, url)
Set event
Parameters:
{string} projectId
Project identifier
{string} elementPath
DOM path to element inside the review message box
{string} eventNameSuffix
Suffix for event name
{string} url
URL opened in new window after click event
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, voteUrl, facebookUrl, twitterUrl, translationUrl)
Add project
Parameters:
{string} projectId
Project identifier
{string} voteUrl Optional
URL for voting for
{string} facebookUrl Optional
URL for tell others on Facebook
{string} twitterUrl Optional
URL for tell others on Twitter
{string} translationUrl Optional
URL for project translation
Throws:
{kocujILV12aCException}
kocujILV12aExceptionCode.PROJECT_ALREADY_EXISTS if project identifier entered in projectId already exists
Returns:
{void}

{void} addProjectIfNotExists(projectId, voteUrl, facebookUrl, twitterUrl, translationUrl)
Add project if not exists
Parameters:
{string} projectId
Project identifier
{string} voteUrl Optional
URL for voting for
{string} facebookUrl Optional
URL for tell others on Facebook
{string} twitterUrl Optional
URL for tell others on Twitter
{string} translationUrl Optional
URL for project translation
Returns:
{void}

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

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

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

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

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

{void} setEvents(projectId)
Set review message events
Parameters:
{string} projectId
Project identifier
Returns:
{void}

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