Quakker Aura Technical Documentation - clorce/QuakkerPub GitHub Wiki

Modules

quakkerContainerController

This module defines the controller for the QuakkerContainer Lightning component.

quakkerContainerHelper

This module defines the helper for the QuakkerContainer Lightning component.

quakkerContainerController

This module defines the controller for the QuakkerContainer Lightning component.

quakkerContainerController~doInit(component, event, helper)

Initializes the component by loading setup configuration

Kind: inner method of quakkerContainerController

Param Type Description
component Object The Lightning component
event Object The initialization event
helper Object The component helper

quakkerContainerController~handleStatusChange(component, event, helper)

Handles status changes from OmniChannel and updates the phone app

Kind: inner method of quakkerContainerController

Param Type Description
component Object The Lightning component
event Object The status change event containing statusName parameter
helper Object The component helper

quakkerContainerController~handleQuakkerStatusChange(component, event, helper)

Handles status changes from Quakker and synchronizes with OmniChannel if enabled

Kind: inner method of quakkerContainerController

Param Type Description
component Object The Lightning component
event Object The status change event containing statusName parameter
helper Object The component helper

quakkerContainerController~handleOmniLogin(component, event, helper)

Handles OmniChannel login events

Kind: inner method of quakkerContainerController

Param Type Description
component Object The Lightning component
event Object The login event containing statusId parameter
helper Object The component helper

quakkerContainerController~handleOmniLogout(component, event, helper)

Handles OmniChannel logout events and sets status to offline

Kind: inner method of quakkerContainerController

Param Type Description
component Object The Lightning component
event Object The logout event
helper Object The component helper

quakkerContainerController~handleStatusSelect(component, event, helper)

Handles manual status selection and updates OmniChannel status

Kind: inner method of quakkerContainerController

Param Type Description
component Object The Lightning component
event Object The status selection event
helper Object The component helper

quakkerContainerController~handleShowQuakkerUtilityEvent(component, event, helper)

Handles events to show/maximize the Quakker utility window

Kind: inner method of quakkerContainerController

Param Type Description
component Object The Lightning component
event Object The show utility event
helper Object The component helper

quakkerContainerController~handleMinimize(component, event, helper)

Minimizes the utility window

Kind: inner method of quakkerContainerController

Param Type Description
component Object The Lightning component
event Object The minimize event
helper Object The component helper

quakkerContainerController~handleChanged()

Handles component changes and refreshes the view

Kind: inner method of quakkerContainerController

quakkerContainerHelper

This module defines the helper for the QuakkerContainer Lightning component.

quakkerContainerHelper~getSetup(component) -- Promise

Retrieves setup configuration from the server

Kind: inner method of quakkerContainerHelper
Returns: Promise - Promise that resolves with setup data or rejects with error

Param Type Description
component Object The Lightning component

quakkerContainerHelper~initializeAfterSetup(component)

Initializes component features after setup is loaded

Kind: inner method of quakkerContainerHelper

Param Type Description
component Object The Lightning component

quakkerContainerHelper~initOmniChannel(component)

Initializes OmniChannel connection with retry logic

Kind: inner method of quakkerContainerHelper

Param Type Description
component Object The Lightning component

quakkerContainerHelper~checkOmniChannelAvailability(component) -- Promise.<boolean>

Checks if OmniChannel is available and sets component status accordingly

Kind: inner method of quakkerContainerHelper
Returns: Promise.<boolean> - Promise that resolves with availability status

Param Type Description
component Object The Lightning component

quakkerContainerHelper~changeOmniStatus(component, statusName)

Changes the OmniChannel presence status

Kind: inner method of quakkerContainerHelper

Param Type Description
component Object The Lightning component
statusName string The name of the status to change to

quakkerContainerHelper~fetchPresenceStatuses(component) -- Promise

Fetches available presence statuses from the server

Kind: inner method of quakkerContainerHelper
Returns: Promise - Promise that resolves when statuses are loaded or rejects with error

Param Type Description
component Object The Lightning component

quakkerContainerHelper~handleUpdateUtilityLabel(component, newLabel)

Updates the utility bar label

Kind: inner method of quakkerContainerHelper

Param Type Description
component Object The Lightning component
newLabel string The new label text to display

quakkerContainerHelper~universalErrorHandler(component, errors)

Universal error handler that displays toast messages and logs errors

Kind: inner method of quakkerContainerHelper

Param Type Description
component Object The Lightning component
errors Array | Object Array of error objects or single error object

quakkerContainerHelper~handleShowToastMessage(component, title, message, type, mode)

Displays a toast message to the user

Kind: inner method of quakkerContainerHelper

Param Type Description
component Object The Lightning component
title string The toast title
message string The toast message
type string The toast type (info, success, warning, error)
mode string The toast mode (dismissible, pester, sticky)
⚠️ **GitHub.com Fallback** ⚠️