Skip to main content
Version: 0.0.x

PubSub (BETA)

PubSub feature allows the participant to send and receive messages of the topics which he has subscribed.

Methods

publish()

This method is use for publishing message of specific topic.

Syntax

function publish(topic: String, message: String, { persist : Boolean });
Parameter NameTypeDescription
topicStringThis should be the topic for which you are publishing a message.
messageStringThis is the actual message, which will be published to participants, who had subscribed to a particular topic.
optionsObjectThis is an object, which provides an option, such as persist, which persists message history for upcoming participants.

Example

function sendMessage() {
meeting?.pubSub?.publish(topic: "CHAT", message: "Hello Everyone!", { persist: true })
}

subscribe()

This method is used to subscribe for particular topic. This method returns a list of messages which were sent earlier.

Syntax

function subscribe(topic: String, onMessageReceived: function);
Parameter NameTypeDescription
topicStringThis should be the topic to be subscribed.
onMessageReceivedfunctionThis is a callback function, which will be called, when new message received.

Example

// Callback function
function onMessageReceived(data) {
console.log(`New message received: ${data.message}`);
}

function subscribe() {
// Subscribe 'CHAT' topic
meeting?.pubSub?.subscribe("CHAT", onMessageReceived);
}

unsubscribe()

This method is used to unsubscribe the message topic.

Syntax

function unsubscribe(topic:String, onMessageReceived: function);
Parameter NameTypeDescription
topicStringThis should be the topic to be unsubscribed.
onMessageReceivedfunctionThis is a callback function, which was passed in subscribe().

Example

function unsubscribe() {
// Unsubscribe 'CHAT' topic
meeting?.pubSub?.unsubscribe("CHAT", onMessageReceived);
}

Sample Code

//subscribe to the 'CHAT' on meeting join
meeting.on("meeting-joined", () => {
meeting.pubSub.subscribe("CHAT", (data) => {
let { message, senderId, senderName, timestamp } = data;
const chatBox = document.getElementById("chatArea");
const chatTemplate = `
<div style="margin-bottom: 10px; ${
meeting.localParticipant.id == senderId && "text-align : right"
}">
<span style="font-size:12px;">${senderName}</span>
<div style="margin-top:5px">
<span style="background:${
meeting.localParticipant.id == senderId ? "grey" : "crimson"
};color:white;padding:5px;border-radius:8px">${message}<span>
</div>
</div>
`;
chatBox.insertAdjacentHTML("beforeend", chatTemplate);
});
});

//publish chat meesage on button click
btnSend.addEventListener("click", async () => {
const message = document.getElementById("txtChat").value;
console.log("publish : ", message);
document.getElementById("txtChat").value = "";
meeting.pubSub
.publish("CHAT", message, { persist: true })
.then((res) => console.log(`response of publish : ${res}`))
.catch((err) => console.log(`error of publish : ${err}`));
});