Your first realtime message.

Get an API key

Sign in with Google in the developer portal. Your first key is shown once: copy it somewhere safe.

For a browser tab, use a temporary key from the dashboard (Keys → Temporary keys) instead: it expires in minutes, so it is safe to paste into page code while you try things. In your app, your server mints it (see below).

Install

<script src="https://hmdevonline.com/messaging-platform/sdk/generated-web-agent-js/js/web-agent.libs.js"></script>
<script src="https://hmdevonline.com/messaging-platform/sdk/generated-web-agent-js/js/web-agent.js"></script>

pip install "git+https://github.com/HaithamMubarak/messaging-platform-sdk.git@develop#subdirectory=agents/python-agent"

git clone https://github.com/HaithamMubarak/messaging-platform-sdk.git
cd messaging-platform-sdk
./gradlew :agents:examples:java-agent-chat:build

git clone https://github.com/HaithamMubarak/messaging-platform-sdk.git
cmake -S messaging-platform-sdk/agents/cpp-agent -B build
cmake --build build && cmake --install build --prefix ./sdk

# your CMakeLists.txt
find_package(messaging-cpp-agent CONFIG REQUIRED)
target_link_libraries(my_app PRIVATE hmdev::messaging-cpp-agent)

Connect

Create a connection with the platform's API address and your key.

const agent = new AgentConnection();

from hmdev.messaging.agent.core.agent_connection import AgentConnection

agent = AgentConnection.with_api_key(
    "https://hmdevonline.com/messaging-platform/api/v1/messaging-service",
    os.environ["MESSAGING_PLATFORM_API_KEY"])

AgentConnection agent = new AgentConnection(
        "https://hmdevonline.com/messaging-platform/api/v1/messaging-service",
        System.getenv("MESSAGING_PLATFORM_API_KEY"));

MessagingChannelApi api("https://hmdevonline.com/messaging-platform/api/v1/messaging-service", apiKey);

Join a channel

A channel is created the first time anyone joins it. Everyone with its name and password is in the same room; the password also encrypts the messages.

agent.connect({
  api: 'https://hmdevonline.com/messaging-platform/api/v1/messaging-service',
  apiKey: 'paste-a-temporary-key',
  channelName: 'quickstart-room',
  channelPassword: 'channel-password',
  agentName: 'browser-user',
  autoReceive: true,   // without this, a polling connection receives nothing
});

agent.connect("quickstart-room", "channel-password", "python-agent")

agent.connect(ConnectConfig.of("quickstart-room", "channel-password", "java-agent"));

ConnectResponse r = api.connect("quickstart-room", "channel-password", "cpp-agent");

Send a message

agent.addEventListener('connect', e => {
  if (e.response.status === 'success') agent.sendMessage({ content: 'Hello from the browser!' });
});

agent.send_message("Hello from Python!")

agent.sendMessage("Hello from Java!");

api.send(EventType::CHAT_TEXT, "Hello from C++!", "*", r.sessionId, false);

Receive

Every client on the channel gets every message, in order.

agent.addEventListener('message', e => {
  e.response.data.filter(m => m.type === 'chat-text')
    .forEach(m => console.log(m.from, 'says', m.content));
});

class Printer(AgentConnectionEventHandler):
    def on_message_events(self, events):
        for e in events:
            if e.get("type") == "chat-text":
                print(e.get("from"), "says", e.get("content"), flush=True)

agent.receive_async(Printer())

agent.receiveAsync(events -> events.stream()
        .filter(e -> e.getType() == EventMessage.EventType.CHAT_TEXT)
        .forEach(e -> System.out.println(e.getFrom() + " says " + e.getContent())));

ReceiveConfig config;
config.globalOffset = r.globalOffset;
config.localOffset = r.localOffset;
while (running) {
    EventMessageResult result = api.receive(r.sessionId, config);
    for (const auto& msg : result.messages) std::cout << msg.from << ": " << msg.content << std::endl;
    config.globalOffset = result.globalOffset;
    config.localOffset = result.localOffset;
    std::this_thread::sleep_for(std::chrono::milliseconds(500));
}

Run it twice, or once in two languages. Each client prints the other's greeting. These exact programs were run together against the live platform before this page was published; the full files are in agents/examples/quickstart.