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

Class AgentMailEditorAppearance

java.lang.Object
com.novomind.ecom.api.imail.agent.frontend.editor.AgentMailEditorAppearance
public final class AgentMailEditorAppearance extends 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 Details Link icon

    • defaults Link icon

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

    • isClearanceRequired Link icon

      public Optional<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 Link icon

      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 Link icon

      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 Link icon

      public Optional<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 Link icon

      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 Link icon

      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 Link icon

      public Optional<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 Link icon

      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 Link icon

      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 Link icon

      public Optional<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 Link icon

      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 Link icon

      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 Link icon

      public Optional<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 Link icon

      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 Link icon

      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 Link icon

      public Optional<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 Link icon

      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 Link icon

      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 Link icon

      public Optional<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 Link icon

      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 Link icon

      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 Link icon

      public Optional<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 Link icon

      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 Link icon

      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 Link icon

      public Optional<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 Link icon

      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 Link icon

      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 Link icon

      public Optional<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 Link icon

      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 Link icon

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