Chat using PubSub - React Native
For the communication or any kind of messaging in between the participants, VideoSDK provides usePubSub
hook which use Publish-Subsciribe mechanism and can be used to develope wide varitey of functionalities. For example, participants could use it to send chat messages to each other, share files or other media, or even trigger actions like muting or unmuting audio or video.
Now we will see, how we can use PubSub to implement Chat functionality. If you are not familiar with the PubSub mechanism and usePubSub
hook, you can follow this guide.
Implementing Chat
Group Chat
- First step in creating a group chat is choosing the topic which all the participants will publish and subscribe to send and receive the messages. We will be using
CHAT
as the topic for this one. So let us get thepublish()
andmessages
from theusePubSub
hook.
// importing usePubSub hook from react-native-sdk
import { usePubSub } from "@videosdk.live/react-native-sdk";
function ChatView() {
// destructure publish method from usePubSub hook
const { publish, messages } = usePubSub("CHAT");
return <>...</>;
}
- Now lets create a message input and send button to publish the messages.
import { SafeAreaView, TouchableOpacity, TextInput, Text } from "react-native";
function ChatView() {
// destructure publish method from usePubSub hook
const { publish, messages } = usePubSub("CHAT");
// State to store the user typed message
const [message, setMessage] = useState("");
const handleSendMessage = () => {
// Sending the Message using the publish method
publish(message, { persist: true });
// Clearing the message input
setMessage("");
};
return (
<SafeAreaView>
<TextInput
style={{
height: 40,
margin: 12,
borderWidth: 1,
padding: 10,
}}
onChangeText={setMessage}
value={message}
/>
<TouchableOpacity
onPress={() => {
handleSendMessage();
}}
>
<Text>Send Message</Text>
</TouchableOpacity>
</SafeAreaView>
);
}
- Final step in the group chat would be to display the messages others send. For this will use the
messages
and display all the messages.
import { SafeAreaView, TouchableOpacity, TextInput, Text } from "react-native";
function ChatView() {
// destructure publish method from usePubSub hook
const { publish, messages } = usePubSub("CHAT");
const [message, setMessage] = useState("");
const handleSendMessage = () => {
...
};
return (
<SafeAreaView>
{messages.map((message) => {
return (
<Text style={{ fontSize: 12 }}>
{messsage.senderName} says {message.message}
</Text>
);
})}
<TextInput
style={{
height: 40,
margin: 12,
borderWidth: 1,
padding: 10,
}}
onChangeText={setMessage}
value={message}
/>
<TouchableOpacity
onPress={() => {
handleSendMessage();
}}
>
<Text>Send Message</Text>
</TouchableOpacity>
</SafeAreaView>
);
}
Private Chat
In the above example, if you want to convert into the private chat between two participants, then all you have to do is set sendOnly
property.
import { SafeAreaView, TouchableOpacity, TextInput, Text } from "react-native";
function ChatView() {
// destructure publish method from usePubSub hook
const { publish, messages } = usePubSub("CHAT");
// State to store the user typed message
const [message, setMessage] = useState("");
const handleSendMessage = () => {
// Sending the Message using the publish method
// Pass the participantId of the participant to whom you want to send the message.
// hightlight-next-line
publish(message, { persist: true, sendOnly: ['XYZ'] });
// Clearing the message input
setMessage("");
};
//...
}
Displaying Latest Message Notificaiton
You may want to show the notification to the user when new message arrives. So lets continue our example and add alert for the new images.
function ChatView() {
// destructure publish method from usePubSub hook
const { publish, messages } = usePubSub("CHAT", {
onMessageReceived: (message)=>{
window.alert(message.senderName + "says" + message.message);
}
});
const [message, setMessage] = useState("");
const handleSendMessage = () => {
...
};
return <>...</>;
}
Downloading Chat Messages
All the messages from the PubSub which where published with persist : true
and can be downloaded as an .csv
file. This file will be available in the VideoSDK dashboard as well as throught the Sessions API.
API Reference
The API references for all the methods and events utilised in this guide are provided below.
Got a Question? Ask us on discord