Chatbox
A chatbox is an element for sending and receiving chat messages. Learn more.
Additional information about this section
Store values associated with an object
- global
Indicates if an element appears on all pages or only on the current page.
- hidden
Indicates if the chatbox is visible or hidden.
- isVisible
Indicates if the element is actually visible.
- maximized
Indicates if the chatbox is maximized.
- parent
Note: This standard element property is not relevant for Chatbox.
- customClassList
A property that represents an element's custom CSS classes.
- deleted
Indicates if an element was temporarily deleted from the DOM. Use the restore function to restore the deleted element.
- rendered
Indicates if an element is currently in the DOM structure.
- id
Gets the element's ID.
- type
Gets the element's type.
Perform actions on an object
- focusChannel( )
Expands the chatbox and focuses it on the specified chat channel.
- getChannel( )
Gets a chatbox channel.
- getChannelList( )
Gets a list of available chat channels for a site visitor.
- maximize( )
Expands the chatbox and sets its maximized property to true.
- minimize( )
Collapses the chatbox and sets its maximized property to false.
- onMaximize( )
An event that fires when the chatbox is maximized.
- onMessageReceived( )
An event that fires when a site visitor receives a chat message.
- onMessageSent( )
An event that fires when a site visitor sends a chat message.
- onMinimize( )
An event that fires when the chatbox is minimized.
- onViewportEnter( )
Note: This standard element event is not relevant for Chatbox.
- onViewportLeave( )
Note: This standard element event is not relevant for Chatbox.
- scrollTo( )
Note: This standard element function is not relevant for Chatbox.
- sendMessage( )
Sends a chat message from a site visitor.
- delete( )
Deletes an element from the DOM. This is a temporary deletion. Use restore to restore the deleted element. SEO crawlers cannot find content in an element whose ...
- onMouseIn( )
Adds an event handler that runs when the pointer is moved onto the element. You can also define an event handler using the Properties and Events panel.
- onMouseOut( )
Adds an event handler that runs when the pointer is moved off of the element. You can also define an event handler using the Properties and Events panel.
- restore( )
Restores a deleted element to the DOM.
- hide( )
Hides the element and sets its hidden property to true, using an effect if specified.
- show( )
Shows the element and sets its hidden property to false, using an effect if specified.