Quakker LWC Technical Documentation - clorce/QuakkerPub GitHub Wiki

Modules

AddNewNumber: This module defines a Lightning Web Component for adding new phone numbers and associated records.
AddNewTask: This module defines a Lightning Web Component for adding new tasks in the context of phone interactions.
CallHistory: This module defines a Lightning Web Component for managing and interacting with the call history.
CallingScreen: This module defines a Lightning Web Component for managing the user interface for both outgoing and incoming calls.
SpinnerUtilities: This module defines utility functions for showing and hiding a spinner using the Lightning Message Service.
ContactInfo: This module defines a Lightning Web Component for displaying and managing contact information.
CustomLookup: This module defines a Lightning Web Component for a custom lookup functionality in Salesforce.
CustomLookupNewRecord: This module defines a Lightning Web Component for creating new records with custom lookup functionality.
DhoneCallScreenExitScreen: This module defines a Lightning Web Component that provides an interface for either staying on or exiting the phone call screen.
DialPadSlider: This module defines a Lightning Web Component for a dial pad slider in Salesforce.
featureUtils: This module provides utility functions for managing feature flags in LWC components
FooterMenu: This module defines a Lightning Web Component for a footer menu in Salesforce.
HomeScreen: This module defines a Lightning Web Component for the home screen of the phone app.
PhoneApp: This module defines a Lightning Web Component for the main phone application interface.
PhoneAppSettings: This module defines a Lightning Web Component for handling phone app settings.
PhoneCallScreen: This module defines a Lightning Web Component for managing the phone call screen.
PhoneCallScreenExitScreen: This module defines a Lightning Web Component that provides an interface for either staying on or exiting the phone call screen.
PhoneContainer: This module defines a Lightning Web Component for handling phone interactions.
quakkerWelcomeScreen: This module defines a Lightning Web Component (LWC) that serves as a welcome screen for the Quakker application.
SearchBar: This module defines a Lightning Web Component for handling search bar interactions.
SearchContainer: This module defines a Lightning Web Component for managing search functionality within a container.
SearchResults: This module defines a Lightning Web Component for displaying search results.
SipLibController: This module defines a Lightning Web Component for handling SIP based communication using the JsSIP library.
StatusChanger: This module defines a Lightning Web Component for changing and displaying the agent's status.
UserRegister: This module defines a Lightning Web Component for user registration, specifically for SIP (Session Initiation Protocol) user registration.
Utils: This module defines a set of utility functions for Lightning Web Components which assist in showing toast messages, animations, invoking methods, and more.

Members

tasksButtonClass -- String: If the tasks section is visible, returns a CSS class indicating an active (green background) state; otherwise, returns a class for an inactive (white background) state.
campaignsButtonClass -- String: If the tasks section is not visible, returns a CSS class indicating an active (green background) state; otherwise, returns a class for an inactive (white background) state.

Functions

connectedCallback(): Lifecycle hook that gets called when the component is inserted into the DOM.
handleInput(event): Event handler for user input in any of the form fields. Updates the record object with the new value.
addRecord(): Initiates the process to add a record in Salesforce, performs validations, and shows toast messages based on operation results.
validateInputs() -- boolean: Validates the inputs based on the selected object type to ensure necessary fields are filled before creating a record. If fields are missing, constructs an error message.
prepareFields() -- Object: Prepares a fields object for creating a record based on the selected object type and current input values.
handleSendRecordEvent(record): Constructs a record object from the created Salesforce record and dispatches a 'recordcreated' event to notify parent components or listeners.
close(): Dispatches a 'close' event to notify parent components or listeners and clears input fields.
prepareStartAnimation(event): Starts the animation on the given element.
prepareStopAnimation(event): Prepares the stop animation for the given event target.
connectedCallback(): Lifecycle hook that gets called when the component is inserted into the DOM.
disableAddButton() -- boolean: Determines if the Add button should be disabled based on campaign selection.
handleChildCmpConnected(event): Handles the event when a child component is connected.
handleChildCmpDisconnected(event): Handles the disconnection of child components, setting the property to undefined.
handleCampaignCreated(event): Handles the creation of a new campaign.
toggleAddCampaignScreen(): Toggles the visibility of the Add Campaign screen.
handleSelectedCampaign(event): Handles the selection of a campaign.
handleAddToCampaign(): Adds the person to the selected campaign or campaign.
handleAddMemberToCampaign(): Adds a member to the selected campaign.
handleUpdateCampaign(): Updates the selected campaign with the new person added.
close(): Closes the component and emits a close event.
prepareStartAnimation(event): Starts the animation on the given element.
prepareStopAnimation(event): Prepares the stop animation for the given event target.
appSettings() -- Object: Getter for the application settings.
appSettings(value): Setter for the application settings, updates call results based on the new settings.
options() -- Array: Getter for options property that returns the list of available options.
options(value): Setter for options property that updates the list of available options.
connectedCallback(): Lifecycle hook that gets called when the component is inserted into the DOM.
handleInputChange(event): Updates the value of a call result based on user input.
handleColorChange(event): Changes the color of a specific call result item.
handleDelete(event): Deletes a call result item based on its index.
handleAdd(): Adds a new call result item with default values.
saveGlobalSettings(): Saves the current settings by storing the selected objects and dispatches a close event.
validateValues() -- Boolean: Validates the values in 'callResults'. Ensures that there is at least one item present and that all items have non-empty values, showing toast messages for any validation errors.
close(): Dispatches a close event to signal that the component should be closed.
handleUpdateParentSettings(): Dispatches an event to update parent component settings with the current application settings.
prepareStartAnimation(event): Prepares the start of an animation.
prepareStopAnimation(event): Prepares the stop of an animation.
handleInput(event): Handles changes in input fields and updates the record object with new values.
handleConfirm() -- void: Dispatches a custom event called 'confirm' with the status as the event detail.
close(): Dispatches a 'close' event to notify parent components or listeners.
selectedCampaign() -- Object: Getter for the selectedCampaign value.
selectedCampaign(value): Setter for the selectedCampaign value.
appSettings() -- Object: Getter for the application settings.
appSettings(value): Setter for the application settings, updates call results based on the new settings.
connectedCallback(): Lifecycle hook that gets called when the component is inserted into the DOM.
disconnectedCallback(): This method is triggered when the component is removed from the DOM.
handleChildCmpConnected(event): Handles the connection of child components, associating the event target with a property.
handleChildCmpDisconnected(event): Handles the disconnection of child components, setting the property to undefined.
handleNameClick(event) -- void: Handles the click event and navigating to the record page.
handleSelectedCampaign(event): Processes the selection of a campaign, including fetching related campaign members and updating campaign statuses.
setSelectedCampaign(temp) -- Promise.<void>: Asynchronously sets the selected campaign state to a new value, ensuring state consistency.
fetchCampaignMembers(campaignId) -- Promise: Fetches campaign members for the selected campaign.
fetchQuickCampaignByCampaignId(campaignId) -- Promise: Fetches the quick campaign associated with the selected campaign.
handleCampaignDifferences(temp, selectedCampaign): Handles the differences between the selected campaign and the fetched quick campaign.
handleCreateQuickCampaign(): Creates a new quick campaign record for the selected campaign.
handleCallCampaign(): Triggers an event to start the calling process for the current selected campaign.
handleTextCampaign(): Triggers an event to start the texting campaign process for the current selected campaign.
handleUpdateCampaign(callingPersonId): Invokes status update processes for campaign items, optionally focusing on a specific calling person by ID.
isSalesforceCampaign() -- Boolean: Indicates whether the selected campaign is a Salesforce campaign.
disableCampaignOptions() -- Boolean: Computes a boolean value to enable or disable campaign options based on edit mode and campaign ID presence.
disableCallCampaignButton() -- Boolean: Computes a boolean value to enable or disable the Call Campaign button based on campaign JSON presence.
disableCreateButton() -- Boolean: Computes a boolean value to enable or disable the Edit Campaign button based on the edit mode.
handleCampaignTypeChanged(event): Handles the click event and toggles the edit mode.
disableTextCampaignButton() -- Boolean: Computes a boolean value to enable or disable the Text Campaign button based on campaign JSON presence.
handleUpdateQuickCampaignRecord() -- Promise.<void>: Updates the user record with SIP credentials.
handleAddMembersToCampaign() -- Promise.<void>: Handles the addition of new members to the selected campaign.
handleCancelSave(): Cancels the save operation and reverts the campaign changes.
handleUpdateCampaignItemsStatuses(callingPersonId): Handles the update of campaign items' statuses, optionally scrolling to a specific calling person.
scrollToElement(element): Scrolls the main content to the provided element.
handleContactClicked(event): Handles the click event on a contact item.
handleDragStart(event): Handles the dragstart event on a campaign item.
handleDragOver(event): Handles the dragover event on a campaign item.
handleDragEnter(event): Handles the dragenter event on a campaign item.
handleDragLeave(event): Handles the dragleave event on a campaign item.
handleDragEnd(event): Handles the dragend event on a campaign item.
handleDrop(event): Handles the drop event on a campaign item.
handleDeleteCampaignItem(event): Handles the deletion of a campaign item.
handleResetStatus(event): Resets the status of a campaign item.
handleShowDetails(event): Shows the details of a campaign item.
handleHideDetails(event): Hides the details of a campaign item.
prepareStartAnimation(event): Prepares the start of an animation.
prepareStopAnimation(event): Prepares the stop of an animation.
handleExit(): Emits an event to exit the settings interface.
toggleAddCampaignScreen(): Allows users to either show or hide the Add Campaign screen, facilitating the addition of a new campaign.
handleEditCampaign(): Sets the campaign that is about to be edited as the current selected campaign without changes and enables the edit mode.
toggleDeleteConfirmation(): Allows users to confirm or cancel the deletion of a campaign item by showing or hiding the delete confirmation modal.
handleRecordCreatedEvent(event): Updates the selected campaign with the new record's details and toggles the Add Campaign screen's visibility.
handleMemberSelected(event) -- Promise.<void>: Updates the selected campaign with the new record's details and fetches the associated quick campaign.
clearMemberLookup() -- Promise.<void>: Clears the member lookup component and resets all relevant fields.
handleRecordDeleteEvent(): Handles the deletion of a campaign item, refreshes the campaign list, displays a success message, and toggles the delete confirmation modal.
appSettings() -- Object: Getter for the application settings.
appSettings(value): Setter for the application settings, updates call results based on the new settings.
handleSelectedObjects(): Updates the selected objects from the application settings.
restrictedSettings() -- Boolean: Getter that determines if settings are restricted based on the admin status of the user.
options() -- Array: Getter for options property that returns the list of available options.
options(value): Setter for options property that updates the list of available options.
isAdmin() -- Boolean: Getter for the admin status.
isAdmin(value): Setter for the admin status.
connectedCallback(): Lifecycle hook that gets called when the component is inserted into the DOM.
handleChange(event): Handles change events on the component, updating the list of selected objects.
saveGlobalSettings(): Saves the current settings by storing the selected objects and dispatches a close event.
close(): Dispatches a close event to signal that the component should be closed.
handleUpdateParentSettings(): Dispatches an event to update parent component settings with the current application settings.
prepareStartAnimation(event): Prepares the start of an animation.
prepareStopAnimation(event): Prepares the stop of an animation.
devices() -- Object | Object: Getter for the list of devices.
devices(value) -- void: Setter for the list of devices.
connectedCallback(): Lifecycle hook that gets called when the component is inserted into the DOM.
loadDevices() -- void: Fetches the list of devices.
handleChangeSpeaker(event) -- void: Handles the change event for the speaker dropdown.
handleChangeMicrophone(event) -- void: Handles the change event for the microphone dropdown.
handleSave(): Dispatches an event to update the devices.
handleDispatchUpdateDevices(): Dispatches an event to update the devices.
close(): Dispatches an event to close the modal.
prepareStartAnimation(event): Starts the animation on the given element.
prepareStopAnimation(event): Prepares the stop animation for the given event target.
connectedCallback(): Lifecycle hook that gets called when the component is inserted into the DOM.
handleClick(event): Captures the ID of the clicked button, updates the selected button state, and dispatches a 'itemselected' custom event with the clicked button's ID as detail.
records(value): Setter for the records property.
records() -- Object: Getter for the records property.
connectedCallback(): Lifecycle hook that gets called when the component is inserted into the DOM.
handleChildCmpConnected(event): Handles the event when a child component is connected.
handleChildCmpDisconnected(event): Handles the disconnection of child components, setting the property to undefined.
initializeRecordsSelection() -- void: Initializes the records selection based on the shouldSelectAll property.
handleSelectAll(event) -- void: Handles the event when the user clicks the 'Select All' checkbox.
handleCheckboxChange(event) -- void: Handles the change event when a checkbox is clicked.
handleSelectedWhatId(event) -- void: Handles the event when a record is selected in the custom lookup component.
handleSave(): Logs all selected records (their ID and Name) to the console.
handleSkip(): Dispatches a 'skip' event to notify parent components or listeners.
handleCancel(): Dispatches a 'cancel' event to notify parent components or listeners.
prepareStartAnimation(event): Prepares the start animation for the given event target.
prepareStopAnimation(event): Prepares the stop animation for the given event target.
handleExit(component) -- Promise.<void>: Handles the exit action
handleQuickCampaignNavigation(component) -- Promise.<void>: Handles the quick campaign navigation
handleNextNavigation(component) -- Promise.<void>: Handles the next navigation
finishNavigation(component, state) -- Promise.<void>: Finishes navigation
shouldShowMultipleRecords(component) -- boolean: Determines if we should show the multiple records screen
shouldShowUnsavedChanges(component) -- boolean: Determines if we should show the unsaved changes screen
canShowScreens(component) -- boolean: Determines if we can show screens
handleIdleState(component, action, state) -- Promise.<void>: Handles the idle state
handleStatusScreenState(component, action, state) -- Promise.<void>: Handles the status screen state
handleMultipleRecordsState(component, action, state) -- Promise.<void>: Handles the multiple records state
unsavedChangesState(component, action, state) -- Promise.<void>: Handles the unsaved changes state
handleNavigation(component, action, state) -- Promise.<void>: Handles the navigation
appSettings() -- Object: Getter for the app settings.
appSettings(value): Setter for the app settings.
userData() -- Object: Getter for the user data.
userData(value): Setter for the user data.
sidePanelEnabled() -- Boolean: Getter for the side panel enabled property.
sidePanelEnabled(value): Setter for the side panel enabled property. It toggles the side panel visibility based on the value.
sidebarAvailable() -- Boolean: Getter for the sidebar available property.
connectedCallback(): Lifecycle hook that gets called when the component is inserted into the DOM.
disconnectedCallback(): This method is triggered when the component is removed from the DOM.
handleSidebarChannel(): Lifecycle method called when component gets disconnected from DOM. It unsubscribes from the platform event channel.
wiredMessages() -- Promise.<void>: Lifecycle method called when component gets disconnected from DOM. It unsubscribes from the platform event channel.
handleLoadMessages(event): Handles the load messages event and loads the messages for the selected person.
subscribeToPlatformEvent(): Subscribes to a platform event channel to listen for events.
unsubscribeFromPlatformEvent(): Unsubscribes from the platform event channel to stop listening for events.
handleSMSNotification(message): Handles the notification of a received SMS message.
handleHideMessageSpinner() -- void: Hides the message spinner in the PhoneSidebarTextMessages component.
handleRefreshMessagesAfterReceive(sender): Refreshes the messages list after a new message is received.
handleFetchMessages(fetchFresh) -- Promise.<void>: Refreshes the messages list.
handleRefreshMessagesAfterSent(recordId, phone): Refreshes the messages list after a new message is sent.
handleMessageSent(event): Handles the message sent event and refreshes the messages list.
handleChildCmpConnected(event): Updates the current component reference when a child component is connected.
handleChildCmpDisconnected(event): Handles the disconnection of child components, setting the property to undefined.
sidebarClass() -- String: Getter for the sidebar class based on the visibility of the main section.
handleToggleSideBar() -- void: Toggles the visibility of the main section and updates the sidebar icon.
handleChangeSubpage(event): Handles the subpage change event and updates the selected subpage.
handleSubpageSelect(event): Handles the subpage select event and updates the selected subpage.
showTextMessages() -- Boolean: Getter for the text messages visibility based on the selected subpage.
showTranscript() -- Boolean: Getter for the transcript visibility based on the selected subpage.
showNextBestAction() -- Boolean: Getter for the next best action visibility based on the selected subpage.
showSurveysSection() -- Boolean: Getter for the surveys visibility based on the selected subpage.
handleAddPhoneToList(): Handles the back to results event and updates the selected subpage.
prepareTextMessageReceiver(data): Prepares the person data to be added to the receivers list.
addToReceivers(data): Adds a person to the receivers list.
sendTextCampaign(data): Sends a text campaign to the selected person.
handleAssignPerson(): Handles the back to results event and updates the selected subpage.
handleCloseTextWindow(): Handles the back to results event and updates the selected subpage.
handlePersonSelect(): Handles the back to results event and updates the selected subpage.
handleCallPerson(): Handles call person event.
handleMessageSend(): Handles message send event.
selectedSubpage() -- String: Determines which subpage is currently selected.
selectedSubpage(value): Setter for the _selectedSubpage value.
connectedCallback(): Lifecycle hook that gets called when the component is inserted into the DOM.
smsFeatureAvailable() -- Boolean: Getter that determines if the Two Way SMS Feature is enabled.
getDisabledFeature() -- Boolean: Dummy method to return false for features that are not yet ready.
textMessagesButtonClass() -- String: Determines the class for the 'Text Messages' button.
transcriptButtonClass() -- String: Determines the class for the 'Transcript' button.
nextBestActionClass() -- String: Determines the class for the 'Next Best Action' button.
otherSectionClass() -- String: Determines the class for the 'Surveys' button.
handleClick() -- String: Determines the class for the 'Settings' button.
appSettings() -- Object: Getter for the app settings.
appSettings(value): Setter for the app settings.
userData() -- Object: Getter for the user data.
userData(value): Setter for the user data.
textMessagesConfigurated() -- Boolean: Getter for the text message configuration.
connectedCallback(): Lifecycle hook that gets called when the component is inserted into the DOM.
disconnectedCallback(): This method is triggered when the component is removed from the DOM.
selectedPerson(): Handles selecting a person from the list.
selectedPerson(value): Setter for the selected person.
receivers(): Getter for the list of receivers.
receivers(value): Setter for the list of receivers.
handleMessageSent(event): Handles the event to show the spinner.
handleChildCmpConnected(event): Updates the current component reference when a child component is connected.
handleChildCmpDisconnected(event): Handles the disconnection of child components, setting the property to undefined.
handlePersonSelect(event) -- void: Handles person selection.
handleLoadMessages(event) -- void: Handles the load more messages event.
hideMessageSpinner(): Handles the event to show the spinner.
handleCallPerson(): Handles calling a person.
handleCloseTextWindow(): Handles sending a text message to a person.
handleAddPhoneToList(): Handles sending a text message to a person.
receivers() -- Array: Getter for the list of receivers.
receivers(value): Setter for the list of receivers.
selectedPerson() -- Object: Getter for the selected person.
selectedPerson(value): Setter for the selected person.
connectedCallback(): Lifecycle hook that gets called when the component is inserted into the DOM.
disconnectedCallback(): This method is triggered when the component is removed from the DOM.
handlePersonClick(event): Handles the person click event.
getPersonItemClass(messageId) -- String: Determines the class for the person item.
isAdmin() -- Boolean: Getter for the admin status.
isAdmin(value): Setter for the admin status.
userData() -- Object: Getter for the user data.
userData(value): Setter for the user data.
appSettings() -- Object: Getter for the application settings.
appSettings(value): Setter for the application settings, updates call results based on the new settings.
decryptionKeyAvailable() -- Boolean: Getter for the decryption key field aviablity.
smsTwoWayFeatureAvailable() -- Boolean: Getter that determines if the user should see two way text messages settings.
handleSetValueForSelect() -- void: Handles the change event for the input fields.
textMessageProvider() -- Object: Getter for the text messages providers list.
textMessageProvider(value): Setter for the text messages providers list.
isProviderSelected() -- Boolean: Getter for the provider selected status.
handleProviderChange(event): Event handler for when the object type dropdown value changes. Clears and updates input fields based on the selected object type.
handleUpdateInputs(providerName): Updates the input fields based on the selected provider.
handleChange(event): Handles the change event for the input fields.
handleChangePhone(event): Handles the change event for the phone input field.
showUserToken() -- Boolean: Getter to determine if user token field should be displayed
showApiCredentials() -- Boolean: Getter to determine if API credentials should be displayed
saveSettings(event) -- void: Handles the click event for the save button.
saveTextMessageSettings(): Handles the click event for the save button.
saveGlobalSettings(): Saves the current settings by storing the selected objects and dispatches a close event.
handleInformParentTextMessagesSettings(): Dispatches an event to update parent component settings with the current text message settings.
handleUpdateParentSettings(): Dispatches an event to update parent component settings with the current application settings.
handleUpdatePhone(event): Handles the click event for the cancel button.
close(): Dispatches a close event to signal that the component should be closed.
prepareStartAnimation(event): Starts the animation on the given element.
prepareStopAnimation(event): Prepares the stop animation for the given event target.
userData() -- Object: Getter for the user data.
userData(value): Setter for the user data.
playCookie() -- String: Getter for the playCookie property.
playCookie(value): Setter for the playCookie property.
playsessionId() -- String: Getter for the playsessionId property.
playsessionId(value): Setter for the playsessionId property.
showCallButton() -- Boolean: Getter for the showCallButton property.
messages() -- Array: Getter for the messages property.
objectIconUrl() -- String: Getter for the userIconUrl property.
messages(value): Setter for the messages property.
selectedPerson() -- Object: Getter for the selectedPerson property.
selectedPerson(value): Setter for the selectedPerson property.
smsTwoWayFeatureAvailable() -- Boolean: Getter that determines if the user should see two way text messages.
scrollToBottom(): Scrolls to the bottom of the message history area.
connectedCallback(): Lifecycle hook that gets called when the component is inserted into the DOM.
disconnectedCallback(): This method is triggered when the component is removed from the DOM.
handlePhoneNumberChange(event): Handles the phone number change event.
handleAddPhoneToList(): Handles the add phone to list event.
charactersLeft() -- String: Handles the character left counter.
handleOnChangeText(event): Handles the message text change event.
messageInputValue() -- String: Getter for the messageInputValue property.
handleNameClick(): Handles the name click event.
handleSendMessage(data): Handles the send message event.
handleLoadMessages() -- void: Handles the load more messages event.
handleSendSingleMessage(): Sends a single message.
fetchFreshPersonDetailsBeforeSent(recordId) -- void: Fetches fresh person details before sending the message.
handleSendMessagesToCampaign(): Sends a message to a campaign.
handleUpdateCampaignMessages(): Updates the message history and task for a campaign.
fetchCampaignMembers(campaignId) -- Promise: Fetches the campaign members.
fetchQuickCampaignById(campaignId) -- Promise: Fetches the quick campaign associated with the selected campaign.
sendAndUpdateMessages(payload): Updates the message history and task.
handleInformParent(cookie, sessionId, refreshImmediately): Informs the parent component that a message has been sent.
handleTimestampClick(event) -- void: Handles the timestamp click event.
startSendingSpinnerTimeout(): Sets a timeout to hide the sending spinner after 30 seconds
startMessageSpinnerTimeout(): Sets a timeout to hide the message spinner after 30 seconds
hideSendingSpinner(): Handles hiding the sending spinner.
hideMessageSpinner(): Handles hiding the message spinner.
handleCloseWindow(): Handles the close window
handleCallClick(): Handles the call click event.
showError(message): Handles the error.
handleKeyDownMessenger(event): Handles the key down event.
handleKeyDownStartTextMsgFromInput(event): Handles the key down event for starting conversation.
handleKeyDownStartTextMsgFromNumber(event): Handles the key down event for starting conversation.
isToAddPopulated() -- Boolean: Getter that returns true if toAdd is populated.
isToRemovePopulated() -- Boolean: Getter that returns true if toRemove is populated.
handleConfirm() -- void: Dispatches a 'confirm' event to notify parent components or listeners.
handleClose(): Dispatches a 'close' event to notify parent components or listeners.
prepareStartAnimation(event): Starts the animation on the given element.
prepareStopAnimation(event): Prepares the stop animation for the given event target.

AddNewNumber

This module defines a Lightning Web Component for adding new phone numbers and associated records.

Requires: module:lwc, module:lightning/uiRecordApi, module:c/utils, module:c/constants, module:c/customLabelsUtils, module:lightning/platformResourceLoader, module:@salesforce/resourceUrl/Styles

AddNewNumber
- module.exports ÔçÉ LightningElement --
  - new module.exports()
  - .labels
  - .connectedCallback()
  - .handleShowAddNewNumberForm()
  - .handleShowLinkNumberForm()
  - .handleSelectCustomLookupRecord(event)
  - .handleObjectTypeChange(event)
  - .updateInputs()
  - .handleInput(event)
  - .linkRecord()
  - .isNumberValid() -- boolean
  - .sanitizeNumber(number) -- string
  - .addRecord()
  - .validateInputs() -- boolean
  - .prepareFields() -- Object
  - .handleSendRecordEvent(record)
  - .clearInputs()
  - .handleBack()
  - .close()
  - .prepareStartAnimation(event)
  - .prepareStopAnimation(event)

module.exports ÔçÉ `LightningElement` --

Kind: Exported class
Extends: LightningElement

new module.exports()

A class for adding new phone numbers and associated records like accounts, leads, and contacts. Provides UI interaction for choosing record types and input fields based on selection.

module.exports.labels

A proxy object for the labelsList which returns 'label_error' if a specific label is not found.

Kind: instance property of module.exports
Properties

Type
`Proxy`

module.exports.connectedCallback()

Lifecycle hook that gets called when the component is inserted into the DOM.

Kind: instance method of module.exports

module.exports.handleShowAddNewNumberForm()

Event handler for when the user clicks on the 'Create New Record' button. Shows the form picker to choose the record type.

Kind: instance method of module.exports

module.exports.handleShowLinkNumberForm()

Event handler for when the user clicks on the 'Link Existing Record' button. Shows the form picker to choose the record type.

Kind: instance method of module.exports

module.exports.handleSelectCustomLookupRecord(event)

Listens to the event of an custom lookup record being selected and updates the selected personId parameter.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event containing the selected custom lookup record details.

module.exports.handleObjectTypeChange(event)

Event handler for when the object type dropdown value changes. Clears and updates input fields based on the selected object type.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event object from the dropdown.

module.exports.updateInputs()

Updates visibility of input fields based on the selected object type. This helps in showing appropriate fields to the user for Account, Contact, or Lead.

Kind: instance method of module.exports

module.exports.handleInput(event)

Event handler for user input in any of the form fields. Updates the record object with the new value.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event object from the input field.

module.exports.linkRecord()

Links a record by updating its fields such as 'Phone' using the salesforce 'updateRecord' method, handles the response by triggering appropriate UI feedback and closing the current view.

Kind: instance method of module.exports

module.exports.isNumberValid() -- `boolean`

Validates a phone number against a specific pattern, ignoring whitespace and hyphens.

Kind: instance method of module.exports
Returns: boolean - - Whether the phone number is valid.

module.exports.sanitizeNumber(number) -- `string`

Removes all whitespace, hyphens, and parentheses from a phone number.

Kind: instance method of module.exports
Returns: string - - The sanitized phone number.

Param	Type	Description
number	`string`	The phone number to sanitize.

module.exports.addRecord()

Initiates the process to add a record in Salesforce, performs validations, and shows toast messages based on operation results.

Kind: instance method of module.exports

module.exports.validateInputs() -- `boolean`

Validates the inputs based on the selected object type to ensure necessary fields are filled before creating a record. If fields are missing, constructs an error message.

Kind: instance method of module.exports
Returns: boolean - - Returns true if validation is successful, false otherwise.

module.exports.prepareFields() -- `Object`

Prepares a fields object for creating a record based on the selected object type and current input values.

Kind: instance method of module.exports
Returns: Object - - An object containing field names as keys and user input values as values.

module.exports.handleSendRecordEvent(record)

Constructs a record object from the created Salesforce record and dispatches a 'recordcreated' event to notify parent components or listeners.

Kind: instance method of module.exports

Param	Type	Description
record	`Object`	The record object returned from Salesforce after a successful record creation.

module.exports.clearInputs()

Clears the input values in the record object. Useful to reset the form.

Kind: instance method of module.exports

module.exports.handleBack()

Clears the record values and handling back navigation.

Kind: instance method of module.exports

module.exports.close()

Dispatches a 'close' event to notify parent components or listeners and clears input fields.

Kind: instance method of module.exports

module.exports.prepareStartAnimation(event)

Prepares the start animation for the given event target.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event object.

module.exports.prepareStopAnimation(event)

Prepares the stop animation for the given event target.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event object.

AddNewTask

This module defines a Lightning Web Component for adding new tasks in the context of phone interactions.

Requires: module:lwc, module:@salesforce/apex/PhoneAppController.createTask, module:c/utils, module:c/constants, module:c/customLabelsUtils, module:lightning/platformResourceLoader, module:@salesforce/resourceUrl/Styles

AddNewTask
- module.exports ÔçÉ LightningElement --

module.exports ÔçÉ `LightningElement` --

Kind: Exported class
Extends: LightningElement

new module.exports()

A class for adding new tasks within the phone interactions environment. It interacts with the UI and Salesforce backend.

module.exports.dateAsString

Converts the activity date to a string format suitable for UI representation.

Kind: instance property of module.exports
Getter:

module.exports.labels

A proxy object for the labelsList which returns 'label_error' if a specific label is not found.

Kind: instance property of module.exports
Properties

Type
`Proxy`

module.exports.connectedCallback()

Lifecycle hook that gets called when the component is inserted into the DOM.

Kind: instance method of module.exports

module.exports.handleInputSubject(event)

Event handler that updates the task subject based on user input.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event object from the input field.

module.exports.handleInputDate(event)

Event handler that updates the activity date based on user input.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event object from the input field.

module.exports.handleCreateTask()

Initiates the creation of a new task in Salesforce, and handles success and error scenarios.

Kind: instance method of module.exports

module.exports.close()

Dispatches a 'close' event to notify parent components or listeners.

Kind: instance method of module.exports

module.exports.prepareStartAnimation(event)

Starts the animation on the given element.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event containing the current target to animate.

module.exports.prepareStopAnimation(event)

Prepares the stop animation for the given event target.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event object.

CallHistory

This module defines a Lightning Web Component for managing and interacting with the call history.

Requires: module:lwc, module:lightning/navigation, module:c/customLabelsUtils, module:lightning/platformResourceLoader, module:@salesforce/resourceUrl/Styles

CallHistory
- module.exports ÔçÉ NavigationMixin(LightningElement) --

module.exports ÔçÉ `NavigationMixin(LightningElement)` --

Kind: Exported class
Extends: NavigationMixin(LightningElement)

new module.exports()

A class responsible for displaying call history, managing click interactions on call subjects and names, and handling various associated events.

module.exports.labels

A proxy object for the labelsList which returns 'label_error' if a specific label is not found.

Kind: instance property of module.exports
Properties

Type
`Proxy`

module.exports.callHistory() -- `Object`

Getter for the call history.

Kind: instance method of module.exports
Returns: Object - The current call history.

module.exports.callHistory(value)

Setter for the history, updates call history parameter based on new value.

Kind: instance method of module.exports

Param	Type	Description
value	`Object`	The new call history.

module.exports.connectedCallback()

Lifecycle hook that gets called when the component is inserted into the DOM.

Kind: instance method of module.exports

module.exports.disconnectedCallback()

This method is triggered when the component is removed from the DOM.

Kind: instance method of module.exports

module.exports.handleSubjectClick(event)

Handles the click on the call subject and navigates to the associated Event record.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The click event object.

module.exports.handleNameClick(event)

Handles the click on the name and navigates to the associated record.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The click event object.

module.exports.handleCallRequest(event)

Dispatches an event to request a call based on the clicked call data.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The click event object.

module.exports.handleScroll(event)

Handles the scroll event in the calls section, checks if the user has scrolled sufficiently to request more history data.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The scroll event object.

module.exports.handleUpdateOffsetEvent()

Dispatches an event to update the offset for fetching more call history data.

Kind: instance method of module.exports

module.exports.handleUpdateFetchedFlag()

API method that allows external components to reset the fetched flag.

Kind: instance method of module.exports
Api:

CallingScreen

This module defines a Lightning Web Component for managing the user interface for both outgoing and incoming calls.

Requires: module:lwc, module:@salesforce/resourceUrl/call_icon, module:@salesforce/resourceUrl/call_icon_static, module:c/customLabelsUtils, module:lightning/platformResourceLoader, module:@salesforce/resourceUrl/Styles

CallingScreen
- module.exports ÔçÉ LightningElement --

module.exports ÔçÉ `LightningElement` --

Kind: Exported class
Extends: LightningElement

new module.exports()

A class responsible for displaying the calling screen, managing the user interactions for accepting or rejecting calls, and handling associated events.

module.exports.labels

A proxy object for the labelsList which returns 'label_error' if a specific label is not found.

Kind: instance property of module.exports
Properties

Type
`Proxy`

module.exports.connectedCallback()

Lifecycle hook that gets called when the component is inserted into the DOM.

Kind: instance method of module.exports

module.exports.handleAcceptCall()

Dispatches an event to notify that the call has been accepted.

Kind: instance method of module.exports

module.exports.handleRejectCall()

Dispatches an event to notify that the call has been rejected.

Kind: instance method of module.exports

module.exports.handleContactPicked(event)

Dispatches an event with the selected contact's data when a contact is picked.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The custom event containing details about the picked contact.

module.exports.handleUpdateResultsEvent(event)

Updates the search results and dispatches an event with the updated search results.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The custom event containing the updated search results.

module.exports.prepareStartAnimation(event)

Starts the animation on the given element.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event containing the current target to animate.

module.exports.prepareStopAnimation(event)

Stops the animation on the given element.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event containing the current target to stop animating.

SpinnerUtilities

This module defines utility functions for showing and hiding a spinner using the Lightning Message Service.

Requires: module:lightning/messageService, module:@salesforce/messageChannel/spinnerMessageChannel__c

SpinnerUtilities

SpinnerUtilities.showSpinner(messageContext)

Publishes a message to show the spinner.

Kind: static method of SpinnerUtilities

Param	Type	Description
messageContext	`MessageContext`	The context of the Lightning Message Service.

SpinnerUtilities.hideSpinner(messageContext)

Publishes a message to hide the spinner.

Kind: static method of SpinnerUtilities

Param	Type	Description
messageContext	`MessageContext`	The context of the Lightning Message Service.

SpinnerUtilities.triggerSidebarWindow(messageContext, method, person)

Publishes a message to trigger the sidebar window.

Kind: static method of SpinnerUtilities

Param	Type	Description
messageContext	`MessageContext`	The context of the Lightning Message Service.
method	`String`	The method to be called in the sidebar window.
person	`Object`	The person object to be passed to the sidebar window.

SpinnerUtilities.campaignDataUpdated(campaignId)

Publishes a CampaignDataUpdated__e event

Kind: static method of SpinnerUtilities

Param	Type	Description
campaignId	`String`	The ID of the campaign that was updated.

SpinnerUtilities.sendCustomNotification(recipientsIds, targetsIds, title, body)

Sends a custom notification to the specified recipients.

Kind: static method of SpinnerUtilities

Param	Type	Description
recipientsIds	`Array.<String>`	The IDs of the recipients of the notification.
targetsIds	`Array.<Strin>`	The IDs of the targets of the notification.
title	`String`	The title of the notification.
body	`String`	The body of the notification.

ContactInfo

This module defines a Lightning Web Component for displaying and managing contact information.

Requires: module:lwc, module:c/constants, module:c/customLabelsUtils, module:c/utils, module:lightning/platformResourceLoader, module:@salesforce/resourceUrl/Styles

ContactInfo
- module.exports ÔçÉ LightningElement --

module.exports ÔçÉ `LightningElement` --

Kind: Exported class
Extends: LightningElement

new module.exports()

A class for managing the display of contact information, initiating calls, and handling user interactions.

module.exports.contact

Gets the contact information.

Kind: instance property of module.exports
Getter:

module.exports.contact

Sets the contact information

Kind: instance property of module.exports
Setter:

Param	Type	Description
value	`Object`	The contact information.

module.exports.isSingleContact

Determines if only one contact is being displayed

Kind: instance property of module.exports
Getter:

module.exports.isSingleContact

Sets whether only one contact is being displayed

Kind: instance property of module.exports
Setter:

Param	Type	Description
value	`Boolean`	The single contact flag

module.exports.callInitiated

Determines if a call has been initiated

Kind: instance property of module.exports
Getter:

module.exports.callInitiated

Sets whether a call has been initiated

Kind: instance property of module.exports
Setter:

Param	Type	Description
value	`Boolean`	The call initiated flag

module.exports.callInProgress

Determines if a call is currently in progress

Kind: instance property of module.exports
Getter:

module.exports.callInProgress

Sets whether a call is currently in progress

Kind: instance property of module.exports
Setter:

Param	Type	Description
value	`Boolean`	The call in progress flag

module.exports.isEveythingLoaded

Checks if the contact information is loaded.

Kind: instance property of module.exports
Getter:

module.exports.showAddToCmpBtn

Checks if the contact is a lead or account or contact to show the 'Add to Campaign' button.

Kind: instance property of module.exports
Getter:

module.exports.disableCallButton

Checks if the contact phone is populated and return true if it's not to disable 'Call' button.

Kind: instance property of module.exports
Getter:

module.exports.disableMessageButton

Checks if the contact phone is populated and sms feature is enabled.

Kind: instance property of module.exports
Getter:

module.exports.labels

A proxy object for the labelsList which returns 'label_error' if a specific label is not found.

Kind: instance property of module.exports
Properties

Type
`Proxy`

module.exports.connectedCallback()

Lifecycle hook that gets called when the component is inserted into the DOM.

Kind: instance method of module.exports

module.exports.handleNameClick(event)

Handles a click on a name by navigating to its associated record page.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event triggering the navigation.

module.exports.handleCallRequest()

Dispatches an event to notify that a call request has been made.

Kind: instance method of module.exports

module.exports.handleBackToResults()

Dispatches an event to return to the list of contacts or search results.

Kind: instance method of module.exports

module.exports.handleAddPersonToCampaign(event)

Stops event propagation and dispatches a custom event to add a person to a campaign, using this.contact parameter.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event object, where the current target's dataset contains the person's details to be added.

module.exports.handleSendTextMessage(event)

Handles the call request from the displayed search results.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The call request event.

module.exports.handleShowSurveyWindow(event)

Handles the call request from the displayed search results.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The call request event.

CustomLookup

This module defines a Lightning Web Component for a custom lookup functionality in Salesforce.

Requires: module:lwc, module:@salesforce/apex/CustomLookupController.fetchRecords, module:@salesforce/apex/CustomLookupController.getObjectInfo, module:lightning/messageService, module:@salesforce/messageChannel/refreshPageMessageChannel__c, module:lightning/platformResourceLoader, module:@salesforce/resourceUrl/Styles, module:c/customLabelsUtils

CustomLookup
- module.exports ÔçÉ LightningElement --
  - new module.exports()
  - .labels
  - .objectApiName() -- Object
  - .objectApiName(value)
  - .objectsToAdditionalFields() -- Object
  - .objectsToAdditionalFields(value)
  - .connectedCallback()
  - .disconnectedCallback()
  - .handleSearchForRecord(recordId) -- void
  - .label()
  - .handleLoadSettings()
  - .handleGetObjectInfo()
  - .handleAssignObjectProperties()
  - .methodInput() -- Object
  - .handleChangeObject()
  - .handleDispatchEventObjectChange() -- void
  - .handleObjectSelect(event)
  - .showRecentRecords() -- boolean
  - .iconClass()
  - .fetchSobjectRecords(loadEvent)
  - .isValueSelected() -- boolean
  - .handleInputFocus(event)
  - .handleChange(event)
  - .handleDivClick()
  - .handleCancelSelect()
  - .handleAddNewRecord()
  - .handleRecordCreatedEvent(event)
  - .handleCloseNewRecordForm(event) -- boolean
  - .handleSelect(event)
  - .handleSelectedDispatchEvent()
  - .handleInputBlur(event)
  - .handleRefreshDetailPage()

module.exports ÔçÉ `LightningElement` --

Kind: Exported class
Extends: LightningElement

new module.exports()

A class for implementing a custom lookup functionality, fetching Salesforce records based on user input and allowing record selection.

module.exports.labels

A proxy object for the labelsList which returns 'label_error' if a specific label is not found.

Kind: instance property of module.exports
Properties

Type
`Proxy`

module.exports.objectApiName() -- `Object`

Getter for the objectApiName value.

Kind: instance method of module.exports
Returns: Object - The current objectApiName object.
Api:

module.exports.objectApiName(value)

Setter for the objectApiName value.

Kind: instance method of module.exports
Api:

Param	Type	Description
value	`Object`	The new objectApiName object.

module.exports.objectsToAdditionalFields() -- `Object`

Getter for the objectsToAdditionalFields value.

Kind: instance method of module.exports
Returns: Object - The current objectsToAdditionalFields object.
Api:

module.exports.objectsToAdditionalFields(value)

Setter for the objectsToAdditionalFields value.

Kind: instance method of module.exports
Api:

Param	Type	Description
value	`Object`	The new objectsToAdditionalFields object.

module.exports.connectedCallback()

Lifecycle hook that gets called when the component is inserted into the DOM.

Kind: instance method of module.exports

module.exports.disconnectedCallback()

This method is triggered when the component is removed from the DOM.

Kind: instance method of module.exports

module.exports.handleSearchForRecord(recordId) -- `void`

Handles the search for a record.

Kind: instance method of module.exports

Param	Type	Description
recordId	`String`	The ID of the record to search for.

module.exports.label()

Retrieves the user-friendly label for the associated object or UI element.

Kind: instance method of module.exports

module.exports.handleLoadSettings()

Loads settings and updates the styles for the phone app.

Kind: instance method of module.exports

module.exports.handleGetObjectInfo()

Handles the retrieval of information about the provided object names from the backend.

Kind: instance method of module.exports

module.exports.handleAssignObjectProperties()

Assigns properties to the 'whatObject' based on the matched option from the list of object options.

Kind: instance method of module.exports

module.exports.methodInput() -- `Object`

Constructs an input object for fetching sObject records.

Kind: instance method of module.exports
Returns: Object - An object containing necessary properties for the fetch operation: objectApiName, nameField, additionalField, searchString, and selectedRecordId.

module.exports.handleChangeObject()

Toggles the visibility of the object dropdown and resets some properties related to record selection.

Kind: instance method of module.exports

module.exports.handleDispatchEventObjectChange() -- `void`

Dispatches an event to the parent component with information about the object change.

Kind: instance method of module.exports

module.exports.handleObjectSelect(event)

Handles the selection of an object from the dropdown list, updates the properties of 'whatObject', and updates the settings object.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event containing the details of the selected object.

module.exports.showRecentRecords() -- `boolean`

Determines if there should be dropdown shown.

Kind: instance method of module.exports
Returns: boolean - Returns true if there are any records in the list, otherwise false.

module.exports.iconClass()

Returns the appropriate icon class or icon name for a given Salesforce object API name.

Kind: instance method of module.exports

module.exports.fetchSobjectRecords(loadEvent)

Fetches Sobject records based on the provided method input.

Kind: instance method of module.exports

Param	Type	Description
loadEvent	`boolean`	Whether the fetch is triggered by a load event or not.

module.exports.isValueSelected() -- `boolean`

Determines if a value has been selected and the lookup is not disabled.

Kind: instance method of module.exports
Returns: boolean - Returns true if a value has been selected and lookup is enabled, otherwise false.

module.exports.handleInputFocus(event)

Reacts to changes in the input field, fetching Sobject records if the search string length exceeds 2 characters.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The input event containing the current search string.

module.exports.handleChange(event)

Reacts to changes in the input field, fetching Sobject records if the search string length exceeds 2 characters.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The input event containing the current search string.

module.exports.handleDivClick()

Handles click events on the DIV element surrounding the search panel to ensure the panel does not close unexpectedly.

Kind: instance method of module.exports

module.exports.handleCancelSelect()

Resets the selected record details and dispatches a 'valueselected' event without a value, indicating the value has been cleared.

Kind: instance method of module.exports

module.exports.handleAddNewRecord()

Handles click add new record button, showing the new record form and clearing the records list.

Kind: instance method of module.exports

module.exports.handleRecordCreatedEvent(event)

Processes the creation of a new record and updates the calling person's details.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event containing details of the created record.

module.exports.handleCloseNewRecordForm(event) -- `boolean`

Handles the closing of the new record form.

Kind: instance method of module.exports
Returns: boolean - Returns true if the record was created successfully, otherwise false.

Param	Type	Description
event	`Event`	The event containing details of the created record.

module.exports.handleSelect(event)

Handles the selection of a record from the list, setting the selected record ID and name, clearing the list, and dispatching an event.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event containing the details of the selected record.

module.exports.handleSelectedDispatchEvent()

Dispatches an event indicating a record has been selected.

Kind: instance method of module.exports

module.exports.handleInputBlur(event)

Handles the loss of focus on the input field, clearing the records list after a delay if necessary.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The blur event.

module.exports.handleRefreshDetailPage()

Publishes a message to refresh the detail page.

Kind: instance method of module.exports
Api:

CustomLookupNewRecord

This module defines a Lightning Web Component for creating new records with custom lookup functionality.

Requires: module:lwc, module:@salesforce/apex/CustomLookupController.getPicklistValues, module:lightning/uiRecordApi, module:c/customLabelsUtils, module:c/utils, module:c/constants, module:lightning/platformResourceLoader, module:@salesforce/resourceUrl/Styles

DhoneCallScreenExitScreen

This module defines a Lightning Web Component that provides an interface for either staying on or exiting the phone call screen.

Requires: module:lwc, module:c/customLabelsUtils, module:lightning/platformResourceLoader, module:@salesforce/resourceUrl/Styles

DhoneCallScreenExitScreen
- module.exports ÔçÉ LightningElement --

module.exports ÔçÉ `LightningElement` --

Kind: Exported class
Extends: LightningElement

new module.exports()

A class that handles user interactions for staying on or exiting the phone call screen. It provides methods to handle both actions and uses custom styles for the component.

module.exports.labels

Proxy wrapper for the labelsList, providing a fallback label in case the requested label is missing.

Kind: instance property of module.exports

module.exports.connectedCallback()

Lifecycle hook that gets called when the component is inserted into the DOM.

Kind: instance method of module.exports

module.exports.handleCancel()

Dispatches an event to indicate the user's desire to stay on the phone call screen.

Kind: instance method of module.exports

module.exports.handleDelete()

Dispatches an event to indicate the user's desire to exit the phone call screen.

Kind: instance method of module.exports

DialPadSlider

This module defines a Lightning Web Component for a dial pad slider in Salesforce.

Requires: module:lwc, module:@salesforce/resourceUrl/erease_icon, module:c/customLabelsUtils

DialPadSlider
- module.exports ÔçÉ LightningElement --

module.exports ÔçÉ `LightningElement` --

Kind: Exported class
Extends: LightningElement

new module.exports()

A class for implementing a dial pad slider with buttons and managing user interactions, allowing users to click and generate dial inputs.

module.exports.labels

Provides a proxy for label list, defaulting to 'label_error' if a specific label is not found.

Kind: instance property of module.exports

module.exports.disconnectedCallback()

This method is triggered when the component is removed from the DOM.

Kind: instance method of module.exports

module.exports.handleDialButtonClick(event)

Handles the click event on the dial buttons, updating the search value and dispatching the change input event.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The click event from the dial button.

module.exports.handleKeyUp(event)

Handles keyup events on the input field, updating the search value and sending DTMF signals.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The keyup event from the input field.

module.exports.scrollToCursor(inputElement)

Scrolls the input element to ensure that the cursor is visible.

Kind: instance method of module.exports

Param	Type	Description
inputElement	`HTMLElement`	The HTML input element in which the cursor needs to be visible. This method calculates the cursor's position within the element and adjusts the scroll if the cursor is not in the visible area.

module.exports.handleEraseInput()

Erases the last character from the search input and sets focus on the input.

Kind: instance method of module.exports

module.exports.focusOnInput()

Sets focus on the search input field.

Kind: instance method of module.exports

module.exports.handleSendDTMFEvent()

Dispatches an event indicating a dial button has been clicked and DTMF was triggered.

Kind: instance method of module.exports

module.exports.handleDialButtonClickEvent()

Dispatches an event indicating a dial button has been clicked and the input has changed.

Kind: instance method of module.exports

featureUtils

This module provides utility functions for managing feature flags in LWC components

featureUtils
- .initFeatures(setup)
- .handleCheckFeature(featureName) -- boolean
- .handleThrowCustomException(message)

featureUtils.initFeatures(setup)

Initializes the feature configuration with setup data

Kind: static method of featureUtils

Param	Type	Description
setup	`object`	The setup object containing feature flags

featureUtils.handleCheckFeature(featureName) -- `boolean`

Checks if a specific feature is enabled

Kind: static method of featureUtils
Returns: boolean - - Whether the feature is enabled

Param	Type	Description
featureName	`string`	The name of the feature to check

featureUtils.handleThrowCustomException(message)

Throws a custom exception with the provided message

Kind: static method of featureUtils

Param	Type	Description
message	`string`	The error message

FooterMenu

This module defines a Lightning Web Component for a footer menu in Salesforce.

Requires: module:lwc, module:c/utils, module:c/customLabelsUtils

FooterMenu
- module.exports ÔçÉ LightningElement --
  - new module.exports()
  - .labels
  - .connectedCallback()
  - .hasNewHistory() -- boolean
  - .disableCallButton() -- boolean
  - .disableCallButton(value)
  - .historyCounter() -- string
  - .animateCallButton()
  - .handleDialPad()
  - .handleCallRequestEvent(event)
  - .handleShowHomePanelEvent()
  - .handleToggleDialPad()
  - .prepareStartAnimation(event)
  - .prepareStopAnimation(event)

module.exports ÔçÉ `LightningElement` --

Kind: Exported class
Extends: LightningElement

new module.exports()

A class for implementing a footer menu with various icons and functionalities, allowing users to interact with the dial pad, history, home, and call features.

module.exports.labels

A proxy object for the labelsList which returns 'label_error' if a specific label is not found.

Kind: instance property of module.exports
Properties

Type
`Proxy`

module.exports.connectedCallback()

Lifecycle hook that gets called when the component is inserted into the DOM.

Kind: instance method of module.exports

module.exports.hasNewHistory() -- `boolean`

Checks if there's any new call history.

Kind: instance method of module.exports
Returns: boolean - Returns true if there's new call history.

module.exports.disableCallButton() -- `boolean`

Returns the status of the call button's disabled state.

Kind: instance method of module.exports
Returns: boolean - If true, the call button is disabled.

module.exports.disableCallButton(value)

Sets the status of the call button's disabled state and triggers its animation.

Kind: instance method of module.exports

Param	Type	Description
value	`boolean`	The value to set for the call button's disabled state.

module.exports.historyCounter() -- `string`

Retrieves the history counter.

Kind: instance method of module.exports
Returns: string - Returns the history counter, maxed out at '20+' if it's more than 20.

module.exports.animateCallButton()

Triggers the animation for the call button based on its state.

Kind: instance method of module.exports

module.exports.handleDialPad()

Handles the click on the dial pad and dispatches a 'showdialpad' event.

Kind: instance method of module.exports

module.exports.handleCallRequestEvent(event)

Handles the call request event based on the state of the call button.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The triggered event.

module.exports.handleShowHomePanelEvent()

Handles the click on the home icon and dispatches a 'showhomepanel' event.

Kind: instance method of module.exports

module.exports.handleToggleDialPad()

Toggles the dial pad and dispatches a 'toggledialpad' event.

Kind: instance method of module.exports

module.exports.prepareStartAnimation(event)

Starts the animation on the given element.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event containing the current target to animate.

module.exports.prepareStopAnimation(event)

Stops the animation on the given element.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event containing the current target to stop animating.

HomeScreen

This module defines a Lightning Web Component for the home screen of the phone app.

Requires: module:lwc, module:lightning/navigation, module:@salesforce/apex, module:lightning/messageService, module:c/communicationUtils, module:c/utils, module:@salesforce/messageChannel/refreshPageMessageChannel__c, module:@salesforce/apex/PhoneAppController.getAssignedTasks, module:@salesforce/apex/PhoneAppController.getAssignedTasksFresh, module:c/customLabelsUtils, module:lightning/platformResourceLoader, module:@salesforce/resourceUrl/Styles

HomeScreen
- module.exports ÔçÉ NavigationMixin --
  - new module.exports()
  - .labels
  - .userData() -- Object
  - .userData(value)
  - .connectedCallback()
  - .disconnectedCallback()
  - .showNoCalls() -- boolean
  - .handleSetInterval()
  - .sendHideSpinnerMessage()
  - .wiredTasks()
  - .handleLoadMoreResults()
  - .formatDateTime(dateTimeValue) -- string
  - .assignTaskToList(task)
  - .updateTaskStatuses()
  - .isOverdue(dateTime) -- boolean
  - .handleSubjectClick(event)
  - .handleNameClick(event)
  - .handleCallRequest(event)
  - .handleRefreshTaskList() -- Promise.<void>
  - .handleRefreshDetailPage()

module.exports ÔçÉ `NavigationMixin` --

Kind: Exported class
Extends: NavigationMixin

new module.exports()

A class for managing the home screen of the phone app, displaying upcoming, overdue, and all calls. It also handles user interactions like loading more results and updates the task statuses in real-time.

module.exports.labels

A proxy for handling labels and providing a default label if a label is not found.

Kind: instance property of module.exports

module.exports.userData() -- `Object`

Getter for the user data.

Kind: instance method of module.exports
Returns: Object - The current user data.

module.exports.userData(value)

Setter for the user data.

Kind: instance method of module.exports
Api:

Param	Type	Description
value	`Object`	The new user data.

module.exports.connectedCallback()

Lifecycle hook that gets called when the component is inserted into the DOM.

Kind: instance method of module.exports

module.exports.disconnectedCallback()

This method is triggered when the component is removed from the DOM.

Kind: instance method of module.exports

module.exports.showNoCalls() -- `boolean`

Determines if there should be no calls section displayed.

Kind: instance method of module.exports
Returns: boolean - Returns true if there are any records in the list, otherwise false.

module.exports.handleSetInterval()

Sets intervals to update the task statuses every minute.

Kind: instance method of module.exports

module.exports.sendHideSpinnerMessage()

Sends a message to hide the spinner using the message context.

Kind: instance method of module.exports

module.exports.wiredTasks()

Retrieves the assigned tasks based on the user's ID and current offset.

Kind: instance method of module.exports
Wire:

module.exports.handleLoadMoreResults()

Handles the "Load More" button interaction to load more tasks.

Kind: instance method of module.exports

module.exports.formatDateTime(dateTimeValue) -- `string`

Formats a date-time value into a specific string representation.

Kind: instance method of module.exports
Returns: string - The formatted date-time string.

Param	Type	Description
dateTimeValue	`string`	The date-time value to format.

module.exports.assignTaskToList(task)

Assigns a task to its respective list based on its timing relative to the current time.

Kind: instance method of module.exports

Param	Type	Description
task	`Object`	The task to be assigned.

module.exports.updateTaskStatuses()

Updates the statuses of tasks by re-assigning them to their respective categories.

Kind: instance method of module.exports

module.exports.isOverdue(dateTime) -- `boolean`

Determines if a given date-time value represents an overdue time.

Kind: instance method of module.exports
Returns: boolean - True if the given date-time is overdue, false otherwise.

Param	Type	Description
dateTime	`string`	The date-time value to check.

module.exports.handleSubjectClick(event)

Handles a click on a task subject by navigating to its record page.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event triggering the navigation.

module.exports.handleNameClick(event)

Handles a click on a name by navigating to its associated record page.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event triggering the navigation.

module.exports.handleCallRequest(event)

Handles a call request event.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event containing the call data.

module.exports.handleRefreshTaskList() -- `Promise.<void>`

Refreshes the task list by re-fetching the tasks and updating their statuses. Also refreshes the detail page.

Kind: instance method of module.exports
Returns: Promise.<void> - Represents the completion of an asynchronous operation.
Api:

module.exports.handleRefreshDetailPage()

Publishes a message to refresh the detail page.

Kind: instance method of module.exports
Api:

PhoneApp

This module defines a Lightning Web Component for the main phone application interface.

Requires: module:lwc, module:lightning/uiRecordApi, module:lightning/messageService, module:@salesforce/apex/PhoneAppController.getUserData, module:@salesforce/apex/PhoneAppController.logCall, module:@salesforce/apex/PhoneAppController.handleSearchPhoneNumber, module:c/constants, module:c/utils, module:c/settingsConstants, module:c/customLabelsUtils, module:@salesforce/messageChannel/spinnerMessageChannel__c, module:@salesforce/messageChannel/callToRecordMessageChannel__c, module:lightning/platformResourceLoader, module:@salesforce/resourceUrl/Styles

PhoneApp
- module.exports ÔçÉ LightningElement --

module.exports ÔçÉ `LightningElement` --

Kind: Exported class
Extends: LightningElement

new module.exports()

A class for managing the main phone application interface, controlling the user interface, handling phone interactions, managing the call state, and handling other user interactions such as changing settings.

module.exports.readyToUse -- `boolean`

Determines if the application is ready to use based on whether WebSocket is populated and user is registered.

Kind: instance property of module.exports
Returns: boolean - True if the app is ready to use; false otherwise.
Getter:

module.exports.dataFetched -- `boolean`

Determines if necessary data has been fetched.

Kind: instance property of module.exports
Returns: boolean - True if data has been fetched; false otherwise.
Getter:

module.exports.labels

A proxy object for the labelsList which returns 'label_error' if a specific label is not found.

Kind: instance property of module.exports
Properties

Type
`Proxy`

module.exports.connectedCallback()

Lifecycle hook that gets called when the component is inserted into the DOM.

Kind: instance method of module.exports

module.exports.disconnectedCallback()

Lifecycle hook that gets called when the component is removed from the DOM. Removes event listeners to prevent memory leaks.

Kind: instance method of module.exports

module.exports.sidebarAvailable() -- `void`

Side panel availability getter.

Kind: instance method of module.exports

module.exports.handleLoadUrls() -- `void`

Loads the URLs for the iframe.

Kind: instance method of module.exports

module.exports.generateSessionId() -- `string`

Generates a unique session ID.

Kind: instance method of module.exports
Returns: string - A unique session ID.

module.exports.handleAddWindowListeners()

Adds event listeners to the window object.

Kind: instance method of module.exports

module.exports.handleRemoveWindowListeners()

Removes event listeners from the window object to prevent memory leaks.

Kind: instance method of module.exports

module.exports.handleCTIMessage(event)

Handles messages received from the CTI adapter.

Kind: instance method of module.exports

Param	Type	Description
event	`MessageEvent`	The message event containing the data.

module.exports.handleLoadDevices() -- `void`

Fetches the list of available devices and assigns the default devices.

Kind: instance method of module.exports

module.exports.handleReorderDevices() -- `void`

Reorders the list of devices based on the default devices.

Kind: instance method of module.exports

module.exports.handleUpdateDevicesSettings(event) -- `void`

Handles the event when the user settings are updated.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event containing the updated settings.

module.exports.handleGetQuakkerAppSettings()

Fetches the application settings from the Quakker app and updates the local state.

Kind: instance method of module.exports

module.exports.handleIsUserAdmin()

Determines if the current user has admin privileges and updates the isAdmin state.

Kind: instance method of module.exports

module.exports.handleResize()

Handles window resizing and updates app settings accordingly.

Kind: instance method of module.exports

module.exports.handleSettingsChanged(event)

Handles changes in settings from user interactions or other components.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event containing the updated settings.

module.exports.handleUpdateAgentNumber(event)

Handles changes in the agent number from user interactions or other components.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event containing the updated agent number.

module.exports.updateDocumentStyles()

Updates document styles based on the application settings, particularly for call results.

Kind: instance method of module.exports

module.exports.handleSettingsUpdate()

Updates the settings based on the current viewport size.

Kind: instance method of module.exports

module.exports.handleGlobalStylesUpdate()

Updates global styles for the application based on the settings.

Kind: instance method of module.exports

module.exports.changeAgentStatusAura(statusName) -- `void`

Changes the agent status in the SIP library.

Kind: instance method of module.exports
Api:

Param	Type	Description
statusName	`string`	The name of the status to change to.

module.exports.handleSpinnerMessage(message)

Handles messages related to displaying or hiding the spinner.

Kind: instance method of module.exports

Param	Type	Description
message	`Object`	The message containing spinner visibility data.

module.exports.handleChildCmpConnected(event)

Updates the current component reference when a child component is connected.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event containing the child component's reference.

module.exports.handleChildCmpDisconnected(event)

Handles the disconnection of child components, setting the property to undefined.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event object.

module.exports.handleNavigateToNextEvent(event)

Navigates to the next event when a call is completed.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event containing the navigation details.

module.exports.handleCallRequestEvent(event)

Initiates a call when a call request is received.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event containing the phone number for the call.

module.exports.handleCallPerson()

Initiates a call when a call request is received.

Kind: instance method of module.exports

module.exports.handleTextCampaignEvent(event)

Initiates a call when a call request is received.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event containing the phone number for the call.

module.exports.handleTextMessageEvent(event)

Initiates a call when a call request is received.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event containing the phone number for the call.

module.exports.handleTerminateCallEvent()

Terminates the current call.

Kind: instance method of module.exports

module.exports.handleHoldCallEvent()

Puts the current call on hold.

Kind: instance method of module.exports

module.exports.handleUnholdCallEvent()

Resumes the call that was previously on hold.

Kind: instance method of module.exports

module.exports.handleMuteCallEvent()

Mutes the current active call.

Kind: instance method of module.exports

module.exports.handleUnmuteCallEvent()

Unmutes the current muted call.

Kind: instance method of module.exports

module.exports.handleDtmfEvent(event)

Handles DTMF (Dual-Tone Multi-Frequency) signals sent during a call.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event containing the DTMF signal data.

module.exports.handleAcceptCallEvent()

Accepts an incoming call event by invoking the appropriate SIP library method.

Kind: instance method of module.exports

module.exports.handleRequestStatusChangeEvent(event)

Handles agent status change requests by invoking the appropriate SIP library method.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event triggering the status change request.

module.exports.handleLogoutAgent()

Handles agent logout by invoking the appropriate SIP library method.

Kind: instance method of module.exports

module.exports.handleMissedCallEvent(event)

Handles missed call events.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event containing the missed call details.

module.exports.handleStatusChangeEvent(event)

Handles agent status change events.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event containing the updated agent status.

module.exports.handleNewSessionEvent(event)

Handles new session events.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event containing the new session details.

module.exports.handleSessionStateEvent(event)

Handles session state change events.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event containing the session state details.

module.exports.handleShowQuakkerUtilityEvent()

Handles the show Quakker utility event.

Kind: instance method of module.exports

module.exports.handleCampaignUpdate(campaignId, callingPersonId)

Calls the updateCampaignRecord function with the campaign ID, calling person ID, and new status. Displays a toast message to indicate success or failure of the update operation.

Kind: instance method of module.exports

Param	Type	Description
campaignId	`String`	The ID of the campaign to update.
callingPersonId	`String`	The ID of the person who is calling.

module.exports.handleSendShowQuakkerUtilityEvent(message)

Notifies the parent component about the click-to-dial event.

Kind: instance method of module.exports

Param	Type	Description
message	`Object`	The message containing the click-to-dial data.

module.exports.handleClickToCall(message)

Handles click-to-call messages.

Kind: instance method of module.exports

Param	Type	Description
message	`Object`	The message containing the click-to-call data.

module.exports.handleCallingCampaignEnded()

Handles the event when the calling campaign ends.

Kind: instance method of module.exports

module.exports.search(searchKey, event)

Searches for a person based on a phone number key and handles logging of the call.

Kind: instance method of module.exports

Param	Type	Description
searchKey	`string`	The phone number to search.
event	`Event`	The event containing the call details.

module.exports.wiredUser(data, error)

Retrieves user data and populates it into the component.

Kind: instance method of module.exports
Wire:

Param	Type	Description
data	`Object`	The user data.
error	`Object`	Any error that occurred during data retrieval.

module.exports.createGloabalSettingRecord() -- `Promise.<void>`

Creates a global setting record for the Quakker app.

Kind: instance method of module.exports
Returns: Promise.<void> - Represents the completion of an asynchronous operation.

module.exports.handleUpdateUserSettings()

Updates the user settings in the database.

Kind: instance method of module.exports

module.exports.handleCredentialsProvided(event)

Handles the event when SIP credentials are provided.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event containing the provided SIP credentials and websocket.

module.exports.handleRegistrationStatusEvent(event)

Listens for registration status events and performs appropriate actions.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event containing the status of the SIP registration.

module.exports.updateUserRecord() -- `Promise.<void>`

Updates the user record with SIP credentials.

Kind: instance method of module.exports
Returns: Promise.<void> - Represents the completion of an asynchronous operation.

module.exports.handleLogout()

Logs out the agent, clears the SIP credentials and updates the user record.

Kind: instance method of module.exports

module.exports.handleLogCall(event)

Handles logging of calls.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event containing details of the call to be logged.

module.exports.handleMinimize() -- `void`

Handles the event when the user clicks the minimize button.

Kind: instance method of module.exports

PhoneAppSettings

This module defines a Lightning Web Component for handling phone app settings.

Requires: module:lwc, module:c/customLabelsUtils, module:c/utils, module:lightning/messageService, module:c/communicationUtils, module:@salesforce/resourceUrl/close_icon, module:@salesforce/resourceUrl/close_icon_static, module:@salesforce/resourceUrl/exit_icon, module:@salesforce/resourceUrl/exit_icon_static, module:lightning/platformResourceLoader, module:@salesforce/resourceUrl/Styles

module.exports ÔçÉ `LightningElement` --

Kind: Exported class
Extends: LightningElement

PhoneCallScreen

This module defines a Lightning Web Component for managing the phone call screen.

Requires: module:lwc, module:c/utils, module:c/constants, module:lightning/messageService, module:c/communicationUtils, module:@salesforce/resourceUrl/call_icon_static, module:@salesforce/resourceUrl/exit_icon, module:@salesforce/resourceUrl/addtask_icon, module:@salesforce/resourceUrl/addtask_icon_static, module:@salesforce/resourceUrl/addnumber_icon, module:@salesforce/resourceUrl/addnumber_icon_static, module:@salesforce/resourceUrl/dialpad_icon, module:@salesforce/resourceUrl/dialpad_icon_static, module:c/customLabelsUtils, module:@salesforce/apex/PhoneAppController.logCall, module:lightning/platformResourceLoader, module:@salesforce/resourceUrl/Styles

PhoneCallScreen
- .callingPerson
- .callingPerson
- .isSingleContact
- .isSingleContact
- .callInitiated
- .callInitiated
- .callInProgress
- .callInProgress
- .disableTaskBtn -- boolean
- .disableInputs -- boolean
- .disableWhatIdLookup -- boolean
- .holdButtonLabel -- string
- .muteButtonLabel -- string
- .noteInputValue -- string
- .labels
- .selectedCampaign() -- Object
- .selectedCampaign(value)
- .appSettings() -- Object
- .appSettings(value)
- .phoneNumber() -- string
- .phoneNumber(value)
- .connectedCallback()
- .disconnectedCallback()
- .beforeUnloadHandler(event) -- void
- .handleNewSessionEvent(event) -- void
- .handleCustomLookupSet() -- void
- .handleFetchRelatedRecords(event) -- void
- .campaignMembersStatusesResults(param0)
- .handleChildCmpConnected(event)
- .handleChildCmpDisconnected(event)
- .handleContactPicked(event)
- .handleShowDialpad()
- .handleSendDTMFEvent(event)
- .handleLoadTimerClass()
- .handleLoadHoldButtonClass()
- .handleLoadMuteButtonClass()
- .handleLoadDialpadButtonClass()
- .handleTerminateCall()
- .changeTimerManually()
- .handleTimer(status) -- void
- .handleUpdateCampaign(status) -- void
- .disableCallNext() -- boolean
- .handleCallNextBtnClick() -- void
- .resetAllButtons()
- .startTimer()
- .pauseTimer()
- .toggleAddNumber()
- .toggleStatusScreen()
- .handleNewTaskClick()
- .toggleNewTask()
- .handleSelectedWhatId(event)
- .handleCallResultChange(event)
- .handleUpdateCampaignItemEvent(status, endInteraction) -- void
- .handleButtonStyleChange(buttonName)
- .handleLoadClass(elementName)
- .handleHold()
- .handleMute()
- .handleTerminateCallEvent()
- .handleRecordCreatedEvent(event)
- .handleConfirmStatus(event) -- void
- .handleUpdateCampaignMemberStatus(status) -- void
- .handleCancelMultipleRecords() -- void
- .handleUpdateQuickCampaign() -- void
- .resetVariables()
- .handleOnChangeNote(event)
- .handleSaveMultipleTasks(event) -- void
- .handleSkipSaveMultipleTasks() -- void
- .handleLogCall()
- .handleNavigateToNextBtnClicked() -- void
- .handleExitEvent()
- .handleStayEvent()
- .handleCancelStatus()
- .handleClosePhoneCallScreenEvent()
- .handleExit()
- .prepareStartAnimation(event)
- .prepareStopAnimation(event)

phoneCallScreen.callingPerson

Gets the contact information.

Kind: instance property of PhoneCallScreen
Getter:

phoneCallScreen.callingPerson

Sets the contact information

Kind: instance property of PhoneCallScreen
Setter:

Param	Type	Description
value	`Object`	The contact information.

phoneCallScreen.isSingleContact

Determines if only one contact is being displayed

Kind: instance property of PhoneCallScreen
Getter:

phoneCallScreen.isSingleContact

Sets whether only one contact is being displayed

Kind: instance property of PhoneCallScreen
Setter:

Param	Type	Description
value	`Boolean`	The single contact flag

phoneCallScreen.callInitiated

Determines if a call has been initiated

Kind: instance property of PhoneCallScreen
Getter:

phoneCallScreen.callInitiated

Sets whether a call has been initiated

Kind: instance property of PhoneCallScreen
Setter:

Param	Type	Description
value	`Boolean`	The call initiated flag

phoneCallScreen.callInProgress

Determines if a call is currently in progress

Kind: instance property of PhoneCallScreen
Getter:

phoneCallScreen.callInProgress

Sets whether a call is currently in progress

Kind: instance property of PhoneCallScreen
Setter:

Param	Type	Description
value	`Boolean`	The call in progress flag

phoneCallScreen.disableTaskBtn -- `boolean`

Determines if the task button should be disabled.

Kind: instance property of PhoneCallScreen
Returns: boolean - True if the button should be disabled, false otherwise.
Getter:

phoneCallScreen.disableInputs -- `boolean`

Determines if the inputs should be disabled.

Kind: instance property of PhoneCallScreen
Returns: boolean - True if the inputs should be disabled, false otherwise.
Getter:

phoneCallScreen.disableWhatIdLookup -- `boolean`

Determines if the WhatId functionality should be disabled.

Kind: instance property of PhoneCallScreen
Returns: boolean - True if WhatId functionality should be disabled, false otherwise.
Getter:

phoneCallScreen.holdButtonLabel -- `string`

Defines which label to show on the hold button.

Kind: instance property of PhoneCallScreen
Returns: string - The label to show on the hold button.
Getter:

phoneCallScreen.muteButtonLabel -- `string`

Defines which label to show on the mute button.

Kind: instance property of PhoneCallScreen
Returns: string - The label to show on the mute button.
Getter:

phoneCallScreen.noteInputValue -- `string`

Retrieves the current value of the note input.

Kind: instance property of PhoneCallScreen
Returns: string - The current value of the note input.
Getter:

phoneCallScreen.labels

A proxy for label list which returns a default error label if a specific label is not found.

Kind: instance property of PhoneCallScreen

phoneCallScreen.selectedCampaign() -- `Object`

Getter for the selectedCampaign value.

Kind: instance method of PhoneCallScreen
Returns: Object - The current selectedCampaign object.
Api:

phoneCallScreen.selectedCampaign(value)

Setter for the selectedCampaign value.

Kind: instance method of PhoneCallScreen
Api:

Param	Type	Description
value	`Object`	The new selectedCampaign object.

phoneCallScreen.appSettings() -- `Object`

Getter for the application settings.

Kind: instance method of PhoneCallScreen
Returns: Object - The current application settings.

phoneCallScreen.appSettings(value)

Setter for the application settings, updates call results based on the new settings.

Kind: instance method of PhoneCallScreen

Param	Type	Description
value	`Object`	The new application settings.

phoneCallScreen.phoneNumber() -- `string`

Getter for the phoneNumber value.

Kind: instance method of PhoneCallScreen
Returns: string - The current phoneNumber value.

phoneCallScreen.phoneNumber(value)

Setter for the phoneNumber value.

Kind: instance method of PhoneCallScreen

Param	Type	Description
value	`string`	The new phoneNumber value.

phoneCallScreen.connectedCallback()

Lifecycle hook that gets called when the component is inserted into the DOM.

Kind: instance method of PhoneCallScreen

phoneCallScreen.disconnectedCallback()

This method is triggered when the component is removed from the DOM.

Kind: instance method of PhoneCallScreen

phoneCallScreen.beforeUnloadHandler(event) -- `void`

Unloads the event listener for the beforeunload event.

Kind: instance method of PhoneCallScreen

Param	Type	Description
event	`Event`	The event object.

phoneCallScreen.handleNewSessionEvent(event) -- `void`

Handles the event of a new session being initiated.

Kind: instance method of PhoneCallScreen

Param	Type	Description
event	`Event`	The event containing the details of the new session.

phoneCallScreen.handleCustomLookupSet() -- `void`

Sets the custom lookup objects based on the selected campaign.

Kind: instance method of PhoneCallScreen

phoneCallScreen.handleFetchRelatedRecords(event) -- `void`

Handles the event of a new record being selected and updates the selected record.

Kind: instance method of PhoneCallScreen

Param	Type	Description
event	`Event`	The event containing the selected record's details.

phoneCallScreen.campaignMembersStatusesResults(param0)

Handles the result of the getPicklistValues wire adapter for campaign member statuses.

Kind: instance method of PhoneCallScreen

Param	Type	Description
param0	`object`	The result object containing error and data properties.
param0.error	`Error`	The error object if an error occurred during the wire adapter call.
param0.data	`object`	The data object containing the picklist values.

phoneCallScreen.handleChildCmpConnected(event)

Listens to child component's connected event and initializes the corresponding variable.

Kind: instance method of PhoneCallScreen

Param	Type	Description
event	`Event`	The event containing details of the connected child component.

phoneCallScreen.handleChildCmpDisconnected(event)

Handles the disconnection of child components, setting the property to undefined.

Kind: instance method of PhoneCallScreen

Param	Type	Description
event	`Event`	The event object.

phoneCallScreen.handleContactPicked(event)

Listens to contact picked event and dispatches a custom event with the selected contact details.

Kind: instance method of PhoneCallScreen

Param	Type	Description
event	`Event`	The event containing details of the picked contact.

phoneCallScreen.handleShowDialpad()

Toggles the visibility of the dial pad.

Kind: instance method of PhoneCallScreen

phoneCallScreen.handleSendDTMFEvent(event)

Dispatches a 'dtmf' custom event with the provided detail.

Kind: instance method of PhoneCallScreen

Param	Type	Description
event	`Event`	The event containing the DTMF (Dual-Tone Multi-Frequency) signal data.

phoneCallScreen.handleLoadTimerClass()

Loads the CSS class for the timer display.

Kind: instance method of PhoneCallScreen

phoneCallScreen.handleLoadHoldButtonClass()

Loads the CSS class for the hold button.

Kind: instance method of PhoneCallScreen

phoneCallScreen.handleLoadMuteButtonClass()

Loads the CSS class for the mute button.

Kind: instance method of PhoneCallScreen

phoneCallScreen.handleLoadDialpadButtonClass()

Loads the CSS class for the dial pad button.

Kind: instance method of PhoneCallScreen

phoneCallScreen.handleTerminateCall()

Handles the termination of a call. Changes the timer background color and pauses the timer.

Kind: instance method of PhoneCallScreen
Api:

phoneCallScreen.changeTimerManually()

Sets the timer class and background color, and updates the timer text to "Calling...".

Kind: instance method of PhoneCallScreen

phoneCallScreen.handleTimer(status) -- `void`

Handles the timer based on the provided status.

Kind: instance method of PhoneCallScreen

Param	Type	Description
status	`string`	The status of the timer ('failed', 'start', 'calling').

phoneCallScreen.handleUpdateCampaign(status) -- `void`

Updates the campaign status and performs corresponding actions.

Kind: instance method of PhoneCallScreen

Param	Type	Description
status	`string`	The new status of the campaign.

phoneCallScreen.disableCallNext() -- `boolean`

Determines if the call next button should be disabled.

Kind: instance method of PhoneCallScreen
Returns: boolean - - True if the call next button should be disabled, false otherwise.

phoneCallScreen.handleCallNextBtnClick() -- `void`

Handles the click event of the "Call Next" button.

Kind: instance method of PhoneCallScreen

phoneCallScreen.resetAllButtons()

Resets the styles of all buttons to their default state. This method iterates through a predefined list of button classes and applies default styling to each.

Kind: instance method of PhoneCallScreen
Api:

phoneCallScreen.startTimer()

Initiates the timer which updates every second, showing the duration of the ongoing call.

Kind: instance method of PhoneCallScreen

phoneCallScreen.pauseTimer()

Pauses the timer and formats the call duration to show hours, minutes, and seconds.

Kind: instance method of PhoneCallScreen

phoneCallScreen.toggleAddNumber()

Toggles the visibility of the add number functionality.

Kind: instance method of PhoneCallScreen

phoneCallScreen.toggleStatusScreen()

Toggles the visibility of the set status functionality.

Kind: instance method of PhoneCallScreen

phoneCallScreen.handleNewTaskClick()

Resets the task subject and toggles the new task view.

Kind: instance method of PhoneCallScreen

phoneCallScreen.toggleNewTask()

Toggles the visibility of the new task creation functionality.

Kind: instance method of PhoneCallScreen

phoneCallScreen.handleSelectedWhatId(event)

Listens to the event of an WhatId being selected and updates the selected WhatId parameter.

Kind: instance method of PhoneCallScreen

Param	Type	Description
event	`Event`	The event containing the selected WhatId's details.

phoneCallScreen.handleCallResultChange(event)

Listens to changes in fast notes and formats the note input accordingly. If certain fast note options are selected, a new task modal may be triggered.

Kind: instance method of PhoneCallScreen

Param	Type	Description
event	`Event`	The event containing the selected fast note's details.

phoneCallScreen.handleUpdateCampaignItemEvent(status, endInteraction) -- `void`

Handles the update campaign item event.

Kind: instance method of PhoneCallScreen

Param	Type	Description
status	`string`	The status of the campaign item.
endInteraction	`boolean`	Indicates whether the interaction should be ended.

phoneCallScreen.handleButtonStyleChange(buttonName)

Changes the styles of the specified button based on its current state (clicked or unclicked).

Kind: instance method of PhoneCallScreen

Param	Type	Description
buttonName	`string`	The class name of the button to be styled. This method dynamically checks if the button is loaded and applies style changes based on its current state.

phoneCallScreen.handleLoadClass(elementName)

Dynamically loads the CSS class for a specified element.

Kind: instance method of PhoneCallScreen

Param	Type	Description
elementName	`string`	The name of the element for which to load the CSS class. This method uses a naming convention to determine the CSS selector and the variable name where the class is stored.

phoneCallScreen.handleHold()

Toggles the hold state of the call, updating UI elements and dispatching events accordingly.

Kind: instance method of PhoneCallScreen

phoneCallScreen.handleMute()

Toggles the mute state of the call, updating UI elements and dispatching events accordingly.

Kind: instance method of PhoneCallScreen

phoneCallScreen.handleTerminateCallEvent()

Handles the termination of a call by invoking the terminate call method and dispatching a custom event to notify of the termination.

Kind: instance method of PhoneCallScreen

phoneCallScreen.handleRecordCreatedEvent(event)

Processes the creation of a new record and updates the calling person's details.

Kind: instance method of PhoneCallScreen

Param	Type	Description
event	`Event`	The event containing details of the created record.

phoneCallScreen.handleConfirmStatus(event) -- `void`

Handles the confirmation status of the phone call.

Kind: instance method of PhoneCallScreen

Param	Type	Description
event	`Event`	The event object containing the details of the confirmation status.

phoneCallScreen.handleUpdateCampaignMemberStatus(status) -- `void`

Updates the status of a Campaign Member.

Kind: instance method of PhoneCallScreen

Param	Type	Description
status	`string`	The new status value for the Campaign Member.

phoneCallScreen.handleCancelMultipleRecords() -- `void`

Handles the cancellation of multiple records and navigates to the previous screen.

Kind: instance method of PhoneCallScreen

phoneCallScreen.handleUpdateQuickCampaign() -- `void`

Updates the Quick Campaign record with the selected campaign's JSON.

Kind: instance method of PhoneCallScreen

phoneCallScreen.resetVariables()

Resets specific variables to their default values.

Kind: instance method of PhoneCallScreen

phoneCallScreen.handleOnChangeNote(event)

Updates the note input based on user input.

Kind: instance method of PhoneCallScreen

Param	Type	Description
event	`Event`	The event containing the note's text.

phoneCallScreen.handleSaveMultipleTasks(event) -- `void`

Handles the event of a new task being created and updates the task subject.

Kind: instance method of PhoneCallScreen

Param	Type	Description
event	`Event`	The event containing the new task's details.

phoneCallScreen.handleSkipSaveMultipleTasks() -- `void`

Handles the event of skipping the creation of multiple tasks and exits the phone call screen.

Kind: instance method of PhoneCallScreen

phoneCallScreen.handleLogCall()

Logs the call with provided details and shows a success or error message accordingly.

Kind: instance method of PhoneCallScreen

phoneCallScreen.handleNavigateToNextBtnClicked() -- `void`

Handles the click event of the "Navigate To Next" button.

Kind: instance method of PhoneCallScreen

phoneCallScreen.handleExitEvent()

Handles the exit event by invoking the exit method.

Kind: instance method of PhoneCallScreen

phoneCallScreen.handleStayEvent()

Handles the decision to stay on the current screen and hides the unsaved changes modal.

Kind: instance method of PhoneCallScreen

phoneCallScreen.handleCancelStatus()

Handles the event of a status being cancelled and navigates to the previous screen.

Kind: instance method of PhoneCallScreen

phoneCallScreen.handleClosePhoneCallScreenEvent()

Manages the event to close the phone call screen, ensuring there are no unsaved changes.

Kind: instance method of PhoneCallScreen

phoneCallScreen.handleExit()

Manages the process of exiting the phone call screen, logging the call and resetting variables.

Kind: instance method of PhoneCallScreen

phoneCallScreen.prepareStartAnimation(event)

Initiates the animation for a specific event target.

Kind: instance method of PhoneCallScreen

Param	Type	Description
event	`Event`	The event that triggers the animation.

phoneCallScreen.prepareStopAnimation(event)

Stops the animation for a specific event target.

Kind: instance method of PhoneCallScreen

Param	Type	Description
event	`Event`	The event that stops the animation.

PhoneCallScreenExitScreen

This module defines a Lightning Web Component that provides an interface for either staying on or exiting the phone call screen.

Requires: module:lwc, module:c/customLabelsUtils, module:lightning/platformResourceLoader, module:@salesforce/resourceUrl/Styles

PhoneCallScreenExitScreen
- module.exports ÔçÉ LightningElement --

module.exports ÔçÉ `LightningElement` --

Kind: Exported class
Extends: LightningElement

new module.exports()

A class that handles user interactions for staying on or exiting the phone call screen. It provides methods to handle both actions and uses custom styles for the component.

module.exports.labels

Proxy wrapper for the labelsList, providing a fallback label in case the requested label is missing.

Kind: instance property of module.exports

module.exports.connectedCallback()

Lifecycle hook that gets called when the component is inserted into the DOM.

Kind: instance method of module.exports

module.exports.handleStay()

Dispatches an event to indicate the user's desire to stay on the phone call screen.

Kind: instance method of module.exports

module.exports.handleExit()

Dispatches an event to indicate the user's desire to exit the phone call screen.

Kind: instance method of module.exports

PhoneContainer

This module defines a Lightning Web Component for handling phone interactions.

Requires: module:lwc, module:lightning/navigation, module:@salesforce/apex, module:@salesforce/resourceUrl, module:lightning/platformResourceLoader, module:c/constants, module:c/utils, module:c/customLabelsUtils

PhoneContainer
- module.exports ÔçÉ NavigationMixin --

module.exports ÔçÉ `NavigationMixin` --

Kind: Exported class
Extends: NavigationMixin

new module.exports()

A class for managing phone interactions, controlling UI based on call state, and handling user interactions like dialing, accepting, or ending a call. It also manages the call history and missed calls.

module.exports.labels

A proxy object for the labelsList which returns 'label_error' if a specific label is not found.

Kind: instance property of module.exports
Properties

Type
`Proxy`

module.exports.connectedCallback()

Lifecycle hook that gets called when the component is inserted into the DOM.

Kind: instance method of module.exports

module.exports.disconnectedCallback()

This method is triggered when the component is removed from the DOM.

Kind: instance method of module.exports

module.exports.userData() -- `Object`

Getter for the user data.

Kind: instance method of module.exports
Returns: Object - The current user data.

module.exports.userData(value)

Setter for the user data.

Kind: instance method of module.exports
Api:

Param	Type	Description
value	`Object`	The new user data.

module.exports.appSettings() -- `Object`

Getter for the application settings.

Kind: instance method of module.exports
Returns: Object - The current application settings.

module.exports.appSettings(value)

Setter for the application settings, updates call results based on the new settings.

Kind: instance method of module.exports

Param	Type	Description
value	`Object`	The new application settings.

module.exports.isAdmin() -- `Boolean`

Getter for the admin status.

Kind: instance method of module.exports
Returns: Boolean - True if the user is an admin, false otherwise.

module.exports.isAdmin(value)

Setter for the admin status.

Kind: instance method of module.exports

Param	Type	Description
value	`Boolean`	The new admin status.

module.exports.devices() -- `Object`

Getter for the devices.

Kind: instance method of module.exports
Returns: Object - The current devices.

module.exports.devices(value)

Setter for the devices.

Kind: instance method of module.exports

Param	Type	Description
value	`Object`	The new devices.

module.exports.defaultDevices() -- `Object`

Getter for the default devices.

Kind: instance method of module.exports
Returns: Object - The default devices.

module.exports.defaultDevices(value)

Setter for the default devices.

Kind: instance method of module.exports
Api:

Param	Type	Description
value	`Object`	The new default devices.

module.exports.handleFetchNewCampaignData(message)

Handles new data received for a campaign from a platform event.

Kind: instance method of module.exports

Param	Type	Description
message	`Object`	The message payload from the platform event.

module.exports.handleUpdateAgentNumber(event)

Dispatches an event to update agent number settings based on user interaction.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event containing the updated agent number settings.

module.exports.handleUpdateCampaignJSON(newCampaignJSON)

Updates the campaign JSON with new data fetched from the server.

Kind: instance method of module.exports

Param	Type	Description
newCampaignJSON	`Object`	The new campaign data to be used.

module.exports.agentStatus() -- `string`

Getter for the agentStatus value.

Kind: instance method of module.exports
Returns: string - The current agentStatus value.
Api:

module.exports.agentStatus(value)

Setter for the agentStatus value.

Kind: instance method of module.exports
Api:

Param	Type	Description
value	`string`	The new agentStatus value.

module.exports.handleChildCmpConnected(event)

Handles the connection of child components, associating the event target with a property.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event object.

module.exports.handleChildCmpDisconnected(event)

Handles the disconnection of child components, setting the property to undefined.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event object.

module.exports.getCallingPersonId() -- `string`

Retrieves the ID of the calling person if available.

Kind: instance method of module.exports
Returns: string - - The ID of the calling person or null if not available.

module.exports.wiredFieldLabels()

Wired method to fetch field labels.

Kind: instance method of module.exports

Param	Type	Description
	`Object`	Destructured object containing error and data properties.

module.exports.wiredcallHistory(result)

Wired method to fetch call history.

Kind: instance method of module.exports

Param	Type	Description
result	`Object`	The result object containing data and error properties.

module.exports.handleUpdateOffsetEvent()

Handler for updating the offset for paginated call history fetching.

Kind: instance method of module.exports

module.exports.updateMissedCallsCounter()

Updates the missed calls counter from local storage.

Kind: instance method of module.exports

module.exports.handleCallingPersonUpdateEvent(event)

Handler for updating the calling person information upon receiving an event.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event object.

module.exports.handleUpdateCallingPerson(event)

Updates the calling person information.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event object.

module.exports.navigateToRecordDetail()

Navigates to the record detail page of the calling person.

Kind: instance method of module.exports

module.exports.handleChangeScreen(screen)

Changes the screen view based on the screen type provided.

Kind: instance method of module.exports

Param	Type	Description
screen	`string`	The screen type.

module.exports.handleChangeSection(section)

Changes the section view based on the section type provided.

Kind: instance method of module.exports

Param	Type	Description
section	`string`	The section type.

module.exports.setHomeScreen()

Sets the view to the home screen and changes the section to the home section.

Kind: instance method of module.exports

module.exports.setPhoneCallScreen()

Sets the view to the phone call screen.

Kind: instance method of module.exports

module.exports.setCallingScreen()

Sets the view to the calling screen.

Kind: instance method of module.exports

module.exports.setHomeSection()

Sets the view to the home section.

Kind: instance method of module.exports

module.exports.setHistorySection()

Sets the view to the history section.

Kind: instance method of module.exports

module.exports.setContactInfoSection()

Sets the view to the contact info section.

Kind: instance method of module.exports

module.exports.setDialPadSection()

Toggles the view of the dial pad section.

Kind: instance method of module.exports

module.exports.handleToggleAddToCampaign()

Toggles the view of the dial pad section.

Kind: instance method of module.exports

module.exports.displayAppSettings()

Displays the application settings.

Kind: instance method of module.exports

module.exports.hideAppSettings()

Hides the application settings.

Kind: instance method of module.exports

module.exports.handleChangeInputEventSearchBar(event)

Handles the change of input from search bar, updating the input value, and determining whether to enable the call button and show results.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event object.

module.exports.handleChangeInputEventDialPad(event)

Handles the change of input from dial pad, updating the input value, and determining whether to enable the call button and show results.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event object.

module.exports.sanitizeNumber(number) -- `string`

Removes all whitespace, hyphens, and parentheses from a phone number.

Kind: instance method of module.exports
Returns: string - - The sanitized phone number.

Param	Type	Description
number	`string`	The phone number to sanitize.

module.exports.isNumberValid(number) -- `boolean`

Validates a phone number against a specific pattern, ignoring whitespace and hyphens.

Kind: instance method of module.exports
Returns: boolean - - Whether the phone number is valid.

Param	Type	Description
number	`string`	The phone number to validate.

module.exports.handleUpdateResultsEvent(event)

Handles the update of search results.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event object.

module.exports.handleContactPicked(event)

Handles the selection of a contact, updating the calling person and navigating to the record detail.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event object.

module.exports.handleSingleContactEvent()

Handles the event of a single contact, triggering a call request event.

Kind: instance method of module.exports

module.exports.handleTextMessageEvent(event)

Handles the event of a message being sent, updating the calling person and triggering a call request event.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event object.

module.exports.handleHistoryCallEvent(event)

Handles the event of a history call, updating the calling person and triggering a call request event.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event object.

module.exports.handleUpcomingCallEvent(event)

Handles an upcoming call event, setting up the calling person, phone number, and new task details.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event object containing call details.

module.exports.handleSearchbarCallEvent()

Handles a call event triggered from the search bar, setting up the phone number and calling person, and initiating the call request.

Kind: instance method of module.exports

module.exports.handleRequestStatusChangeEvent(event)

Dispatches an agent status change event.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event object containing the new status.

module.exports.handleClickToCallEvent(message)

Handles a click to call event, looking up the record by ID and updating the calling person and phone number.

Kind: instance method of module.exports
Api:

Param	Type	Description
message	`object`	The message object containing the record ID.

module.exports.updateAgentStatus(newStatus)

Updates the agent status and propagates the change to the child component.

Kind: instance method of module.exports
Api:

Param	Type	Description
newStatus	`string`	The new status of the agent.

module.exports.handleCallCampaignEvent(event)

Handles the event for initiating a call within a campaign.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event object containing campaign details.

module.exports.handleCallNextEvent()

Handles the event for initiating a call within a campaign.

Kind: instance method of module.exports

module.exports.handleTextCampaignEvent(event)

Handles the event for initiating a call within a campaign.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event object containing campaign details.

module.exports.handleCampaignSelectedEvent(event)

Handles the event when a campaign is selected by the user.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event object containing the selected campaign details.

module.exports.fetchQuickCampaignById(quickCampaignId)

Fetches a quick campaign by its ID from the server.

Kind: instance method of module.exports

Param	Type	Description
quickCampaignId	`String`	The ID of the quick campaign to fetch.

module.exports.handleNavigateToNextEvent()

Handles the event navigate to next contact in the campaign list.

Kind: instance method of module.exports

module.exports.handleDispatchNavigateToNextEvent()

Prepares the data for the next call in the campaign.

Kind: instance method of module.exports

module.exports.handleAssignDataToCallingPerson(personData)

Assigns fetched data to the calling person object in the component state.

Kind: instance method of module.exports

Param	Type	Description
personData	`Object`	The data of the person to be assigned.

module.exports.handleCallRequestEvent()

Initiates a call request if the phone number is valid, or shows a toast message if it's not.

Kind: instance method of module.exports

module.exports.handleSettingsChanged(event)

Dispatches a settings changed event.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event object containing the updated settings.

module.exports.handleUpdateDevicesSettings(event) -- `void`

Handles the event for updating the devices settings.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event object containing the updated devices settings.

module.exports.handleSendDTMFEvent(event)

Dispatches a 'dtmf' custom event with the provided detail.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event containing the DTMF (Dual-Tone Multi-Frequency) signal data.

module.exports.handleHoldCallEvent()

Dispatches a 'holdcall' custom event indicating a request to hold the current call.

Kind: instance method of module.exports

module.exports.handleUnholdCallEvent()

Dispatches an 'unholdcall' custom event indicating a request to unhold the current call.

Kind: instance method of module.exports

module.exports.handleMuteCallEvent()

Dispatches a 'mutecall' custom event indicating a request to mute the current call.

Kind: instance method of module.exports

module.exports.handleUnmuteCallEvent()

Dispatches an 'unmutecall' custom event indicating a request to unmute the current call.

Kind: instance method of module.exports

module.exports.handleTerminateCallEvent()

Dispatches a terminate call event.

Kind: instance method of module.exports

module.exports.handleNewSessionEvent(event) -- `void`

Handles the event for starting the new session event.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event object containing the session details.

module.exports.handleSessionStateEvent(event)

Handles a session state event, updating the phone number, unique call ID, and handling the call state accordingly.

Kind: instance method of module.exports
Api:

Param	Type	Description
event	`Event`	The event object containing the session state, phone number, and unique call ID.

module.exports.handleCallAccepted()

Handles a call accepted state, stopping the ringtone if the call was not initiated, changing the screen to the phone call screen, and marking the task as completed.

Kind: instance method of module.exports

module.exports.handleInvokeTimerMethod(status)

Invokes a method related to the call timer on the child component.

Kind: instance method of module.exports

Param	Type	Description
status	`String`	The status to pass to the timer method.

module.exports.handleUpdateCampaignItemEvent(event)

Handles the event for updating a specific item within a campaign.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event object containing details for the update.

module.exports.handleUpdateCampaign(status, endInteraction)

Updates the campaign status based on interactions or decisions made during a call.

Kind: instance method of module.exports

Param	Type	Description
status	`String`	The new status to apply to the campaign or campaign item.
endInteraction	`Boolean`	Indicates whether the interaction with the current campaign item has ended.

module.exports.handleTaskCompleted()

Marks the task as completed asynchronously, and refreshes the detail page if the update is successful.

Kind: instance method of module.exports

module.exports.handleCallEnded()

Handles a call ended state, terminating the call on the phone call screen, and showing a toast message to notify the user.

Kind: instance method of module.exports

module.exports.handleCallConfirmed()

Handles a call confirmed state, changing the screen to the phone call screen, and showing a toast message to notify the user.

Kind: instance method of module.exports

module.exports.handleCallFailed()

Handles a failed call event by stopping the ringtone (if not initiated by the user), clearing data, and redirecting the user to the home screen with a toast message.

Kind: instance method of module.exports

module.exports.handleCallInProgress()

Handles a call in progress event by playing the ringtone (if not initiated by the user), changing the screen to the calling screen, and displaying a toast message.

Kind: instance method of module.exports

module.exports.handleSendShowQuakkerUtilityEvent()

Handles the event for showing the Quakker utility.

Kind: instance method of module.exports

module.exports.clearData()

Clears the current data related to the call, search results, and input fields.

Kind: instance method of module.exports

module.exports.prepareDataForCallNext()

Prepares the component state for the next call within a campaign by resetting relevant data.

Kind: instance method of module.exports

module.exports.handleRejectCallEvent()

Dispatches a custom event to reject the call.

Kind: instance method of module.exports

module.exports.handleAcceptCallEvent()

Dispatches a custom event to accept the call.

Kind: instance method of module.exports

module.exports.handleClosePhoneCallScreenEvent()

Clears data, refreshes the task list on the home screen, updates agent status and navigates the user back to the home screen.

Kind: instance method of module.exports

module.exports.handleShowHomePanelEvent()

Clears data and navigates the user to the home section.

Kind: instance method of module.exports

module.exports.handleShowCampaignScreenEvent()

Handles the event to show the campaign screen.

Kind: instance method of module.exports

module.exports.handleExitCampaignScreenEvent()

Handles the event to exit the campaign screen and return to the previous state.

Kind: instance method of module.exports

module.exports.handleItemSelected(event)

Handles selection events in the UI, such as selecting tasks or campaigns from a menu.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event object containing details of the item selected.

module.exports.handleShowHistoryPanelEvent()

Clears data and navigates the user to the history section, updating the missed calls counter if necessary.

Kind: instance method of module.exports

module.exports.handleCallEventCreated()

Handles the event when a call is created by refreshing the history list.

Kind: instance method of module.exports

module.exports.handleLogout()

Dispatches a custom event to logout.

Kind: instance method of module.exports

module.exports.updateHistoryCounter(counter)

Updates the history counter with the number of new missed calls.

Kind: instance method of module.exports

Param	Type	Description
counter	`number`	The number of new missed calls.

module.exports.handleRefreshHistoryList()

Refreshes the call history list and updates the missed calls counter asynchronously if the call history data has changed.

Kind: instance method of module.exports
Api:

module.exports.playRingtone()

Initiates the ringtone play and updates the document title with the incoming call information.

Kind: instance method of module.exports

module.exports.stopRingtone()

Stops the ringtone play and restores the document title.

Kind: instance method of module.exports

module.exports.prepareStartAnimation(event)

Prepares the start of an animation on a specified element.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event object.

module.exports.prepareStopAnimation(event)

Prepares the stop of an animation on a specified element.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event object.

module.exports.handleMinimize()

Handles the minimize button click event.

Kind: instance method of module.exports

module.exports~subscribeToPlatformEvent()

Subscribes to a platform event channel to listen for events.

Kind: inner method of module.exports

module.exports~unsubscribeFromPlatformEvent()

Unsubscribes from the platform event channel to stop listening for events.

Kind: inner method of module.exports

module.exports~handleAddPersonToCampaign(event)

Initiates the process of adding a person to a campaign by toggling the UI component and setting the person data.

Kind: inner method of module.exports

Param	Type	Description
event	`Event`	Contains details of the person to be added to the campaign.

quakkerWelcomeScreen

This module defines a Lightning Web Component (LWC) that serves as a welcome screen for the Quakker application.

Requires: module:api, module:LightningElement, module:wire, module:quakkerLogoWelcome, module:loadStyle, module:Styles, module:toastStyling, module:communicationUtils, module:MessageContext, module:labelsList

quakkerWelcomeScreen
- module.exports ÔçÉ LightningElement --
  - new module.exports()
  - .labels
  - .connectedCallback()
  - .disconnectedCallback()
  - .sendHideSpinnerMessage()
  - .userData() -- Object
  - .userData(value)
  - .handleCredentialsProvided(event)
  - .handleCreateTrialAccount()
  - .handleStandardPanel()
  - .handleBackToOptions()
  - .showWelcomeOptions() -- Boolean
  - .showStandardLogin() -- Boolean
  - .showTrialForm() -- Boolean

module.exports ÔçÉ `LightningElement` --

Kind: Exported class
Extends: LightningElement

new module.exports()

A Lightning Web Component that displays a welcome screen for Quakker. It handles user interactions for navigating between different modes (welcome, trial, standard).

module.exports.labels

Provides a proxy for label list, defaulting to 'label_error' if a specific label is not found.

Kind: instance property of module.exports

module.exports.connectedCallback()

Lifecycle hook that is invoked when the component is inserted into the DOM. It sets the initial display mode and loads necessary styles.

Kind: instance method of module.exports

module.exports.disconnectedCallback()

Lifecycle hook that is invoked when the component is removed from the DOM.

Kind: instance method of module.exports

module.exports.sendHideSpinnerMessage()

Sends a message to hide the spinner.

Kind: instance method of module.exports

module.exports.userData() -- `Object`

Getter for the user data.

Kind: instance method of module.exports
Returns: Object - The current user data.

module.exports.userData(value)

Setter for the user data.

Kind: instance method of module.exports
Api:

Param	Type	Description
value	`Object`	The new user data.

module.exports.handleCredentialsProvided(event)

Handles the event when credentials are provided.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event containing the provided credentials.

module.exports.handleCreateTrialAccount()

Handles the action to create a trial account. It changes the display mode to 'trial' and hides the welcome logo.

Kind: instance method of module.exports

module.exports.handleStandardPanel()

Handles the action to show the standard login panel. It changes the display mode to 'standard' and hides the welcome logo.

Kind: instance method of module.exports

module.exports.handleBackToOptions()

Handles the action to go back to the welcome options. It changes the display mode to 'welcome' and shows the welcome logo.

Kind: instance method of module.exports

module.exports.showWelcomeOptions() -- `Boolean`

Getter that determines if the welcome options should be displayed.

Kind: instance method of module.exports
Returns: Boolean - True if the display mode is 'welcome', false otherwise.

module.exports.showStandardLogin() -- `Boolean`

Getter that determines if the standard login panel should be displayed.

Kind: instance method of module.exports
Returns: Boolean - True if the display mode is 'standard', false otherwise.

module.exports.showTrialForm() -- `Boolean`

Getter that determines if the trial form should be displayed.

Kind: instance method of module.exports
Returns: Boolean - True if the display mode is 'trial', false otherwise.

SearchBar

This module defines a Lightning Web Component for handling search bar interactions.

Requires: module:lwc, module:c/customLabelsUtils, module:@salesforce/resourceUrl/erease_icon, module:@salesforce/resourceUrl/search_icon, module:lightning/platformResourceLoader, module:@salesforce/resourceUrl/Styles

SearchBar
- module.exports --

module.exports --

Kind: Exported class

new module.exports()

A class for managing search bar interactions, such as typing in search value, triggering search when pressing the enter key, and erasing input value.

module.exports.searchValue -- `string`

Returns the current value of the search input.

Kind: instance property of module.exports
Returns: string - The current value of the search input field.
Getter:

module.exports.searchValue

Sets the value of the search input and triggers the input change event handler.

Kind: instance property of module.exports
Setter:

Param	Type	Description
value	`string`	The new value to set for the search input field.

module.exports.labels

Provides a proxy for label list, defaulting to 'label_error' if a specific label is not found.

Kind: instance property of module.exports

module.exports.connectedCallback()

Lifecycle hook that gets called when the component is inserted into the DOM.

Kind: instance method of module.exports

module.exports.disconnectedCallback()

This method is triggered when the component is removed from the DOM.

Kind: instance method of module.exports

module.exports.handleChangeInput(event)

Handles changes in the input field and dispatches a corresponding event.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The change event from the input field.

module.exports.handleKeyUp(event)

Handles key up event, triggering a call request event when enter key is pressed.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The key up event from the input field.

module.exports.handleEraseInput()

Erases the last character from the search input and sets focus on the input.

Kind: instance method of module.exports

module.exports.focusOnInput()

Sets focus on the search input field.

Kind: instance method of module.exports

module.exports.handleChangeInputEvent()

Dispatches a change input event with the current search value.

Kind: instance method of module.exports

module.exports.handleCallRequestEvent()

Dispatches a call request event.

Kind: instance method of module.exports

module.exports.prepareStartAnimation(event)

Starts the animation on the given element.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event containing the current target to animate.

module.exports.prepareStopAnimation(event)

Stops the animation on the given element.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event containing the current target to stop animating.

SearchContainer

This module defines a Lightning Web Component for managing search functionality within a container.

Requires: module:lwc, module:c/utils, module:@salesforce/apex/PhoneAppController.handleSearchPhoneNumber, module:c/customLabelsUtils, module:lightning/platformResourceLoader, module:@salesforce/resourceUrl/Styles

SearchContainer
- module.exports --

module.exports --

Kind: Exported class

new module.exports()

A class for managing search functionality, handling search results, displaying specific sections based on data and user interactions.

module.exports.contact

Gets the contact information.

Kind: instance property of module.exports
Getter:

module.exports.contact

Sets the contact information

Kind: instance property of module.exports
Setter:

Param	Type	Description
value	`Object`	The contact information.

module.exports.isSingleContact

Determines if only one contact is being displayed

Kind: instance property of module.exports
Getter:

module.exports.isSingleContact

Sets whether only one contact is being displayed

Kind: instance property of module.exports
Setter:

Param	Type	Description
value	`Boolean`	The single contact flag

module.exports.callInitiated

Determines if a call has been initiated

Kind: instance property of module.exports
Getter:

module.exports.callInitiated

Sets whether a call has been initiated

Kind: instance property of module.exports
Setter:

Param	Type	Description
value	`Boolean`	The call initiated flag

module.exports.callInProgress

Determines if a call is currently in progress

Kind: instance property of module.exports
Getter:

module.exports.callInProgress

Sets whether a call is currently in progress

Kind: instance property of module.exports
Setter:

Param	Type	Description
value	`Boolean`	The call in progress flag

module.exports.labels

Provides a proxy for label list, defaulting to 'label_error' if a specific label is not found.

Kind: instance property of module.exports

module.exports.connectedCallback()

Lifecycle hook that gets called when the component is inserted into the DOM.

Kind: instance method of module.exports

module.exports.disconnectedCallback()

This method is triggered when the component is removed from the DOM.

Kind: instance method of module.exports

module.exports.inputValue() -- `string`

Getter for the input value.

Kind: instance method of module.exports
Returns: string - The current input value.
Api:

module.exports.inputValue(value)

Setter for the input value.

Kind: instance method of module.exports
Api:

Param	Type	Description
value	`string`	The new input value.

module.exports.updateContact(record)

Updates the contact data.

Kind: instance method of module.exports
Api:

Param	Type	Description
record	`Object`	The new contact record.

module.exports.renderedCallback()

Callback invoked once the component has been rendered.

Kind: instance method of module.exports

module.exports.handleContactPickedEvent()

Handles a contact being picked.

Kind: instance method of module.exports

module.exports.handleContactClicked(event)

Handles the event when a contact is clicked.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The click event.

module.exports.handleUpdateResultsEvent(event)

Handles the event to update the search results.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The results update event.

module.exports.handleCallRequestFromResults(event)

Handles the event to initiate a call from the search results.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The call request event.

module.exports.handleTextMessageEvent(event)

Handles the event to initiate a call from the search results.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The call request event.

module.exports.handleContactAssign(event)

Assigns a specific contact.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The contact assignment event.

module.exports.handleCallRequest()

Handles the request to initiate a call.

Kind: instance method of module.exports

module.exports.handleBackToResults()

Handles the action to navigate back to the results section.

Kind: instance method of module.exports

module.exports.handleClearContactData()

Clears the contact data.

Kind: instance method of module.exports

module.exports.handleResetBeforeSearch()

Resets the necessary fields before initiating a search operation.

Kind: instance method of module.exports

module.exports.handleSearch()

Initiates the search operation based on the input value.

Kind: instance method of module.exports

module.exports.search(searchKey)

Executes the search operation based on the provided search key.

Kind: instance method of module.exports

Param	Type	Description
searchKey	`string`	The key to search for.

module.exports.handleLoadMoreResults(event)

Handles the event to load more search results.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The load more results event.

module.exports.handleChangeSection(section)

Handles the display and functionality of different sections in the component.

Kind: instance method of module.exports

Param	Type	Description
section	`string`	The section identifier.

module.exports.setContactSection()

Sets the view to the contact section.

Kind: instance method of module.exports

module.exports.setResultsSection()

Sets the view to the results section.

Kind: instance method of module.exports

module.exports.setNodataSection()

Sets the view to the no-data section.

Kind: instance method of module.exports

module.exports.setDefaultSection()

Sets the view to the default section.

Kind: instance method of module.exports

module.exports~handleAddPersonToCampaign(event)

Dispatches a custom event to add a person to a campaign, using details from the original event payload.

Kind: inner method of module.exports

Param	Type	Description
event	`Event`	The event object containing the details of the person to be added.

SearchResults

This module defines a Lightning Web Component for displaying search results.

Requires: module:lwc, module:c/customLabelsUtils, module:c/utils

SearchResults
- module.exports ÔçÉ LightningElement --

module.exports ÔçÉ `LightningElement` --

Kind: Exported class
Extends: LightningElement

new module.exports()

A class responsible for rendering and managing search results, handling user interactions with the results, and emitting appropriate events based on user actions.

module.exports.disableMessageButton

Checks if the sms feature is enabled.

Kind: instance property of module.exports
Getter:

module.exports.labels

Provides a proxy for label list, defaulting to 'label_error' if a specific label is not found.

Kind: instance property of module.exports

module.exports.connectedCallback()

Lifecycle hook that gets called when the component is inserted into the DOM.

Kind: instance method of module.exports

module.exports.handleContactClicked(event)

Handles the event when a contact is clicked.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The click event.

module.exports.handleAddPersonToCampaign(event)

Stops event propagation and dispatches a custom event to add a person to a campaign, using dataset information from the current target of the event.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The event object, where the current target's dataset contains the person's details to be added.

module.exports.handleCallRequestFromResults(event)

Handles the call request from the displayed search results.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The call request event.

module.exports.handleSendTextMessage(event)

Handles the call request from the displayed search results.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The call request event.

module.exports.handleLoadMoreResults(event)

Handles the event to load more search results.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The load more results event.

module.exports.handlePrepareContact(event)

Prepares the contact data before emitting any events.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The contact preparation event.

SipLibController

This module defines a Lightning Web Component for handling SIP based communication using the JsSIP library.

Requires: module:lwc, module:@salesforce/resourceUrl/jssip3100min, module:lightning/platformResourceLoader, module:lightning/messageService, module:c/communicationUtils, module:c/constants, module:c/customLabelsUtils, module:c/utils

SipLibController
- module.exports ÔçÉ LightningElement --

module.exports ÔçÉ `LightningElement` --

Kind: Exported class
Extends: LightningElement

new module.exports()

A class for managing SIP based communication using the JsSIP library, which helps in initiating, managing, and terminating SIP sessions. It also handles the SIP registration and various SIP events.

module.exports.appSettings -- `Object`

Getter for the appSettings value.

Kind: instance property of module.exports
Returns: Object - The current appSettings object.
Api:
Getter:

module.exports.appSettings

Setter for the appSettings value.

Kind: instance property of module.exports
Api:
Setter:

Param	Type	Description
value	`Object`	The new appSettings object.

module.exports.userData -- `Object`

Getter for the userData value.

Kind: instance property of module.exports
Returns: Object - The current userData object.
Api:
Getter:

module.exports.userData

Setter for the userData value.

Kind: instance property of module.exports
Api:
Setter:

Param	Type	Description
value	`Object`	The new userData object.

module.exports.defaultDevices -- `Object`

Getter for the defaultDevices value.

Kind: instance property of module.exports
Returns: Object - The current defaultDevices object.
Getter:

module.exports.defaultDevices

Setter for the defaultDevices value.

Kind: instance property of module.exports
Api:
Setter:

Param	Type	Description
value	`Object`	The new defaultDevices object.

module.exports.agentStatus -- `string`

Getter for the agentStatus value.

Kind: instance property of module.exports
Returns: string - The current agentStatus value.
Api:
Getter:

module.exports.agentStatus

Setter for the agentStatus value.

Kind: instance property of module.exports
Api:
Setter:

Param	Type	Description
value	`string`	The new agentStatus value.

module.exports.labels

Proxy wrapper for the labelsList, providing a fallback label in case the requested label is missing.

Kind: instance property of module.exports

module.exports.connectedCallback()

Lifecycle hook that gets called when the component is inserted into the DOM.

Kind: instance method of module.exports

module.exports.disconnectedCallback()

This method is triggered when the component is removed from the DOM.

Kind: instance method of module.exports

module.exports.renderedCallback()

Lifecycle method called after every render of the component. Used for initializing the JsSIP library.

Kind: instance method of module.exports

module.exports.initializeJsSip()

Initializes the JsSIP library with provided user configuration and sets up various SIP events.

Kind: instance method of module.exports

module.exports.handleIncomingCall(newSession, completeSession, cmpThis)

Handles incoming SIP calls by setting up various SIP events and configurations.

Kind: instance method of module.exports

Param	Type	Description
newSession	`Object`	The SIP session object for the incoming call.
completeSession	`function`	A callback function to be called upon completion or termination of the session.
cmpThis	`Object`	The current context of the component.

module.exports.handleOutgoingCall(newSession, completeSession, cmpThis)

Handles outgoing SIP calls by setting up various SIP events and configurations.

Kind: instance method of module.exports

Param	Type	Description
newSession	`Object`	The SIP session object for the outgoing call.
completeSession	`function`	A callback function to be called upon completion or termination of the session.
cmpThis	`Object`	The current context of the component.

module.exports.handleSessionState(state)

Handles the various states of a SIP session and dispatches a 'sessionstatechange' event.

Kind: instance method of module.exports

Param	Type	Description
state	`string`	The current state of the SIP session.

module.exports.handleRegistration(status)

Dispatches a 'registrationstatuschange' event to notify of changes in SIP registration status.

Kind: instance method of module.exports

Param	Type	Description
status	`string`	The registration status.

module.exports.handleAgentStatusChange(agentStatus)

Dispatches an 'agentstatuschange' event to notify of changes in agent status.

Kind: instance method of module.exports

Param	Type	Description
agentStatus	`string`	The current status of the agent.

module.exports.handleInformParentAboutNewSession(phone)

Dispatches a 'newsession' event to notify of a new SIP call session.

Kind: instance method of module.exports

Param	Type	Description
phone	`string`	The phone number associated with the new session.

module.exports.handleMissedCall(phone, missedCall, uniqueCallId, inProgress)

Dispatches a 'missedcall' event to notify of missed calls.

Kind: instance method of module.exports

Param	Type	Description
phone	`string`	The phone number of the missed call.
missedCall	`boolean`	Indicates whether the call was missed or not.
uniqueCallId	`string`	The unique ID associated with the call.
inProgress	`boolean`	Indicates whether the call is still in progress.

module.exports.handleHoldCall()

Places the current SIP call session on hold.

Kind: instance method of module.exports
Api:

module.exports.handleUnholdCall()

Resumes a SIP call session that was previously on hold.

Kind: instance method of module.exports
Api:

module.exports.handleMuteCall()

Mutes the current SIP call session.

Kind: instance method of module.exports
Api:

module.exports.handleUnmuteCall()

Unmutes the current SIP call session that was muted.

Kind: instance method of module.exports
Api:

module.exports.handleDtmf(event)

Sends a DTMF (Dual-Tone Multi-Frequency) signal during a SIP call session.

Kind: instance method of module.exports
Api:

Param	Type	Description
event	`Event`	The event containing the DTMF signal data.

module.exports.handleTerminateCall()

Terminates an ongoing SIP call session.

Kind: instance method of module.exports
Api:

module.exports.answerCall()

Answers an incoming SIP call.

Kind: instance method of module.exports
Api:

module.exports.makeCall(callRequest)

Initiates an outgoing SIP call to the provided phone number.

Kind: instance method of module.exports
Api:

Param	Type	Description
callRequest	`Object`	The call request object containing the phone number to call.

module.exports.changeAgentStatus(event)

Changes the status of the SIP agent based on the event detail.

Kind: instance method of module.exports
Api:

Param	Type	Description
event	`Event`	The event containing details of the agent status to change to.

module.exports.logoutAgent()

Logs out the SIP agent by terminating ongoing sessions and unregistering the user agent.

Kind: instance method of module.exports
Api:

StatusChanger

This module defines a Lightning Web Component for changing and displaying the agent's status.

Requires: module:lwc, module:c/constants, module:c/utils, module:lightning/messageService, module:c/communicationUtils, module:c/customLabelsUtils

StatusChanger
- module.exports ÔçÉ LightningElement --
  - new module.exports()
  - .dotClass -- string
  - .labels
  - .agentStatus() -- Object
  - .agentStatus(value)
  - .connectedCallback()
  - .loadOptions() -- void
  - .disconnectedCallback()
  - .toggleDropdown()
  - .handleSelect(event)
  - .updateAgentStatus(newStatus)

module.exports ÔçÉ `LightningElement` --

Kind: Exported class
Extends: LightningElement

new module.exports()

A class responsible for changing and displaying the agent's status, including the ability to toggle between different status options and emit relevant events based on user actions.

module.exports.dotClass -- `string`

Returns the appropriate CSS class based on the agent's current status.

Kind: instance property of module.exports
Returns: string - The CSS class corresponding to the agent's status.
Getter:

module.exports.labels

Provides a proxy for label list, defaulting to 'label_error' if a specific label is not found.

Kind: instance property of module.exports

module.exports.agentStatus() -- `Object`

Getter for the agent status.

Kind: instance method of module.exports
Returns: Object - The current agent status.

module.exports.agentStatus(value)

Setter for the agent status, updates agent status parameter based on new value.

Kind: instance method of module.exports

Param	Type	Description
value	`Object`	The new agent status.

module.exports.connectedCallback()

Lifecycle hook that gets called when the component is inserted into the DOM.

Kind: instance method of module.exports

module.exports.loadOptions() -- `void`

Loads the status options for the dropdown.

Kind: instance method of module.exports

module.exports.disconnectedCallback()

This method is triggered when the component is removed from the DOM.

Kind: instance method of module.exports

module.exports.toggleDropdown()

Toggles the visibility of the status dropdown.

Kind: instance method of module.exports

module.exports.handleSelect(event)

Handles the selection of a status option and dispatches an event with the selected status.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The select event.

module.exports.updateAgentStatus(newStatus)

Updates the displayed agent status.

Kind: instance method of module.exports
Api:

Param	Type	Description
newStatus	`string`	The new status to be set for the agent.

UserRegister

This module defines a Lightning Web Component for user registration, specifically for SIP (Session Initiation Protocol) user registration.

Requires: module:lwc, module:lightning/messageService, module:c/communicationUtils, module:c/customLabelsUtils, module:c/utils, module:c/constants

UserRegister
- module.exports ÔçÉ LightningElement --
  - new module.exports()
  - .labels
  - .userData() -- Object
  - .userData(value)
  - .sipWebsocket() -- String
  - .sipWebsocket(value)
  - .connectedCallback()
  - .notAdmin() -- Boolean
  - .showFirstRunAlert() -- Boolean
  - .smsFeatureAvailable() -- Boolean
  - .sendShowSpinnerMessage()
  - .sendHideSpinnerMessage()
  - .handleSipLoginChange(event)
  - .handleSipPasswordChange(event)
  - .handleWebsocketAddressChange(event)
  - .handleAgentPhoneChange(event)
  - .handleSave()
  - .handleSendCredentialsEvent()
  - .generateSipUri()
  - .openCreateVoipStudioAccount()
  - .handleConfirm()
  - .generatePassword() -- String
  - .isPasswordValid() -- Boolean
  - .showToast(title, message, variant)

module.exports ÔçÉ `LightningElement` --

Kind: Exported class
Extends: LightningElement

new module.exports()

A class for handling SIP user registration. It manages user inputs for SIP login, password, and WebSocket validates them, and emits a custom event with the provided credentials.

module.exports.labels

Provides a proxy for label list, defaulting to 'label_error' if a specific label is not found.

Kind: instance property of module.exports

module.exports.userData() -- `Object`

Getter for the user data.

Kind: instance method of module.exports
Returns: Object - The current user data.

module.exports.userData(value)

Setter for the user data.

Kind: instance method of module.exports
Api:

Param	Type	Description
value	`Object`	The new user data.

module.exports.sipWebsocket() -- `String`

Getter for the WebSocket address.

Kind: instance method of module.exports
Returns: String - The current WebSocket address.

module.exports.sipWebsocket(value)

Setter for the WebSocket address.

Kind: instance method of module.exports
Api:

Param	Type	Description
value	`String`	The new WebSocket address.

module.exports.connectedCallback()

Lifecycle hook that gets called when the component is inserted into the DOM.

Kind: instance method of module.exports

module.exports.notAdmin() -- `Boolean`

Returns the negation of the isAdmin property.

Kind: instance method of module.exports
Returns: Boolean - - The negation of the isAdmin property.

module.exports.showFirstRunAlert() -- `Boolean`

Returns a boolean indicating whether the component is in its first run.

Kind: instance method of module.exports
Returns: Boolean - - A boolean indicating whether the component is in its first run.

module.exports.smsFeatureAvailable() -- `Boolean`

Getter that determines if the user should see text messages settings.

Kind: instance method of module.exports
Returns: Boolean - Returns true if the user has access to text messages settings due to feature availability.

module.exports.sendShowSpinnerMessage()

Publikuje wiadomo┼Ť─ç pokazuj─ůc─ů spinner.

Kind: instance method of module.exports

module.exports.sendHideSpinnerMessage()

Publishes a hide spinner message to the message context.

Kind: instance method of module.exports

module.exports.handleSipLoginChange(event)

Updates the sipLogin property based on user input.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The input change event.

module.exports.handleSipPasswordChange(event)

Updates the sipPassword property based on user input.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The input change event.

module.exports.handleWebsocketAddressChange(event)

Updates the sipWebsocket property based on user input.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The input change event.

module.exports.handleAgentPhoneChange(event)

Updates the agentPhone property based on user input.

Kind: instance method of module.exports

Param	Type	Description
event	`Event`	The input change event.

module.exports.handleSave()

Handles the user's request to save the provided credentials. It validates the credentials, generates a SIP URI, and dispatches a custom event.

Kind: instance method of module.exports

module.exports.handleSendCredentialsEvent()

Dispatches a custom event with the provided SIP credentials.

Kind: instance method of module.exports

module.exports.generateSipUri()

Generates a SIP URI using the provided sipWebsocket and sipLogin properties.

Kind: instance method of module.exports

module.exports.openCreateVoipStudioAccount()

Opens the VoipStudio account creation form and populates it with user details.

Kind: instance method of module.exports

module.exports.handleConfirm()

Handles the confirm action for creating a VoipStudio account. Validates the password and sends a request to create the account.

Kind: instance method of module.exports

module.exports.generatePassword() -- `String`

Generates a random password that meets security requirements.

Kind: instance method of module.exports
Returns: String - The generated password.

module.exports.isPasswordValid() -- `Boolean`

Validates the generated password to ensure it meets security requirements.

Kind: instance method of module.exports
Returns: Boolean - True if the password is valid, false otherwise.

module.exports.showToast(title, message, variant)

Displays a toast message with the specified title, message, and variant.

Kind: instance method of module.exports

Param	Type	Description
title	`String`	The title of the toast message.
message	`String`	The message of the toast.
variant	`String`	The variant of the toast (e.g., 'success', 'error').

Utils

This module defines a set of utility functions for Lightning Web Components which assist in showing toast messages, animations, invoking methods, and more.

Requires: module:lightning/platformShowToastEvent

Utils
- static
- inner
  - ~waitForFieldAndExecute(context, fieldName, callback)
  - ~prepareFieldLabelsProxy(fieldLabels) -- Proxy
  - ~clearPhoneNumber(phoneNumber) -- string

Utils.showToastMessage(component, title, message, variant, [mode])

Shows a toast message with the provided parameters.

Kind: static method of Utils

Param	Type	Default	Description
component	`object`		The Lightning component instance to display the toast message in.
title	`string`		The title for the toast.
message	`string`		The main message for the toast.
variant	`string`		The visual variant for the toast, e.g., 'success' or 'error'.
[mode]	`string`	`"'dismissible'"`	The mode for the toast, defaults to 'dismissible'.

Utils.universalErrorHandler(exception, component)

Handles any error in LWC components by displaying a toast message with the error message.

Kind: static method of Utils

Param	Type	Description
exception	`object`	The error object returned from either Apex method or JavaScript try/catch.
component	`object`	The Lightning component instance to display the toast message in.

Utils.sendConnectedChildEvent(componentInstance, componentName) -- `void`

Dispatches a 'connected' event with the component's name from the given component instance.

Kind: static method of Utils

Param	Type	Description
componentInstance	`object`	The Lightning component instance dispatching the event.
componentName	`string`	The name of the component.

Utils.sendDisconnectedChildEvent(componentInstance, componentName) -- `void`

Dispatches a 'disconnected' event with the component's name from the given component instance.

Kind: static method of Utils

Param	Type	Description
componentInstance	`object`	The Lightning component instance dispatching the event.
componentName	`string`	The name of the component.

Utils.startAnimation(currentTarget)

Starts an animation by changing the image source to the animated version.

Kind: static method of Utils

Param	Type	Description
currentTarget	`object`	The DOM element that has the image.

Utils.stopAnimation(currentTarget)

Stops an animation by reverting the image source to the static version.

Kind: static method of Utils

Param	Type	Description
currentTarget	`object`	The DOM element that has the image.

Utils.toggleImageSource(elementClass, toggleCondition)

Toggles the image source between static and animation URLs.

Kind: static method of Utils

Param	Type	Description
elementClass	`object`	The class of the DOM element that contains the image.
toggleCondition	`boolean`	The condition to decide which image URL to use.

Utils.invokeChildMethod(parentCmp, childCmpName, funcName, args) -- `Promise`

Invokes a method on a child component from its parent.

Kind: static method of Utils
Returns: Promise - - A promise that resolves with the result of the invoked method or rejects with an error.

Param	Type	Description
parentCmp	`object`	The parent Lightning component instance.
childCmpName	`string`	The name/variable referencing the child component on the parent.
funcName	`string`	The name of the function to be invoked.
args	`Array`	The arguments to be passed to the function.

Utils.initializeFieldLabels(context, fieldName)

Waits for field labels to be available and then creates a proxy for them.

Kind: static method of Utils

Param	Type	Description
context	`object`	The context within which the field labels exist (usually 'this' in a component).
fieldName	`string`	The name of the field labels property.

Utils.comparePhoneNumbers(phone1, phone2) -- `boolean`

Compares two phone numbers by their last 9 digits

Kind: static method of Utils
Returns: boolean - True if last 9 digits match, false otherwise

Param	Type	Description
phone1	`string`	First phone number to compare
phone2	`string`	Second phone number to compare

Utils~waitForFieldAndExecute(context, fieldName, callback)

Waits for a truthy value to be assigned to a specified field, and then applies a given callback to it.

Kind: inner method of Utils

Param	Type	Description
context	`object`	The context within which to check the field value (usually 'this' in a component).
fieldName	`string`	The name of the field to be checked.
callback	`function`	The callback to execute once the field has a truthy value.

Utils~prepareFieldLabelsProxy(fieldLabels) -- `Proxy`

Creates a proxy to handle field labels, providing a default value if a property is missing.

Kind: inner method of Utils
Returns: Proxy - - A proxy wrapped around the fieldLabels object.

Param	Type	Description
fieldLabels	`object`	The object containing field labels.

Utils~clearPhoneNumber(phoneNumber) -- `string`

Cleans a phone number by removing non-digit characters

Kind: inner method of Utils
Returns: string - Cleaned phone number containing only digits

Param	Type	Description
phoneNumber	`string`	The phone number to clean

tasksButtonClass -- `String`

If the tasks section is visible, returns a CSS class indicating an active (green background) state; otherwise, returns a class for an inactive (white background) state.

Kind: global variable
Returns: String - The CSS class for the tasks button.
Get:

campaignsButtonClass -- `String`

If the tasks section is not visible, returns a CSS class indicating an active (green background) state; otherwise, returns a class for an inactive (white background) state.

Kind: global variable
Returns: String - The CSS class for the campaigns button.
Get:

connectedCallback()

Lifecycle hook that gets called when the component is inserted into the DOM.

Kind: global function

handleInput(event)

Event handler for user input in any of the form fields. Updates the record object with the new value.

Kind: global function

Param	Type	Description
event	`Event`	The event object from the input field.

addRecord()

Initiates the process to add a record in Salesforce, performs validations, and shows toast messages based on operation results.

Kind: global function

validateInputs() -- `boolean`

Validates the inputs based on the selected object type to ensure necessary fields are filled before creating a record. If fields are missing, constructs an error message.

Kind: global function
Returns: boolean - - Returns true if validation is successful, false otherwise.

prepareFields() -- `Object`

Prepares a fields object for creating a record based on the selected object type and current input values.

Kind: global function
Returns: Object - - An object containing field names as keys and user input values as values.

handleSendRecordEvent(record)

Constructs a record object from the created Salesforce record and dispatches a 'recordcreated' event to notify parent components or listeners.

Kind: global function

Param	Type	Description
record	`Object`	The record object returned from Salesforce after a successful record creation.

close()

Dispatches a 'close' event to notify parent components or listeners and clears input fields.

Kind: global function

prepareStartAnimation(event)

Starts the animation on the given element.

Kind: global function

Param	Type	Description
event	`Event`	The event containing the current target to animate.

prepareStopAnimation(event)

Prepares the stop animation for the given event target.

Kind: global function

Param	Type	Description
event	`Event`	The event object.

connectedCallback()

Lifecycle hook that gets called when the component is inserted into the DOM.

Kind: global function

disableAddButton() -- `boolean`

Determines if the Add button should be disabled based on campaign selection.

Kind: global function
Returns: boolean - - True if the Add button should be disabled, false otherwise.

handleChildCmpConnected(event)

Handles the event when a child component is connected.

Kind: global function

Param	Type	Description
event	`Event`	The event containing details of the connected child component.

handleChildCmpDisconnected(event)

Handles the disconnection of child components, setting the property to undefined.

Kind: global function

Param	Type	Description
event	`Event`	The event object.

handleCampaignCreated(event)

Handles the creation of a new campaign.

Kind: global function

Param	Type	Description
event	`Event`	The event containing details of the created campaign.

toggleAddCampaignScreen()

Toggles the visibility of the Add Campaign screen.

Kind: global function

handleSelectedCampaign(event)

Handles the selection of a campaign.

Kind: global function

Param	Type	Description
event	`Event`	The event containing details of the selected campaign.

handleAddToCampaign()

Adds the person to the selected campaign or campaign.

Kind: global function

handleAddMemberToCampaign()

Adds a member to the selected campaign.

Kind: global function

handleUpdateCampaign()

Updates the selected campaign with the new person added.

Kind: global function

close()

Closes the component and emits a close event.

Kind: global function

prepareStartAnimation(event)

Starts the animation on the given element.

Kind: global function

Param	Type	Description
event	`Event`	The event containing the current target to animate.

prepareStopAnimation(event)

Prepares the stop animation for the given event target.

Kind: global function

Param	Type	Description
event	`Event`	The event object.

appSettings() -- `Object`

Getter for the application settings.

Kind: global function
Returns: Object - The current application settings.

appSettings(value)

Setter for the application settings, updates call results based on the new settings.

Kind: global function

Param	Type	Description
value	`Object`	The new application settings.

options() -- `Array`

Getter for options property that returns the list of available options.

Kind: global function
Returns: Array - The current set of options.

options(value)

Setter for options property that updates the list of available options.

Kind: global function

Param	Type	Description
value	`Array`	The new set of options to be used.

connectedCallback()

Lifecycle hook that gets called when the component is inserted into the DOM.

Kind: global function

handleInputChange(event)

Updates the value of a call result based on user input.

Kind: global function

Param	Type	Description
event	`Event`	Contains information about the input change.

handleColorChange(event)

Changes the color of a specific call result item.

Kind: global function

Param	Type	Description
event	`Event`	Contains the new color value and the index of the item.

handleDelete(event)

Deletes a call result item based on its index.

Kind: global function

Param	Type	Description
event	`Event`	Contains the index of the item to delete.

handleAdd()

Adds a new call result item with default values.

Kind: global function

saveGlobalSettings()

Saves the current settings by storing the selected objects and dispatches a close event.

Kind: global function

validateValues() -- `Boolean`

Validates the values in 'callResults'. Ensures that there is at least one item present and that all items have non-empty values, showing toast messages for any validation errors.

Kind: global function
Returns: Boolean - Indicates whether the validation passed.

close()

Dispatches a close event to signal that the component should be closed.

Kind: global function

handleUpdateParentSettings()

Dispatches an event to update parent component settings with the current application settings.

Kind: global function

prepareStartAnimation(event)

Prepares the start of an animation.

Kind: global function

Param	Type	Description
event	`Event`	The event triggering the animation.

prepareStopAnimation(event)

Prepares the stop of an animation.

Kind: global function

Param	Type	Description
event	`Event`	The event triggering the stop of the animation.

handleInput(event)

Handles changes in input fields and updates the record object with new values.

Kind: global function

Param	Type	Description
event	`Event`	The event object from the input field.

handleConfirm() -- `void`

Dispatches a custom event called 'confirm' with the status as the event detail.

Kind: global function

close()

Dispatches a 'close' event to notify parent components or listeners.

Kind: global function

selectedCampaign() -- `Object`

Getter for the selectedCampaign value.

Kind: global function
Returns: Object - The current selectedCampaign object.
Api:

selectedCampaign(value)

Setter for the selectedCampaign value.

Kind: global function
Api:

Param	Type	Description
value	`Object`	The new selectedCampaign object.

appSettings() -- `Object`

Getter for the application settings.

Kind: global function
Returns: Object - The current application settings.

appSettings(value)

Setter for the application settings, updates call results based on the new settings.

Kind: global function

Param	Type	Description
value	`Object`	The new application settings.

connectedCallback()

Lifecycle hook that gets called when the component is inserted into the DOM.

Kind: global function

disconnectedCallback()

This method is triggered when the component is removed from the DOM.

Kind: global function

handleChildCmpConnected(event)

Handles the connection of child components, associating the event target with a property.

Kind: global function

Param	Type	Description
event	`Event`	The event object.

handleChildCmpDisconnected(event)

Handles the disconnection of child components, setting the property to undefined.

Kind: global function

Param	Type	Description
event	`Event`	The event object.

handleNameClick(event) -- `void`

Handles the click event and navigating to the record page.

Kind: global function

Param	Type	Description
event	`Event`	The event object.

handleSelectedCampaign(event)

Processes the selection of a campaign, including fetching related campaign members and updating campaign statuses.

Kind: global function

Param	Type	Description
event	`Event`	The event containing details of the selected campaign.

setSelectedCampaign(temp) -- `Promise.<void>`

Asynchronously sets the selected campaign state to a new value, ensuring state consistency.

Kind: global function
Returns: Promise.<void> - A promise that resolves once the selected campaign has been updated.

Param	Type	Description
temp	`Object`	The temporary campaign object representing the new state.

fetchCampaignMembers(campaignId) -- `Promise`

Fetches campaign members for the selected campaign.

Kind: global function
Returns: Promise - A promise that resolves with the fetched campaign members.

Param	Type	Description
campaignId	`String`	The ID of the campaign.

fetchQuickCampaignByCampaignId(campaignId) -- `Promise`

Fetches the quick campaign associated with the selected campaign.

Kind: global function
Returns: Promise - A promise that resolves with the fetched quick campaign.

Param	Type	Description
campaignId	`String`	The ID of the campaign.

handleCampaignDifferences(temp, selectedCampaign)

Handles the differences between the selected campaign and the fetched quick campaign.

Kind: global function

Param	Type	Description
temp	`Object`	The temporary campaign object.
selectedCampaign	`Object`	The currently selected campaign object.

handleCreateQuickCampaign()

Creates a new quick campaign record for the selected campaign.

Kind: global function

handleCallCampaign()

Triggers an event to start the calling process for the current selected campaign.

Kind: global function

handleTextCampaign()

Triggers an event to start the texting campaign process for the current selected campaign.

Kind: global function

handleUpdateCampaign(callingPersonId)

Invokes status update processes for campaign items, optionally focusing on a specific calling person by ID.

Kind: global function
Api:

Param	Type	Description
callingPersonId	`String`	The ID of the person being called. This parameter is optional.

isSalesforceCampaign() -- `Boolean`

Indicates whether the selected campaign is a Salesforce campaign.

Kind: global function
Returns: Boolean - True if the object is a Salesforce campaign, otherwise false.

disableCampaignOptions() -- `Boolean`

Computes a boolean value to enable or disable campaign options based on edit mode and campaign ID presence.

Kind: global function
Returns: Boolean - True if the options should be disabled, otherwise false.

disableCallCampaignButton() -- `Boolean`

Computes a boolean value to enable or disable the Call Campaign button based on campaign JSON presence.

Kind: global function
Returns: Boolean - True if the button should be disabled, otherwise false.

disableCreateButton() -- `Boolean`

Computes a boolean value to enable or disable the Edit Campaign button based on the edit mode.

Kind: global function
Returns: Boolean - True if the button should be disabled, otherwise false.

handleCampaignTypeChanged(event)

Handles the click event and toggles the edit mode.

Kind: global function

Param	Type	Description
event	`Object`	The event object containing the campaign type.

disableTextCampaignButton() -- `Boolean`

Computes a boolean value to enable or disable the Text Campaign button based on campaign JSON presence.

Kind: global function
Returns: Boolean - True if the button should be disabled, otherwise false.

handleUpdateQuickCampaignRecord() -- `Promise.<void>`

Updates the user record with SIP credentials.

Kind: global function
Returns: Promise.<void> - Represents the completion of an asynchronous operation.

handleAddMembersToCampaign() -- `Promise.<void>`

Handles the addition of new members to the selected campaign.

Kind: global function
Returns: Promise.<void> - Represents the completion of an asynchronous operation.

handleCancelSave()

Cancels the save operation and reverts the campaign changes.

Kind: global function

handleUpdateCampaignItemsStatuses(callingPersonId)

Handles the update of campaign items' statuses, optionally scrolling to a specific calling person.

Kind: global function

Param	Type	Description
callingPersonId	`String`	The ID of the calling person to scroll to.

scrollToElement(element)

Scrolls the main content to the provided element.

Kind: global function

Param	Type	Description
element	`HTMLElement`	The element to scroll to.

handleContactClicked(event)

Handles the click event on a contact item.

Kind: global function

Param	Type	Description
event	`Event`	The click event.

handleDragStart(event)

Handles the dragstart event on a campaign item.

Kind: global function

Param	Type	Description
event	`Event`	The dragstart event.

handleDragOver(event)

Handles the dragover event on a campaign item.

Kind: global function

Param	Type	Description
event	`Event`	The dragover event.

handleDragEnter(event)

Handles the dragenter event on a campaign item.

Kind: global function

Param	Type	Description
event	`Event`	The dragenter event.

handleDragLeave(event)

Handles the dragleave event on a campaign item.

Kind: global function

Param	Type	Description
event	`Event`	The dragleave event.

handleDragEnd(event)

Handles the dragend event on a campaign item.

Kind: global function

Param	Type	Description
event	`Event`	The dragend event.

handleDrop(event)

Handles the drop event on a campaign item.

Kind: global function

Param	Type	Description
event	`Event`	The drop event.

handleDeleteCampaignItem(event)

Handles the deletion of a campaign item.

Kind: global function

Param	Type	Description
event	`Event`	The event triggered by the deletion action.

handleResetStatus(event)

Resets the status of a campaign item.

Kind: global function

Param	Type	Description
event	`Event`	The event triggered by the reset status action.

handleShowDetails(event)

Shows the details of a campaign item.

Kind: global function

Param	Type	Description
event	`Event`	The event triggered by the show details action.

handleHideDetails(event)

Hides the details of a campaign item.

Kind: global function

Param	Type	Description
event	`Event`	The event triggered by the hide details action.

prepareStartAnimation(event)

Prepares the start of an animation.

Kind: global function

Param	Type	Description
event	`Event`	The event triggering the animation.

prepareStopAnimation(event)

Prepares the stop of an animation.

Kind: global function

Param	Type	Description
event	`Event`	The event triggering the stop of the animation.

handleExit()

Emits an event to exit the settings interface.

Kind: global function

toggleAddCampaignScreen()

Allows users to either show or hide the Add Campaign screen, facilitating the addition of a new campaign.

Kind: global function

handleEditCampaign()

Sets the campaign that is about to be edited as the current selected campaign without changes and enables the edit mode.

Kind: global function

toggleDeleteConfirmation()

Allows users to confirm or cancel the deletion of a campaign item by showing or hiding the delete confirmation modal.

Kind: global function

handleRecordCreatedEvent(event)

Updates the selected campaign with the new record's details and toggles the Add Campaign screen's visibility.

Kind: global function

Param	Type	Description
event	`CustomEvent`	The event containing details about the created campaign record.

handleMemberSelected(event) -- `Promise.<void>`

Updates the selected campaign with the new record's details and fetches the associated quick campaign.

Kind: global function
Returns: Promise.<void> - A promise that resolves once the selected campaign has been updated.

Param	Type	Description
event	`CustomEvent`	The event containing details about the selected campaign.

clearMemberLookup() -- `Promise.<void>`

Clears the member lookup component and resets all relevant fields.

Kind: global function
Returns: Promise.<void> - A promise that resolves once the member lookup has been cleared.

handleRecordDeleteEvent()

Handles the deletion of a campaign item, refreshes the campaign list, displays a success message, and toggles the delete confirmation modal.

Kind: global function

appSettings() -- `Object`

Getter for the application settings.

Kind: global function
Returns: Object - The current application settings.

appSettings(value)

Setter for the application settings, updates call results based on the new settings.

Kind: global function

Param	Type	Description
value	`Object`	The new application settings.

handleSelectedObjects()

Updates the selected objects from the application settings.

Kind: global function

restrictedSettings() -- `Boolean`

Getter that determines if settings are restricted based on the admin status of the user.

Kind: global function
Returns: Boolean - Returns true if the user is not an admin, restricting access to certain settings.

options() -- `Array`

Getter for options property that returns the list of available options.

Kind: global function
Returns: Array - The current set of options.

options(value)

Setter for options property that updates the list of available options.

Kind: global function

Param	Type	Description
value	`Array`	The new set of options to be used.

isAdmin() -- `Boolean`

Getter for the admin status.

Kind: global function
Returns: Boolean - True if the user is an admin, false otherwise.

isAdmin(value)

Setter for the admin status.

Kind: global function

Param	Type	Description
value	`Boolean`	The new admin status.

connectedCallback()

Lifecycle hook that gets called when the component is inserted into the DOM.

Kind: global function

handleChange(event)

Handles change events on the component, updating the list of selected objects.

Kind: global function

Param	Type	Description
event	`Event`	The change event containing the updated value.

saveGlobalSettings()

Saves the current settings by storing the selected objects and dispatches a close event.

Kind: global function

close()

Dispatches a close event to signal that the component should be closed.

Kind: global function

handleUpdateParentSettings()

Dispatches an event to update parent component settings with the current application settings.

Kind: global function

prepareStartAnimation(event)

Prepares the start of an animation.

Kind: global function

Param	Type	Description
event	`Event`	The event triggering the animation.

prepareStopAnimation(event)

Prepares the stop of an animation.

Kind: global function

Param	Type	Description
event	`Event`	The event triggering the stop of the animation.

devices() -- `Object` | `Object`

Getter for the list of devices.

Kind: global function

devices(value) -- `void`

Setter for the list of devices.

Kind: global function

Param	Type	Description
value	`Object`	The list of devices.

connectedCallback()

Lifecycle hook that gets called when the component is inserted into the DOM.

Kind: global function

loadDevices() -- `void`

Fetches the list of devices.

Kind: global function

handleChangeSpeaker(event) -- `void`

Handles the change event for the speaker dropdown.

Kind: global function

Param	Type	Description
event	`Event`	The change event.

handleChangeMicrophone(event) -- `void`

Handles the change event for the microphone dropdown.

Kind: global function

Param	Type	Description
event	`Event`	The change event.

handleSave()

Dispatches an event to update the devices.

Kind: global function

handleDispatchUpdateDevices()

Dispatches an event to update the devices.

Kind: global function

close()

Dispatches an event to close the modal.

Kind: global function

prepareStartAnimation(event)

Starts the animation on the given element.

Kind: global function

Param	Type	Description
event	`Event`	The event containing the current target to animate.

prepareStopAnimation(event)

Prepares the stop animation for the given event target.

Kind: global function

Param	Type	Description
event	`Event`	The event object.

connectedCallback()

Lifecycle hook that gets called when the component is inserted into the DOM.

Kind: global function

handleClick(event)

Captures the ID of the clicked button, updates the selected button state, and dispatches a 'itemselected' custom event with the clicked button's ID as detail.

Kind: global function

Param	Type	Description
event	`Event`	The click event object.

records(value)

Setter for the records property.

Kind: global function

Param	Type	Description
value	`Object`	The records to be assigned.

records() -- `Object`

Getter for the records property.

Kind: global function
Returns: Object - The records.

connectedCallback()

Lifecycle hook that gets called when the component is inserted into the DOM.

Kind: global function

handleChildCmpConnected(event)

Handles the event when a child component is connected.

Kind: global function

Param	Type	Description
event	`Event`	The event containing details of the connected child component.

handleChildCmpDisconnected(event)

Handles the disconnection of child components, setting the property to undefined.

Kind: global function

Param	Type	Description
event	`Event`	The event object.

initializeRecordsSelection() -- `void`

Initializes the records selection based on the shouldSelectAll property.

Kind: global function

handleSelectAll(event) -- `void`

Handles the event when the user clicks the 'Select All' checkbox.

Kind: global function

Param	Type	Description
event	`Event`	The event object.

handleCheckboxChange(event) -- `void`

Handles the change event when a checkbox is clicked.

Kind: global function

Param	Type	Description
event	`Event`	The event object.

handleSelectedWhatId(event) -- `void`

Handles the event when a record is selected in the custom lookup component.

Kind: global function

Param	Type	Description
event	`CustomEvent`	The event object.

handleSave()

Logs all selected records (their ID and Name) to the console.

Kind: global function

handleSkip()

Dispatches a 'skip' event to notify parent components or listeners.

Kind: global function

handleCancel()

Dispatches a 'cancel' event to notify parent components or listeners.

Kind: global function

prepareStartAnimation(event)

Prepares the start animation for the given event target.

Kind: global function

Param	Type	Description
event	`Event`	The event object.

prepareStopAnimation(event)

Prepares the stop animation for the given event target.

Kind: global function

Param	Type	Description
event	`Event`	The event object.

handleExit(component) -- `Promise.<void>`

Handles the exit action

Kind: global function

Param	Type	Description
component	`object`	The component

handleQuickCampaignNavigation(component) -- `Promise.<void>`

Handles the quick campaign navigation

Kind: global function

Param	Type	Description
component	`object`	The component

handleNextNavigation(component) -- `Promise.<void>`

Handles the next navigation

Kind: global function

Param	Type	Description
component	`object`	The component

finishNavigation(component, state) -- `Promise.<void>`

Finishes navigation

Kind: global function

Param	Type	Description
component	`object`	The component
state	`object`	The state

shouldShowMultipleRecords(component) -- `boolean`

Determines if we should show the multiple records screen

Kind: global function
Returns: boolean - - True if we should show the multiple records screen

Param	Type	Description
component	`object`	The component

shouldShowUnsavedChanges(component) -- `boolean`

Determines if we should show the unsaved changes screen

Kind: global function
Returns: boolean - - True if we should show the unsaved changes screen

Param	Type	Description
component	`object`	The component

canShowScreens(component) -- `boolean`

Determines if we can show screens

Kind: global function
Returns: boolean - - True if we can show screens

Param	Type	Description
component	`object`	The component

handleIdleState(component, action, state) -- `Promise.<void>`

Handles the idle state

Kind: global function

Param	Type	Description
component	`object`	The component
action	`string`	The action
state	`object`	The state

handleStatusScreenState(component, action, state) -- `Promise.<void>`

Handles the status screen state

Kind: global function

Param	Type	Description
component	`object`	The component
action	`string`	The action
state	`object`	The state

handleMultipleRecordsState(component, action, state) -- `Promise.<void>`

Handles the multiple records state

Kind: global function

Param	Type	Description
component	`object`	The component
action	`string`	The action
state	`object`	The state

unsavedChangesState(component, action, state) -- `Promise.<void>`

Handles the unsaved changes state

Kind: global function

Param	Type	Description
component	`object`	The component
action	`string`	The action
state	`object`	The state

handleNavigation(component, action, state) -- `Promise.<void>`

Handles the navigation

Kind: global function

Param	Type	Description
component	`object`	The component
action	`string`	The action
state	`object`	The state

appSettings() -- `Object`

Getter for the app settings.

Kind: global function
Returns: Object - The current app settings.

appSettings(value)

Setter for the app settings.

Kind: global function

Param	Type	Description
value	`Object`	The new app settings.

userData() -- `Object`

Getter for the user data.

Kind: global function
Returns: Object - The current user data.

userData(value)

Setter for the user data.

Kind: global function
Api:

Param	Type	Description
value	`Object`	The new user data.

sidePanelEnabled() -- `Boolean`

Getter for the side panel enabled property.

Kind: global function
Returns: Boolean - The current value of the side panel enabled property.

sidePanelEnabled(value)

Setter for the side panel enabled property. It toggles the side panel visibility based on the value.

Kind: global function
Api:

Param	Type	Description
value	`Boolean`	The new value for the side panel enabled property.

sidebarAvailable() -- `Boolean`

Getter for the sidebar available property.

Kind: global function
Returns: Boolean - The current value of the sidebar available property.

connectedCallback()

Lifecycle hook that gets called when the component is inserted into the DOM.

Kind: global function

disconnectedCallback()

This method is triggered when the component is removed from the DOM.

Kind: global function

handleSidebarChannel()

Lifecycle method called when component gets disconnected from DOM. It unsubscribes from the platform event channel.

Kind: global function

wiredMessages() -- `Promise.<void>`

Lifecycle method called when component gets disconnected from DOM. It unsubscribes from the platform event channel.

Kind: global function
Wire:

handleLoadMessages(event)

Handles the load messages event and loads the messages for the selected person.

Kind: global function

Param	Type	Description
event	`Event`	The event containing the message ID.

subscribeToPlatformEvent()

Subscribes to a platform event channel to listen for events.

Kind: global function

unsubscribeFromPlatformEvent()

Unsubscribes from the platform event channel to stop listening for events.

Kind: global function

handleSMSNotification(message)

Handles the notification of a received SMS message.

Kind: global function

Param	Type	Description
message	`Object`	The message object containing the notification details.

handleHideMessageSpinner() -- `void`

Hides the message spinner in the PhoneSidebarTextMessages component.

Kind: global function

handleRefreshMessagesAfterReceive(sender)

Refreshes the messages list after a new message is received.

Kind: global function

Param	Type	Description
sender	`String`	The phone number of the message sender.

handleFetchMessages(fetchFresh) -- `Promise.<void>`

Refreshes the messages list.

Kind: global function

Param	Type	Description
fetchFresh	`Boolean`	The flag to fetch fresh messages.

handleRefreshMessagesAfterSent(recordId, phone)

Refreshes the messages list after a new message is sent.

Kind: global function

Param	Type	Description
recordId	`String`	The ID of the message record.
phone	`String`	The phone number of the message receiver.

handleMessageSent(event)

Handles the message sent event and refreshes the messages list.

Kind: global function

Param	Type	Description
event	`Event`	The event containing the message sent details.

handleChildCmpConnected(event)

Updates the current component reference when a child component is connected.

Kind: global function

Param	Type	Description
event	`Event`	The event containing the child component's reference.

handleChildCmpDisconnected(event)

Handles the disconnection of child components, setting the property to undefined.

Kind: global function

Param	Type	Description
event	`Event`	The event object.

sidebarClass() -- `String`

Getter for the sidebar class based on the visibility of the main section.

Kind: global function
Returns: String - The sidebar class based on the visibility of the main section.

handleToggleSideBar() -- `void`

Toggles the visibility of the main section and updates the sidebar icon.

Kind: global function

handleChangeSubpage(event)

Handles the subpage change event and updates the selected subpage.

Kind: global function

Param	Type	Description
event	`Event`	The event containing the new subpage name.

handleSubpageSelect(event)

Handles the subpage select event and updates the selected subpage.

Kind: global function

Param	Type	Description
event	`Event`	The event containing the new subpage name.

showTextMessages() -- `Boolean`

Getter for the text messages visibility based on the selected subpage.

Kind: global function
Returns: Boolean - The visibility of the text messages section.

showTranscript() -- `Boolean`

Getter for the transcript visibility based on the selected subpage.

Kind: global function
Returns: Boolean - The visibility of the transcript section.

showNextBestAction() -- `Boolean`

Getter for the next best action visibility based on the selected subpage.

Kind: global function
Returns: Boolean - The visibility of the next best action section.

showSurveysSection() -- `Boolean`

Getter for the surveys visibility based on the selected subpage.

Kind: global function
Returns: Boolean - The visibility of the surveys section.

handleAddPhoneToList()

Handles the back to results event and updates the selected subpage.

Kind: global function

prepareTextMessageReceiver(data)

Prepares the person data to be added to the receivers list.

Kind: global function

Param	Type	Description
data	`Object`	The person data to be added to the receivers list.

addToReceivers(data)

Adds a person to the receivers list.

Kind: global function
Api:

Param	Type	Description
data	`Object`	The person data to be added to the receivers list.

sendTextCampaign(data)

Sends a text campaign to the selected person.

Kind: global function
Api:

Param	Type	Description
data	`Object`	The person data to send the text campaign to.

handleAssignPerson()

Handles the back to results event and updates the selected subpage.

Kind: global function

handleCloseTextWindow()

Handles the back to results event and updates the selected subpage.

Kind: global function

handlePersonSelect()

Handles the back to results event and updates the selected subpage.

Kind: global function

handleCallPerson()

Handles call person event.

Kind: global function

handleMessageSend()

Handles message send event.

Kind: global function

selectedSubpage() -- `String`

Determines which subpage is currently selected.

Kind: global function
Returns: String - The name of the selected subpage.

selectedSubpage(value)

Setter for the _selectedSubpage value.

Kind: global function
Api:

Param	Type	Description
value	`Object`	The new _selectedSubpage object.

connectedCallback()

Lifecycle hook that gets called when the component is inserted into the DOM.

Kind: global function

smsFeatureAvailable() -- `Boolean`

Getter that determines if the Two Way SMS Feature is enabled.

Kind: global function
Returns: Boolean - Returns true if the user has access the feature.

getDisabledFeature() -- `Boolean`

Dummy method to return false for features that are not yet ready.

Kind: global function
Returns: Boolean - Returns false.

textMessagesButtonClass() -- `String`

Determines the class for the 'Text Messages' button.

Kind: global function
Returns: String - The class for the 'Text Messages' button

transcriptButtonClass() -- `String`

Determines the class for the 'Transcript' button.

Kind: global function
Returns: String - The class for the 'Transcript' button

nextBestActionClass() -- `String`

Determines the class for the 'Next Best Action' button.

Kind: global function
Returns: String - The class for the 'Next Best Action' button

otherSectionClass() -- `String`

Determines the class for the 'Surveys' button.

Kind: global function
Returns: String - The class for the 'Surveys' button

handleClick() -- `String`

Determines the class for the 'Settings' button.

Kind: global function
Returns: String - The class for the 'Settings' button

appSettings() -- `Object`

Getter for the app settings.

Kind: global function
Returns: Object - The current app settings.

appSettings(value)

Setter for the app settings.

Kind: global function

Param	Type	Description
value	`Object`	The new app settings.

userData() -- `Object`

Getter for the user data.

Kind: global function
Returns: Object - The current user data.

userData(value)

Setter for the user data.

Kind: global function
Api:

Param	Type	Description
value	`Object`	The new user data.

textMessagesConfigurated() -- `Boolean`

Getter for the text message configuration.

Kind: global function
Returns: Boolean - True if the text message provider is configured.

connectedCallback()

Lifecycle hook that gets called when the component is inserted into the DOM.

Kind: global function

disconnectedCallback()

This method is triggered when the component is removed from the DOM.

Kind: global function

selectedPerson()

Handles selecting a person from the list.

Kind: global function

selectedPerson(value)

Setter for the selected person.

Kind: global function

Param	Type	Description
value	`Object`	The selected person object.

receivers()

Getter for the list of receivers.

Kind: global function

receivers(value)

Setter for the list of receivers.

Kind: global function

Param	Type	Description
value	`Object`	The list of receivers.

handleMessageSent(event)

Handles the event to show the spinner.

Kind: global function

Param	Type	Description
event	`Event`	The event containing the spinner details.

handleChildCmpConnected(event)

Updates the current component reference when a child component is connected.

Kind: global function

Param	Type	Description
event	`Event`	The event containing the child component's reference.

handleChildCmpDisconnected(event)

Handles the disconnection of child components, setting the property to undefined.

Kind: global function

Param	Type	Description
event	`Event`	The event object.

handlePersonSelect(event) -- `void`

Handles person selection.

Kind: global function

Param	Type	Description
event	`Event`	The event object

handleLoadMessages(event) -- `void`

Handles the load more messages event.

Kind: global function

Param	Type	Description
event	`Event`	The event object.

hideMessageSpinner()

Handles the event to show the spinner.

Kind: global function

handleCallPerson()

Handles calling a person.

Kind: global function

handleCloseTextWindow()

Handles sending a text message to a person.

Kind: global function

handleAddPhoneToList()

Handles sending a text message to a person.

Kind: global function

receivers() -- `Array`

Getter for the list of receivers.

Kind: global function
Returns: Array - An array of receivers.

receivers(value)

Setter for the list of receivers.

Kind: global function

Param	Type	Description
value	`Array`	The list of receivers.

selectedPerson() -- `Object`

Getter for the selected person.

Kind: global function
Returns: Object - The selected person.

selectedPerson(value)

Setter for the selected person.

Kind: global function

Param	Type	Description
value	`Object`	The selected person.

connectedCallback()

Lifecycle hook that gets called when the component is inserted into the DOM.

Kind: global function

disconnectedCallback()

This method is triggered when the component is removed from the DOM.

Kind: global function

handlePersonClick(event)

Handles the person click event.

Kind: global function

Param	Type	Description
event	`Event`	The event object

getPersonItemClass(messageId) -- `String`

Determines the class for the person item.

Kind: global function
Returns: String - The class for the person item.

Param	Type	Description
messageId	`String`	The message ID.

isAdmin() -- `Boolean`

Getter for the admin status.

Kind: global function
Returns: Boolean - True if the user is an admin, false otherwise.

isAdmin(value)

Setter for the admin status.

Kind: global function

Param	Type	Description
value	`Boolean`	The new admin status.

userData() -- `Object`

Getter for the user data.

Kind: global function
Returns: Object - The current user data.

userData(value)

Setter for the user data.

Kind: global function
Api:

Param	Type	Description
value	`Object`	The new user data.

appSettings() -- `Object`

Getter for the application settings.

Kind: global function
Returns: Object - The current application settings.

appSettings(value)

Setter for the application settings, updates call results based on the new settings.

Kind: global function

Param	Type	Description
value	`Object`	The new application settings.

decryptionKeyAvailable() -- `Boolean`

Getter for the decryption key field aviablity.

Kind: global function
Returns: Boolean - True if the decryption key field should be shown, false otherwise.

smsTwoWayFeatureAvailable() -- `Boolean`

Getter that determines if the user should see two way text messages settings.

Kind: global function
Returns: Boolean - Returns true if the user has access to text two way messages settings due to feature availability.

handleSetValueForSelect() -- `void`

Handles the change event for the input fields.

Kind: global function

textMessageProvider() -- `Object`

Getter for the text messages providers list.

Kind: global function
Returns: Object - The current text messages providers list.

textMessageProvider(value)

Setter for the text messages providers list.

Kind: global function
Api:

Param	Type	Description
value	`Object`	The new text messages providers list.

isProviderSelected() -- `Boolean`

Getter for the provider selected status.

Kind: global function
Returns: Boolean - True if a provider is selected, false otherwise.

handleProviderChange(event)

Event handler for when the object type dropdown value changes. Clears and updates input fields based on the selected object type.

Kind: global function

Param	Type	Description
event	`Event`	The event object from the dropdown.

handleUpdateInputs(providerName)

Updates the input fields based on the selected provider.

Kind: global function

Param	Type	Description
providerName	`String`	The name of the selected provider

handleChange(event)

Handles the change event for the input fields.

Kind: global function

Param	Type	Description
event	`Event`	The event object.

handleChangePhone(event)

Handles the change event for the phone input field.

Kind: global function

Param	Type	Description
event	`Event`	The event object.

showUserToken() -- `Boolean`

Getter to determine if user token field should be displayed

Kind: global function
Returns: Boolean - True if VoIPstudio is selected, false otherwise

showApiCredentials() -- `Boolean`

Getter to determine if API credentials should be displayed

Kind: global function
Returns: Boolean - True if a provider other than VoIPstudio is selected

saveSettings(event) -- `void`

Handles the click event for the save button.

Kind: global function

Param	Type	Description
event	`Event`	The event object.

saveTextMessageSettings()

Handles the click event for the save button.

Kind: global function

saveGlobalSettings()

Saves the current settings by storing the selected objects and dispatches a close event.

Kind: global function

handleInformParentTextMessagesSettings()

Dispatches an event to update parent component settings with the current text message settings.

Kind: global function

handleUpdateParentSettings()

Dispatches an event to update parent component settings with the current application settings.

Kind: global function

handleUpdatePhone(event)

Handles the click event for the cancel button.

Kind: global function

Param	Type	Description
event	`Event`	The event object.

close()

Dispatches a close event to signal that the component should be closed.

Kind: global function

prepareStartAnimation(event)

Starts the animation on the given element.

Kind: global function

Param	Type	Description
event	`Event`	The event containing the current target to animate.

prepareStopAnimation(event)

Prepares the stop animation for the given event target.

Kind: global function

Param	Type	Description
event	`Event`	The event object.

userData() -- `Object`

Getter for the user data.

Kind: global function
Returns: Object - The current user data.

userData(value)

Setter for the user data.

Kind: global function
Api:

Param	Type	Description
value	`Object`	The new user data.

playCookie() -- `String`

Getter for the playCookie property.

Kind: global function
Returns: String - The playCookie property.

playCookie(value)

Setter for the playCookie property.

Kind: global function
Api:

Param	Type	Description
value	`String`	The new playCookie value.

playsessionId() -- `String`

Getter for the playsessionId property.

Kind: global function
Returns: String - The playsessionId property.

playsessionId(value)

Setter for the playsessionId property.

Kind: global function
Api:

Param	Type	Description
value	`String`	The new playsessionId value.

showCallButton() -- `Boolean`

Getter for the showCallButton property.

Kind: global function
Returns: Boolean - True if the phone number is not empty.

messages() -- `Array`

Getter for the messages property.

Kind: global function
Returns: Array - The messages property.

objectIconUrl() -- `String`

Getter for the userIconUrl property.

Kind: global function
Returns: String - The userIconUrl property.

messages(value)

Setter for the messages property.

Kind: global function
Api:

Param	Type	Description
value	`Array`	The new messages value.

selectedPerson() -- `Object`

Getter for the selectedPerson property.

Kind: global function
Returns: Object - The selectedPerson property.

selectedPerson(value)

Setter for the selectedPerson property.

Kind: global function
Api:

Param	Type	Description
value	`Object`	The new selectedPerson value.

smsTwoWayFeatureAvailable() -- `Boolean`

Getter that determines if the user should see two way text messages.

Kind: global function
Returns: Boolean - Returns true if the user has access to text two way messages due to feature availability.

scrollToBottom()

Scrolls to the bottom of the message history area.

Kind: global function

connectedCallback()

Lifecycle hook that gets called when the component is inserted into the DOM.

Kind: global function

disconnectedCallback()

This method is triggered when the component is removed from the DOM.

Kind: global function

handlePhoneNumberChange(event)

Handles the phone number change event.

Kind: global function

Param	Type	Description
event	`Event`	The phone number change event.

handleAddPhoneToList()

Handles the add phone to list event.

Kind: global function

charactersLeft() -- `String`

Handles the character left counter.

Kind: global function
Returns: String - The new message text.

handleOnChangeText(event)

Handles the message text change event.

Kind: global function

Param	Type	Description
event	`Event`	The message text change event.

messageInputValue() -- `String`

Getter for the messageInputValue property.

Kind: global function
Returns: String - The messageInputValue property.

handleNameClick()

Handles the name click event.

Kind: global function

handleSendMessage(data)

Handles the send message event.

Kind: global function

Param	Type	Description
data	`Object`	The data object.

handleLoadMessages() -- `void`

Handles the load more messages event.

Kind: global function

handleSendSingleMessage()

Sends a single message.

Kind: global function

fetchFreshPersonDetailsBeforeSent(recordId) -- `void`

Fetches fresh person details before sending the message.

Kind: global function

Param	Type	Description
recordId	`String`	The record ID of the person.

handleSendMessagesToCampaign()

Sends a message to a campaign.

Kind: global function

handleUpdateCampaignMessages()

Updates the message history and task for a campaign.

Kind: global function

fetchCampaignMembers(campaignId) -- `Promise`

Fetches the campaign members.

Kind: global function
Returns: Promise - A promise that resolves with the fetched campaign members.

Param	Type	Description
campaignId	`String`	The campaign ID.

fetchQuickCampaignById(campaignId) -- `Promise`

Fetches the quick campaign associated with the selected campaign.

Kind: global function
Returns: Promise - A promise that resolves with the fetched quick campaign.

Param	Type	Description
campaignId	`String`	The ID of the campaign.

sendAndUpdateMessages(payload)

Updates the message history and task.

Kind: global function

Param	Type	Description
payload	`Object`	The SMS message payload

handleInformParent(cookie, sessionId, refreshImmediately)

Informs the parent component that a message has been sent.

Kind: global function

Param	Type	Description
cookie	`String`	The cookie.
sessionId	`String`	The session ID.
refreshImmediately	`Boolean`	True if the parent should refresh immediately

handleTimestampClick(event) -- `void`

Handles the timestamp click event.

Kind: global function

Param	Type	Description
event	`Event`	The timestamp click event.

startSendingSpinnerTimeout()

Sets a timeout to hide the sending spinner after 30 seconds

Kind: global function

startMessageSpinnerTimeout()

Sets a timeout to hide the message spinner after 30 seconds

Kind: global function

hideSendingSpinner()

Handles hiding the sending spinner.

Kind: global function

hideMessageSpinner()

Handles hiding the message spinner.

Kind: global function

handleCloseWindow()

Handles the close window

Kind: global function

handleCallClick()

Handles the call click event.

Kind: global function

showError(message)

Handles the error.

Kind: global function

Param	Type	Description
message	`String`	The error message.

handleKeyDownMessenger(event)

Handles the key down event.

Kind: global function

Param	Type	Description
event	`Event`	The key down event.

handleKeyDownStartTextMsgFromInput(event)

Handles the key down event for starting conversation.

Kind: global function

Param	Type	Description
event	`Event`	The key down event.

handleKeyDownStartTextMsgFromNumber(event)

Handles the key down event for starting conversation.

Kind: global function

Param	Type	Description
event	`Event`	The key down event.

isToAddPopulated() -- `Boolean`

Getter that returns true if toAdd is populated.

Kind: global function
Returns: Boolean - - True if toAdd is populated.

isToRemovePopulated() -- `Boolean`

Getter that returns true if toRemove is populated.

Kind: global function
Returns: Boolean - - True if toRemove is populated.

handleConfirm() -- `void`

Dispatches a 'confirm' event to notify parent components or listeners.

Kind: global function

handleClose()

Dispatches a 'close' event to notify parent components or listeners.

Kind: global function

prepareStartAnimation(event)

Starts the animation on the given element.

Kind: global function

Param	Type	Description
event	`Event`	The event containing the current target to animate.

prepareStopAnimation(event)

Prepares the stop animation for the given event target.

Kind: global function

Param	Type	Description
event	`Event`	The event object.

Quakker LWC Technical Documentation - clorce/QuakkerPub GitHub Wiki

Modules

Members

Functions

AddNewNumber

module.exports ÔçÉ LightningElement --

new module.exports()

module.exports.labels

module.exports.connectedCallback()

module.exports.handleShowAddNewNumberForm()

module.exports.handleShowLinkNumberForm()

module.exports.handleSelectCustomLookupRecord(event)

module.exports.handleObjectTypeChange(event)

module.exports.updateInputs()

module.exports.handleInput(event)

module.exports.linkRecord()

module.exports.isNumberValid() -- boolean

module.exports.sanitizeNumber(number) -- string

module.exports.addRecord()

module.exports.validateInputs() -- boolean

module.exports.prepareFields() -- Object

module.exports.handleSendRecordEvent(record)

module.exports.clearInputs()

module.exports.handleBack()

module.exports.close()

module.exports.prepareStartAnimation(event)

module.exports.prepareStopAnimation(event)

AddNewTask

module.exports ÔçÉ LightningElement --

new module.exports()

module.exports.dateAsString

module.exports.labels

module.exports.connectedCallback()

module.exports.handleInputSubject(event)

module.exports.handleInputDate(event)

module.exports.handleCreateTask()

module.exports.close()

module.exports.prepareStartAnimation(event)

module.exports.prepareStopAnimation(event)

CallHistory

module.exports ÔçÉ NavigationMixin(LightningElement) --

new module.exports()

module.exports.labels

module.exports.callHistory() -- Object

module.exports.callHistory(value)

module.exports.connectedCallback()

module.exports.disconnectedCallback()

module.exports.handleSubjectClick(event)

module.exports.handleNameClick(event)

module.exports.handleCallRequest(event)

module.exports.handleScroll(event)

module.exports.handleUpdateOffsetEvent()

module.exports.handleUpdateFetchedFlag()

CallingScreen

module.exports ÔçÉ LightningElement --

new module.exports()

module.exports.labels

module.exports.connectedCallback()

module.exports.handleAcceptCall()

module.exports.handleRejectCall()

module.exports.handleContactPicked(event)

module.exports.handleUpdateResultsEvent(event)

module.exports.prepareStartAnimation(event)

module.exports.prepareStopAnimation(event)

SpinnerUtilities

SpinnerUtilities.showSpinner(messageContext)

SpinnerUtilities.hideSpinner(messageContext)

SpinnerUtilities.triggerSidebarWindow(messageContext, method, person)

SpinnerUtilities.campaignDataUpdated(campaignId)

SpinnerUtilities.sendCustomNotification(recipientsIds, targetsIds, title, body)

ContactInfo

module.exports ÔçÉ LightningElement --

new module.exports()

module.exports.contact

module.exports.contact

module.exports.isSingleContact

module.exports.isSingleContact

module.exports.callInitiated

module.exports.callInitiated

module.exports.callInProgress

module.exports ÔçÉ `LightningElement` --

module.exports.isNumberValid() -- `boolean`

module.exports.sanitizeNumber(number) -- `string`

module.exports.validateInputs() -- `boolean`

module.exports.prepareFields() -- `Object`

module.exports ÔçÉ `LightningElement` --

module.exports ÔçÉ `NavigationMixin(LightningElement)` --

module.exports.callHistory() -- `Object`

module.exports ÔçÉ `LightningElement` --

module.exports ÔçÉ `LightningElement` --

module.exports ÔçÉ `LightningElement` --

module.exports.objectApiName() -- `Object`

module.exports.objectsToAdditionalFields() -- `Object`

module.exports.handleSearchForRecord(recordId) -- `void`

module.exports.methodInput() -- `Object`

module.exports.handleDispatchEventObjectChange() -- `void`

module.exports.showRecentRecords() -- `boolean`

module.exports.isValueSelected() -- `boolean`

module.exports.handleCloseNewRecordForm(event) -- `boolean`

module.exports ÔçÉ `LightningElement` --

module.exports ÔçÉ `LightningElement` --

featureUtils.handleCheckFeature(featureName) -- `boolean`