Package com.novomind.ecom.api.iagent.messenger.connector

Annotation Interface CustomChatChannel

@Retention(RUNTIME) @Target(ANNOTATION_TYPE) public @interface CustomChatChannel

Runtime annotation used to specify custom chat channels.

Since:
12.20

  • Element Details

    • name

      String name
      Returns:
      the unique name of the CustomChatChannel
      Since:
      12.20

    • displayName

      String displayName
      Returns:
      the displayName of the CustomChatChannel
      Since:
      12.20
      Default:
      ""

    • pngIconResourcePath

      String pngIconResourcePath
      The method may return the resource path to the optional PNG icon resource of the CustomChatChannel. The image resource must be a PNG icon and should have the dimension of 30 x 30 pixel. Please specify the resource path relative to your MessengerConnectorPlugin class or absolute to the plugin JAR file of the app. e.g. "/META-INF/resources/images/myicon.png"
      Returns:
      the resource path to the optional PNG icon resource of the CustomChatChannel
      Since:
      12.20
      Default:
      ""

    • format

      CustomChatChannelMessageFormat format

      The CustomChatChannelMessageFormat which the MessengerTextMessage of this CustomChatChannel uses (TEXT by default).

      Returns:
      the CustomChatChannelMessageFormat which the MessengerTextMessages of this CustomChatChannel will use.
      Since:
      12.20
      Default:
      TEXT

    • formatElements

      CustomChatChannelMessageFormatElement[] formatElements

      The CustomChatChannelMessageFormatElements which the CustomChatChannel supports (none by default). Has no effect, if the format of the CustomChatChannel is TEXT.

      If the HTML format is chosen, MessengerTextMessages will implicitly include <br> tags instead of new lines and the additionally defined CustomChatChannelMessageFormatElements.

      Returns:
      an array of CustomChatChannelMessageFormatElement that the CustomChatChannel supports.
      Since:
      12.20
      Default:
      {}