Search.../

Chatbox

An element for sending and receiving chat messages. Learn more.

Guides

Additional information about this section

Properties

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.

  • id

    Gets the element's ID.

  • 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.

  • rendered

    Indicates if an element is currently in the DOM structure.

  • type

    Gets the element's type.

Functions

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.

  • hide( )

    Hides the element and sets its hidden property to true, using an effect if specified.

  • 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.

  • onMouseIn( )

    Adds an event handler that runs when the mouse pointer is moved onto the element. Deprecation note: The $w parameter of event handlers is being deprecated. To ...

  • onMouseOut( )

    Adds an event handler that runs when the mouse pointer is moved off of the element. Deprecation note: The $w parameter of event handlers is being deprecated. ...

  • 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.

  • show( )

    Shows the element and sets its hidden property to false, using an effect if specified.