Interface IJEMHTransportProvider

    • Field Detail

      • CONFIG_NAME_KEY

        static final String CONFIG_NAME_KEY
        Key that configurations store a display name/description for the configuration, for use in JEMH when displaying it
        See Also:
        Constant Field Values
    • Method Detail

      • deleteConfig

        void deleteConfig​(int fConfigId)
      • sendAdHocMessage

        void sendAdHocMessage​(int transportConfigId,
                              String subject,
                              String content,
                              List<String> recipients,
                              Map<String,​List<String>> params)
                       throws TransportException
        AD-Hoc notifications
        Parameters:
        transportConfigId - the transport specific config to use
        subject - , can be null, transport will ignore if not relevant, eg XMPP posting
        content - , the rendered content to use
        recipients - , list of recipient identifiers, e.g. user/chat room ID's or mobile phone numbers
        params - , a map of keys to multiple values that may be used in the given transport. E.g., for SMTP, this could be a set of SMTP mail header prefixes
        Throws:
        TransportException - if it breaks
      • getIssueEventSubject

        String getIssueEventSubject​(long eventId)
        Parameters:
        eventId - event id
        Returns:
        the issue event subject
      • needsSubjectTemplate

        boolean needsSubjectTemplate()
        hints for JEMH to enable subject template editing
        Returns:
        if subject template needed
      • needsTextTemplate

        boolean needsTextTemplate()
        hints for JEMH to enable TEXT template editing
        Returns:
        if TEXT template needed
      • needsHtmlTemplate

        boolean needsHtmlTemplate()
        hints for JEMH to enable HTML template editing
        Returns:
        if HTML template needed
      • sendTestMessage

        void sendTestMessage​(int configId,
                             String testMessage)
                      throws TransportException
        send a test message using the given config and text
        Parameters:
        configId - the config to use
        testMessage - the message to send
        Throws:
        TransportException - if something breaks
      • isUsable

        boolean isUsable()
        If something prevents this addon from being used
        Specified by:
        isUsable in interface IJEMHModuleProvider
        Returns:
        true if this transport is usable
      • getTransportStatus

        TransportStatus getTransportStatus​(int transportConfigId)
        Parameters:
        transportConfigId - to test
        Returns:
        status of the given transport
      • getHelpURL

        String getHelpURL()
        Gets the URL that users can navigate to in order to access documentation for the transport
        Returns:
        the String representing the URL where the documentation is located