Package com.novomind.ecom.api.imail.core.connector

Annotation Type CustomChannel

  • @Retention(RUNTIME)
@Target(ANNOTATION_TYPE)
public @interface CustomChannel

    Runtime annotation used to specify custom channels.

    Since:
    10.0.102

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String name  

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String displayName  
      java.lang.String[] messageFormatNames  
      java.lang.String pngIconResourcePath
      The method may return the resource path to the optional PNG icon resource of the CustomChannel.

    • Element Detail

      • name

        java.lang.String name
        Returns:
        The unique name of the CustomChannel
        Since:
        10.0.102

      • displayName

        java.lang.String displayName
        Returns:
        The displayName of the CustomChannel
        Since:
        10.0.102
        Default:
        ""

      • pngIconResourcePath

        java.lang.String pngIconResourcePath
        The method may return the resource path to the optional PNG icon resource of the CustomChannel. The image resource must be a PNG icon and should have the dimension of 30 x 30 pixel. Please specify the resource path relative your MessageConnectorPlugin 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 CustomChannel.
        Since:
        10.0.102
        Default:
        ""

      • messageFormatNames

        java.lang.String[] messageFormatNames
        Returns:
        The names of the MessageFormat's that are supported by this CustomChannel
        Since:
        10.0.102
        Default:
        {"TEXT"}