Stream conversations and messages
Stream new group chat and DM conversations
Listens to the network for new group chats and DMs. Whenever a new conversation starts, it triggers the provided callback function with a ConversationContainer
object. This allows the client to immediately respond to any new group chats or DMs initiated by other users.
const stream = await client.conversations.stream({
onValue: (conversation) => {
// Received a conversation
console.log("New conversation:", conversation);
},
onError: (error) => {
// Log any stream errors
console.error(error);
},
onFail: () => {
console.log("Stream failed");
}
});
// Or use for-await loop
for await (const conversation of stream) {
// Received a conversation
console.log("New conversation:", conversation);
}
Stream new group chat and DM messages
This function listens to the network for new messages within all active group chats and DMs.
Whenever a new message is sent to any of these conversations, the callback is triggered with a DecodedMessage
object. This keeps the inbox up to date by streaming in messages as they arrive.
By default, streamAll
streams only conversations with a consent state of allowed or unknown.
We recommend streaming messages for allowed conversations only. This ensures that spammy conversations with a consent state of unknown don't take up networking resources. This also ensures that unwanted spam messages aren't stored in the user's local database.
To stream all conversations regardless of consent state, pass [Allowed, Unknown, Denied]
.
// stream all messages from conversations with a consent state of allowed
const stream = await client.conversations.streamAllMessages({
consentStates: [ConsentState.Allowed],
onValue: (message) => {
// Received a message
console.log("New message:", message);
},
onError: (error) => {
// Log any stream errors
console.error(error);
},
onFail: () => {
console.log("Stream failed");
}
});
// Or use for-await loop
for await (const message of stream) {
// Received a message
console.log("New message:", message);
}
Handle stream failures
// disable automatic reconnects
const stream = await client.conversations.streamAllMessages({
retryOnFail: false,
onValue: (message) => {
console.log("New message:", message);
}
});
// use stream options with retry configuration
const stream = await client.conversations.streamAllMessages({
consentStates: [ConsentState.Allowed],
retryAttempts: 10,
retryDelay: 20000, // 20 seconds
onValue: (message) => {
console.log("New message:", message);
},
onError: (error) => {
console.error("Stream error:", error);
},
onFail: () => {
console.log("Stream failed after retries");
},
onRestart: () => {
console.log("Stream restarted");
},
onRetry: (attempt, maxAttempts) => {
console.log(`Stream retry attempt ${attempt} of ${maxAttempts}`);
},
});