digitalsignage.com - open source docs digitalsignage.com - open source docs

  • API Docs for Version: 1.5.118

    • APIs

    Show:

    AppAuth Class

    Defined in: _controllers\AppAuth.js:1

    Manage user authentication and cookie creation and pass results back to app router

    Constructor

    AppAuth

    () Object

    Defined in _controllers\AppAuth.js:1

    Returns:

    Object:

    instantiated AppAuth

    Methods

    _applyLimitedAccess

    (
    • i_navigationView
    )

    Defined in _controllers\AppAuth.js:184

    Apply limited access to application since user logged in with Pro account intp Lite Studio

    Parameters:

    • i_navigationView Object

    _authFailed

    (
    • i_status
    • i_authMode
    )

    Defined in _controllers\AppAuth.js:150

    User authentication completed unsuccessfully

    Parameters:

    • i_status String

      status message from remote mediaSERVER (could include warnings)

    • i_authMode String

      indicates if authentication was done via cookie or user input

    _authPassed

    (
    • i_user
    • i_pass
    • i_status
    • i_authMode
    )

    Defined in _controllers\AppAuth.js:106

    User authentication completed successfully

    Parameters:

    • i_user String

      user name

    • i_pass String

      user password

    • i_status String

      status message from remote mediaSERVER (could include warnings)

    • i_authMode String

      indicates if authentication was done via cookie or user input

    _authServer

    (
    • i_user
    • i_pass
    • i_authMode
    )

    Defined in _controllers\AppAuth.js:87

    Process actual authentication against mediaSERVER

    Parameters:

    • i_user String
    • i_pass String
    • i_authMode Number

    _bakeCookie

    (
    • i_crumb
    )

    Defined in _controllers\AppAuth.js:194

    Create cookie

    Parameters:

    • i_crumb String

    _breakCookie

    (
    • i_user
    • i_pass
    )
    Object

    Defined in _controllers\AppAuth.js:216

    Break encrypted cookie RC4 to user credentials

    Parameters:

    • i_user String
    • i_pass String

    Returns:

    Object:

    credentials

    _encryptUserPass

    (
    • i_user
    • i_pass
    )

    Defined in _controllers\AppAuth.js:204

    Create RC4 local encrypted cookie

    Parameters:

    • i_user String
    • i_pass String

    _loadCredentials

    (
    • i_user
    • i_pass
    )

    Defined in _controllers\AppAuth.js:57

    Load user credentials from param or cookie or form data

    Parameters:

    • i_user String
    • i_pass String

    _loadPassedCredentials

    () Object

    Defined in _controllers\AppAuth.js:39

    Check if user / pass were passed in via params

    Returns:

    Object:

    user and pass if passed in or undefined if none

    authenticate

    (
    • i_user
    • i_pass
    )

    Defined in _controllers\AppAuth.js:26

    Initiate user authentication against the Pepper db user credentials

    Parameters:

    • i_user String
    • i_pass String

    initialize

    ()

    Defined in _controllers\AppAuth.js:13

    Constructor

    Returns:

    Unique clientId.

    logout

    ()

    Defined in _controllers\AppAuth.js:232

    Logout of application and delete saved local cookie