Package com.novomind.ecom.api.imail.agent.frontend.editor

Interface AgentMailEditorAppearanceProvider

  • public interface AgentMailEditorAppearanceProvider

    A AgentMailEditorAppearanceProvider is used to customize the appearance of the agent's editor. This interface can only be used within the novomind iAGENT Desk application.

    Since:
    11.1

    • Method Detail

      • getAgentMailEditorAppearance

        AgentMailEditorAppearance getAgentMailEditorAppearance​(AgentMailEditorViewContext agentMailEditorViewContext)
        The method is called on plugins implementing this interface to customize the appearance of the agent's mail editor for a selected message. The required information is returned through a AgentMailEditorAppearance object. If the return value is null the editor will be displayed using default system settings.
        Parameters:
        agentMailEditorViewContext - The AgentMailEditorViewContext associated with the request to the view component
        Returns:
        The AgentMailEditorAppearance instance containing the information to display the agent's mail editor, or null to maintain the default behavior.
        Since:
        11.1

      • getAgentQuickCaseMailEditorAppearance

        default AgentQuickCaseMailEditorAppearance getAgentQuickCaseMailEditorAppearance​(AgentQuickCaseMailEditorViewContext agentQuickCaseMailEditorViewContext)
        The method is called on plugins implementing this interface to customize the appearance of the agent's mail editor for a QuickCase. The required information is returned through a AgentQuickCaseMailEditorAppearance object. If the return value is null the editor will be displayed using default system settings.
        Parameters:
        agentQuickCaseMailEditorViewContext - The AgentQuickCaseMailEditorViewContext associated with the request to the view component
        Returns:
        The AgentQuickCaseMailEditorAppearance instance containing the information to display the agent's mail editor, or null to maintain the default behavior.
        Since:
        12.22

      • getAgentPhoneTicketMailEditorAppearance

        default AgentPhoneTicketMailEditorAppearance getAgentPhoneTicketMailEditorAppearance​(AgentPhoneTicketMailEditorViewContext agentPhoneTicketMailEditorViewContext)
        The method is called on plugins implementing this interface to customize the appearance of the agent's mail editor for a PhoneTicket. The required information is returned through a AgentPhoneTicketMailEditorAppearance object. If the return value is null the editor will be displayed using default system settings.
        Parameters:
        agentPhoneTicketMailEditorViewContext - The AgentPhoneTicketMailEditorViewContext associated with the request to the view component
        Returns:
        The AgentPhoneTicketMailEditorAppearance instance containing the information to display the agent's mail editor, or null to maintain the default behavior.
        Since:
        12.22