Package com.novomind.ecom.api.imail.common.frontend.mailinfo

Interface MailInfoTabProvider

  • public interface MailInfoTabProvider
    A MailInfoTabProvider is used to build a custom mail 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.16

    • Method Detail

      • getMailInfoTab

        MailInfoTab getMailInfoTab​(MailInfoViewContext context)
        The method is called on plugins implementing this interface to determine all information to display a custom mail info tab view. The required information is returned through a MailInfoTab object. If the return value is null no mail 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 MailInfoViewContext associated with the request to the view component
        Returns:
        The MailInfoTab instance containing the information to display the mail info tab view.
        Since:
        10.0.16

      • getMailInfoTab

        default MailInfoTab getMailInfoTab​(BacklogMailInfoViewContext context)
        The method is called on plugins implementing this interface on all mail info views displaying backlog messages. If the return value is null no mail info tab will be displayed for that request.
        Parameters:
        context - The BacklogMailInfoViewContext associated with the request to the view component
        Returns:
        The MailInfoTab instance containing the information to display the mail info tab view.
        Since:
        10.0.16

      • getMailInfoTab

        default MailInfoTab getMailInfoTab​(OutgoingMailInfoViewContext context)
        The method is called on plugins implementing this interface on all mail info views displaying outgoing messages. If the return value is null no mail info tab will be displayed for that request.
        Parameters:
        context - The OutgoingMailInfoViewContext associated with the request to the view component
        Returns:
        The MailInfoTab instance containing the information to display the mail info tab view.
        Since:
        10.0.16

      • getMailInfoTab

        default MailInfoTab getMailInfoTab​(ExternalReplyMailInfoViewContext context)
        The method is called on plugins implementing this interface on all mail info views displaying external reply messages, returning from 2nd level. If the return value is null no mail info tab will be displayed for that request.
        Parameters:
        context - The ExternalReplyMailInfoViewContext associated with the request to the view component
        Returns:
        The MailInfoTab instance containing the information to display the mail info tab view.
        Since:
        10.0.16

      • getMailInfoTab

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

      • getMailInfoTab

        default MailInfoTab getMailInfoTab​(AgentQuickCaseMailInfoViewContext context)
        The method is called on plugins implementing this interface on all mail info views displaying a quick case message. The method is called on plugins in the agent application, when a new quick case is being prepared. If the return value is null no mail info tab will be displayed for that request.
        Parameters:
        context - The AgentQuickCaseMailInfoViewContext associated with the request to the view component
        Returns:
        The MailInfoTab instance containing the information to display the mail info tab view.
        Since:
        10.0.24

      • getMailInfoTab

        default MailInfoTab getMailInfoTab​(AgentPhoneTicketMailInfoViewContext context)
        The method is called on plugins implementing this interface on all mail info views displaying a phone ticket. The method is called on plugins in the agent application, when a new phone ticket is being prepared. If the return value is null no mail info tab will be displayed for that request.
        Parameters:
        context - The AgentPhoneTicketMailInfoViewContext associated with the request to the view component
        Returns:
        The MailInfoTab instance containing the information to display the mail info tab view.
        Since:
        12.9

      • getMailInfoTab

        default MailInfoTab getMailInfoTab​(AgentBacklogMailInfoViewContext context)
        The method is called on plugins implementing this interface on all mail info views displaying messages in the iAGENT agent application on the message folder for inquiries, forwarded or resubmitted tickets. If the return value is null no mail info tab will be displayed for that request.
        Parameters:
        context - The AgentBacklogMailInfoViewContext associated with the request to the view component
        Returns:
        The MailInfoTab instance containing the information to display the mail info tab view.
        Since:
        10.0.16

      • getMailInfoTab

        default MailInfoTab getMailInfoTab​(AgentDraftMailInfoViewContext context)
        The method is called on plugins implementing this interface on all mail info views displaying messages in the iAGENT agent application on the agent's draft folder. If the return value is null no mail info tab will be displayed for that request.
        Parameters:
        context - The AgentDraftMailInfoViewContext associated with the request to the view component
        Returns:
        The MailInfoTab instance containing the information to display the mail info tab view.
        Since:
        10.0.16

      • getMailInfoTab

        default MailInfoTab getMailInfoTab​(AgentOutgoingMailInfoViewContext context)
        The method is called on plugins implementing this interface on all mail info views displaying messages in the iAGENT agent application on the agent's sent folder. If the return value is null no mail info tab will be displayed for that request.
        Parameters:
        context - The AgentOutgoingMailInfoViewContext associated with the request to the view component
        Returns:
        The MailInfoTab instance containing the information to display the mail info tab view.
        Since:
        10.0.16

      • getMailInfoTab

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

      • getMailInfoTab

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

      • getMailInfoTab

        default MailInfoTab getMailInfoTab​(ClaimMailInfoViewContext context)
        The method is called on plugins implementing this interface on all mail info views displaying a ticket from an iCLAIM view. If the return value is null no mail info tab will be displayed for that request.
        Parameters:
        context - The ClaimMailInfoViewContext associated with the request to the view component
        Returns:
        The MailInfoTab instance containing the information to display the mail info tab view.
        Since:
        10.0.16