MessageObjectProvider

Overview

Dedicated to template message plugins, this interface provides a unified message-sending integration point for third-party message platforms such as WeChat and DingTalk. By implementing this interface, report push messages can be routed to a custom messaging channel.

Interface Definition

public interface MessageObjectProvider extends Mutable {

    String MARK_STRING = "MessageObjectProvider";

    int CURRENT_LEVEL = 1;

    /**
     * Message type (identifies the messaging channel for this implementation)
     */
    MessageType getMessageType();

    /**
     * Embedded component content (configurable items to display in the configuration UI)
     */
    Pair<String, String>[] getValueEditorItems();

    /**
     * Sends a message
     *
     * @param messageContent Message configuration content
     */
    void sendMessage(MessageImage messageContent);
}

MessageImage Related Interface

The MessageImage object received by sendMessage() contains all the context needed for the message:

Usage

Register your implementation class in the plugin's plugin.xml using the extra-report tag:

<extra-report>
    <MessageObjectProvider class="com.fr.plugin.demo.message.WeChatMessageObject"/>
</extra-report>

Example Code

public class WeChatMessageObject implements MessageObjectProvider {

    @Override
    public MessageType getMessageType() {
        // Return the custom message type identifier
        return MessageType.WECHAT;
    }

    @Override
    public Pair<String, String>[] getValueEditorItems() {
        // Return the configurable items displayed in the UI (key-label pairs)
        return new Pair[]{
            new Pair<>("corpId", "Enterprise ID"),
            new Pair<>("agentId", "Application AgentID")
        };
    }

    @Override
    public void sendMessage(MessageImage messageContent) {
        String[] receivers = messageContent.getSenderId().split(",");
        for (String receiver : receivers) {
            // Call the Enterprise WeChat API to send a message to each recipient
            WeChatApi.send(receiver, messageContent.getTitle(), messageContent.getContent());
        }
    }
}

Reference Examples

Official example source code: demo-message-provider

Notes

• getSenderId() returns recipients as a comma-separated string; split it into an array and send messages individually.
• This interface is only for template message push scenarios and is not suitable for other types of notification channels.