Package com.novomind.ecom.api.iagent.frontend.chatinfo

Interface ChatInfoTabProvider

  • public interface ChatInfoTabProvider
    A ChatInfoTabProvider is used to build a custom chat info tab. ************************ !!! IMPORTANT NOTE !!! ****************************** Please note that the methods of this interface will be called very frequently triggered by user interactions in the frontend, that keep blocking until the method returns. The implementation must guarantee high performance and avoid heap garbage. Please do not implement any long term operations like web service calls or database lookups within the method implementations of this interface. Please keep in mind that the methods may be called multiple times concurrently and avoid any kind of bottle necks or synchronized code. ******************************************************************************
    Since:
    10.0.142

    • Method Detail

      • getChatInfoTab

        ChatInfoTab getChatInfoTab​(ChatInfoViewContext context)
        The method is called on plugins implementing this interface to determine all information to display a custom chat info tab view. The required information is returned through a ChatInfoTab object. If the return value is null no chat info tab will be displayed for that request. This is the default method being called on plugins implementing this interface, if none of the other methods match to the current view context.
        Parameters:
        context - The ChatInfoViewContext associated with the request to the view component
        Returns:
        The ChatInfoTab instance containing the information to display the chat info tab view.
        Since:
        10.0.142

      • getChatInfoTab

        default ChatInfoTab getChatInfoTab​(AgentChatInfoViewContext context)
        The method is called on plugins implementing this interface on all chat info views displaying agent folder chats within the personal agent folder. The method is called on plugins in the agent and supervisor application, when a chat in an agent folder is selected. If the return value is null no chat info tab will be displayed for that request.
        Parameters:
        context - The AgentChatInfoViewContext associated with the request to the view component
        Returns:
        The ChatInfoTab instance containing the information to display the chat info tab view.
        Since:
        10.0.142

      • getChatInfoTab

        default ChatInfoTab getChatInfoTab​(ArchiveAccessChatInfoViewContext context)
        The method is called on plugins implementing this interface on all chat info views displaying a chat, that has been retrieved directly via an archive access. If the return value is null no chat info tab will be displayed for that request.
        Parameters:
        context - The ArchiveAccessChatInfoViewContext associated with the request to the view component
        Returns:
        The ChatInfoTab instance containing the information to display the chat info tab view.
        Since:
        10.0.142

      • getChatInfoTab

        default ChatInfoTab getChatInfoTab​(BacklogChatInfoViewContext context)
        The method is called on plugins implementing this interface on all chat info views displaying backlog chats. If the return value is null no chat info tab will be displayed for that request.
        Parameters:
        context - The BacklogChatInfoViewContext associated with the request to the view component
        Returns:
        The ChatInfoTab instance containing the information to display the chat info tab view.
        Since:
        10.0.142

      • getChatInfoTab

        default ChatInfoTab getChatInfoTab​(SearchResultChatInfoViewContext context)
        The method is called on plugins implementing this interface on all chat info views displaying a chat, that has been retrieved by a search request. If the return value is null no chat info tab will be displayed for that request.
        Parameters:
        context - The SearchResultChatInfoViewContext associated with the request to the view component
        Returns:
        The ChatInfoTab instance containing the information to display the chat info tab view.
        Since:
        10.0.142