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

Class AgentMailEditorAppearance

  • public final class AgentMailEditorAppearance
extends java.lang.Object
    This class is used to customize the appearance of the agent's mail editor within the novomind iAGENT Desk application. This class can only be used within the novomind iAGENT Desk application.
    Since:
    11.1

    • Method Detail

      • defaults

        public static AgentMailEditorAppearance defaults()
        Creates an instance of AgentMailEditorAppearance using defaults.
        Returns:
        an instance of AgentMailEditorAppearance with default settings.
        Since:
        11.1

      • isClearanceRequired

        public java.util.Optional<java.lang.Boolean> isClearanceRequired()
        The method returns the current ability to enable or disable a clearance authorization of the final answer on a ticket before being sent.
        Returns:
        a non empty Optional if the default ability is overriden or an empty Optional for the default ability.
        Since:
        11.1

      • enableClearanceRequired

        public AgentMailEditorAppearance enableClearanceRequired()
        The method overrides the default ability and enforces a clearance authorization of the final answer on a ticket before being sent.
        Returns:
        this
        Since:
        11.1

      • disableClearanceRequired

        public AgentMailEditorAppearance disableClearanceRequired()
        The method overrides the default ability and disables the clearance authorization of the final answer on a ticket before being sent. Please note that other plugins may also override the default ability for this feature. If another plugin enables the feature on this view context, this method will not take any effect.
        Returns:
        this
        Since:
        11.1

      • isSpellcheckRequired

        public java.util.Optional<java.lang.Boolean> isSpellcheckRequired()
        The method returns the current ability to enable or disable the obligation of a spell check of the answer on a ticket before being sent.
        Returns:
        a non empty Optional if the default ability is overriden or an empty Optional for the default ability.
        Since:
        11.1

      • enableSpellcheckRequired

        public AgentMailEditorAppearance enableSpellcheckRequired()
        The method overrides the default ability and enforces a spell check of the answer on a ticket before being sent.
        Returns:
        this
        Since:
        11.1

      • disableSpellcheckRequired

        public AgentMailEditorAppearance disableSpellcheckRequired()
        The method overrides the default ability and disables the obligation of a spell check of the answer on a ticket before being sent. Please note that other plugins may also override the default ability for this feature. If another plugin enables the obligation and enforces the feature on this view context, this method will not take any effect.
        Returns:
        this
        Since:
        11.1

      • isExternalForwardAndProcessAllowed

        public java.util.Optional<java.lang.Boolean> isExternalForwardAndProcessAllowed()
        The method returns the current ability to allow or disallow the feature of externally forwarding and processing a message.
        Returns:
        a non empty Optional if the default ability is overriden or an empty Optional for the default ability.
        Since:
        11.1

      • allowExternalForwardAndProcess

        public AgentMailEditorAppearance allowExternalForwardAndProcess()
        The method overrides the default ability and allows the feature of externally forwarding and processing a message. Please note that other plugins may also override the default ability for this feature. If another plugin disallows the feature on this view context, this method will not take any effect.
        Returns:
        this
        Since:
        11.1

      • disallowExternalForwardAndProcess

        public AgentMailEditorAppearance disallowExternalForwardAndProcess()
        The method overrides the default ability and disallows the feature of externally forwarding and processing a message.
        Returns:
        this
        Since:
        11.1

      • isExternalForwardAndCloseAllowed

        public java.util.Optional<java.lang.Boolean> isExternalForwardAndCloseAllowed()
        The method returns the current ability to allow or disallow the feature of externally forwarding a message and closing the ticket.
        Returns:
        a non empty Optional if the default ability is overriden or an empty Optional for the default ability.
        Since:
        11.1

      • allowExternalForwardAndClose

        public AgentMailEditorAppearance allowExternalForwardAndClose()
        The method overrides the default ability and allows the feature of externally forwarding a message and closing the ticket. Please note that other plugins may also override the default ability for this feature. If another plugin disallows the feature on this view context, this method will not take any effect.
        Returns:
        this
        Since:
        11.1

      • disallowExternalForwardAndClose

        public AgentMailEditorAppearance disallowExternalForwardAndClose()
        The method overrides the default ability and disallows the the feature of externally forwarding a message and closing the ticket.
        Returns:
        this
        Since:
        11.1

      • isExternalForwardAndKeepAllowed

        public java.util.Optional<java.lang.Boolean> isExternalForwardAndKeepAllowed()
        The method returns the current ability to allow or disallow the feature of externally forwarding a message and keep the message in the agent's personal inbox to continue processing the ticket.
        Returns:
        a non empty Optional if the default ability is overriden or an empty Optional for the default ability.
        Since:
        11.1

      • allowExternalForwardAndKeep

        public AgentMailEditorAppearance allowExternalForwardAndKeep()
        The method overrides the default ability and allows the feature of externally forwarding a message and keep the message in the agent's personal inbox to continue processing the ticket. Please note that other plugins may also override the default ability for this feature. If another plugin disallows the feature on this view context, this method will not take any effect.
        Returns:
        this
        Since:
        11.1

      • disallowExternalForwardAndKeep

        public AgentMailEditorAppearance disallowExternalForwardAndKeep()
        The method overrides the default ability and disallows the feature of externally forwarding a message and keep the message in the agent's personal inbox to continue processing the ticket.
        Returns:
        this
        Since:
        11.1

      • isExternalInquiryAllowed

        public java.util.Optional<java.lang.Boolean> isExternalInquiryAllowed()
        The method returns the current ability to allow or disallow the feature of sending an external inquiry message.
        Returns:
        a non empty Optional if the default ability is overriden or an empty Optional for the default ability.
        Since:
        11.1

      • allowExternalInquiry

        public AgentMailEditorAppearance allowExternalInquiry()
        The method overrides the default ability and allows the feature of sending an external inquiry message. Please note that other plugins may also override the default ability for this feature. If another plugin disallows the feature on this view context, this method will not take any effect.
        Returns:
        this
        Since:
        11.1

      • disallowExternalInquiry

        public AgentMailEditorAppearance disallowExternalInquiry()
        The method overrides the default ability and disallows the feature of sending an external inquiry message.
        Returns:
        this
        Since:
        11.1

      • isSendIntermediateReplyAllowed

        public java.util.Optional<java.lang.Boolean> isSendIntermediateReplyAllowed()
        The method returns the current ability to allow or disallow the feature of sending an intermediate reply message.
        Returns:
        a non empty Optional if the default ability is overriden or an empty Optional for the default ability.
        Since:
        11.1

      • allowSendIntermediateReply

        public AgentMailEditorAppearance allowSendIntermediateReply()
        The method overrides the default ability and allows the feature of sending an intermediate reply message. Please note that other plugins may also override the default ability for this feature. If another plugin disallows the feature on this view context, this method will not take any effect.
        Returns:
        this
        Since:
        11.1

      • disallowSendIntermediateReply

        public AgentMailEditorAppearance disallowSendIntermediateReply()
        The method overrides the default ability and disallows the feature of sending an intermediate reply message.
        Returns:
        this
        Since:
        11.1

      • isSendAfterClearanceAllowed

        public java.util.Optional<java.lang.Boolean> isSendAfterClearanceAllowed()
        The method returns the current ability to allow or disallow the feature of sending a message as answer and requesting a clearance authorization by manual choice of the agent.
        Returns:
        a non empty Optional if the default ability is overriden or an empty Optional for the default ability.
        Since:
        11.1

      • allowSendAfterClearance

        public AgentMailEditorAppearance allowSendAfterClearance()
        The method overrides the default ability and allows the feature of sending a message as answer and requesting a clearance authorization by manual choice of the agent. Please note that other plugins may also override the default ability for this feature. If another plugin disallows the feature on this view context, this method will not take any effect.
        Returns:
        this
        Since:
        11.1

      • disallowSendAfterClearance

        public AgentMailEditorAppearance disallowSendAfterClearance()
        The method overrides the default ability and disallows the feature of sending a message as answer and requesting a clearance authorization by manual choice of the agent.
        Returns:
        this
        Since:
        11.1

      • isCloseWithoutAnswerAllowed

        public java.util.Optional<java.lang.Boolean> isCloseWithoutAnswerAllowed()
        The method returns the current ability to allow or disallow the feature of closing a message without sending a message as answer by manual choice of the agent.
        Returns:
        a non empty Optional if the default ability is overriden or an empty Optional for the default ability.
        Since:
        11.15

      • allowCloseWithoutAnswer

        public AgentMailEditorAppearance allowCloseWithoutAnswer()
        The method overrides the default ability and allows the feature of closing a message without sending a message as answer by manual choice of the agent. Please note that other plugins may also override the default ability for this feature. If another plugin disallows the feature on this view context, this method will not take any effect.
        Returns:
        this
        Since:
        11.15

      • disallowCloseWithoutAnswer

        public AgentMailEditorAppearance disallowCloseWithoutAnswer()
        The method overrides the default ability and disallows the feature of closing a message without sending a message as answer by manual choice of the agent.
        Returns:
        this
        Since:
        11.15

      • isAssignTagsAllowed

        public java.util.Optional<java.lang.Boolean> isAssignTagsAllowed()
        The method returns the current ability to allow or disallow the feature of assigning tags.
        Returns:
        a non-empty Optional if the default ability is overriden or an empty Optional for the default ability.
        Since:
        12.36

      • allowAssignTags

        public AgentMailEditorAppearance allowAssignTags()
        The method overrides the default ability and allows the feature of assigning tags.

        Please note that other plugins may also override the default ability for this feature. If another plugin disallows the feature on this view context, this method will not take any effect.

        Returns:
        this
        Since:
        12.36

      • disallowAssignTags

        public AgentMailEditorAppearance disallowAssignTags()
        The method overrides the default ability and disallows the feature of assigning tags.
        Returns:
        this
        Since:
        12.36