WahidNasri/flutter-mqtt-chat-client
A Chat app developed with Flutter, it uses MQTT protocol
baixar do githubFlutter client of MqChat, a protocol built over MQTT for chatting purposes.
The Broker should install HiveMQ Chat-Extension first.
Features
Use MQTT as a chat protocol, to create a modern chat application that supports all needed features. This is a flutter client of MqChat.
- [x] Login
- [x] Send/receive messages (text, image, vide, location, document, contact messages)
- [x] Send Files
- [x] Typing indicators
- [x] Presence
- [x] Group Chat
- [x] Private Chat invitation
Getting started
Install the package flutter-mqchat
:
flutter pub add flutter-mqchat
Usage
A full and rich example can be found in /example
folder.
1. Login
User login using an existing account:
bool connected = await ChatApp.instance()!.clientHandler.connect(
host: "broker.url.com",
username: "user@test.com",
password: "user_pass");
After a successful login, the mqtt client will receive updates. The first updates to be received are profile details, rooms that users is member of, ongoing invitations and messages (if message archiving is supported by the broker).
2. Listen to my profile changes
ChatApp.instance()!.archiveHandler.getUser().listen((user) {
//insert/update user to database
});
3. Listen to rooms
Whenever the logged in user is added to a room (or room details changed), the room details will be added to the Conversations stream.
ChatApp.instance()!.archiveHandler.getAllConversations().listen((rooms) {
//insert/update rooms on the Database
});
4. Listen to new messages
ChatApp.instance()!.messageReader.getChatMessages().listen((message) {
var dbMessage = message.toDbMessage();
// insert the message to the database
// send chatmarker if the message is not mine
});
5. Listen to ChatMarkers
ChatApp.instance()!
.messageReader
.getChatMarkerMessages()
.listen((markerMessage) {
String messageId = markerMessage.referenceId;
if (markerMessage.status == ChatMarker.displayed) {
//update the database record
} else if (markerMessage.status == ChatMarker.delivered) {
//update the database record
}
});
6. Listen to new chat invitations
ChatApp.instance()!
.invitationHandler
.newInvitationsStream()
.listen((invitation) {
if(invitation.type == MessageType.EventInvitationRequest) {
//new invitation request
//insert invitation record to the database, notify the user
}
if(invitation.type == MessageType.EventInvitationResponseAccept || invitation.type == MessageType.EventInvitationResponseReject) {
//responded to invitation, update the local record and wait the server to sync the new contact (if accepted).
//Do not insert a room, the user will receive a new room details triggered by getAllConversations()
}
});
7. Listen to invitatioin updates
We use this to listen to the invitations that the user has sent. It could be:
- Info: When receive an affirmation that the invitation is sent
- Error: When there is an error (like the user is not found)
ChatApp.instance()!
.invitationHandler
.invitationUpdatesStream()
.listen((invitation) {
if (invitation.invitationMessageType == InvitationMessageType.INFO) {
//update the invitation record to be confirmed
}
else if (invitation.invitationMessageType == InvitationMessageType.ERROR) {
//notify the user, and delete the record in inserted
}
});
8. Send a text Message
ChatMessage newMessage = ChatMessage(
id: "generated_random_id",
type: MessageType.ChatText,
text: "Hello there",
roomId: "[room_id]",
fromId: "[my_id]",//optional
sendTime: DateTime.now().millisecondsSinceEpoch,
fromName: "[my_name]");
8.1 Send the message as regular message
ChatApp.instance()!
.messageSender
.sendChatMessage(newMessage, "[room_id]");
8.2 Send the message as a reply to another message
ChatMessage replyToMessage = ...; //the message to reply to
ChatApp.instance()!
.messageSender
.replyToMessage(replyToMessage, newMessage, widget.contactChat.roomId);
9. Send File Message
ChatApp.instance()!.messageSender.sendFileChatMessage(
type: MessageType.ChatImage,//for example
fileLocalPath: path,
room: "[room_id]");
10. Send typing indicator
ChatApp.instance()!
.eventsSender
.sendIsTyping(true, "[room_id]");
11. Listen to typing indicator
ChatApp.instance()!.messageReader.getTypingMessages().listen((event) {
//using event.roomId and event.isTyping and event.fromId, update the ui state
});
12. Send new chat invitation
ChatApp.instance()!
.eventsSender
.sendInvitation("[invitee_username]", "[invitation_random_id]");
Additional information
TODO: Tell users more about the package: where to find more information, how to
contribute to the package, how to file issues, what response they can expect
from the package authors, and more.
![](/images/banner-woo.jpg)
recomendações de excelentes projetos relacionados a WahidNasri/flutter-mqtt-chat-client para download
AppFlowy
47859
AppFlowy is an open-source alternative to Notion. You are in charge of your data and customizations. Built with Flutter and Rust.
localsend
33797
An open-source cross-platform alternative to AirDrop
spotube
23772
🎧 Open source Spotify client that doesn't require Premium nor uses Electron! Available for both desktop & mobile!
revanced-manager
15035
💊 Application to use ReVanced on Android
gsy_github_app_flutter
14559
Flutter 超完整的开源项目,功能丰富,适合学习和日常使用。GSYGithubApp系列的优势:我们目前已经拥有Flutter、Weex、ReactNative、kotlin 四个版本。 功能齐全,项目框架内技术涉及面广,完成度高,持续维护,配套文章,适合全面学习,对比参考。跨平台的开源Github客户端App,更好的体验,更丰富的功能,旨在更好的日常管理和维护个人Github,提供更好更方便的驾车体验Σ( ̄。 ̄ノ)ノ。同款Weex版本 : https://github.com/CarGuo/GSYGithubAppWeex 、同款React Native版本 : https://github.com/CarGuo/GSYGithubApp 、原生 kotlin 版本 https://github.com/CarGuo/GSYGithubAppKotlin
dio
12249
A powerful HTTP client for Dart and Flutter, which supports global settings, Interceptors, FormData, aborting and canceling a request, files uploading and downloading, requests timeout, custom adapters, etc.
gopeed
11832
A modern download manager that supports all platforms. Built with Golang and Flutter.
bloc
11441
A predictable state management library that helps implement the BLoC design pattern
getx
9899
Open screens/snackbars/dialogs/bottomSheets without context, manage states and inject dependencies easily with Get.
flame
8846
A Flutter based game engine.
flutter_deer
7595
🦌 Flutter 练习项目(包括集成测试、可访问性测试)。内含完整UI设计图,更贴近真实项目的练习。Flutter practice project (including integration testing and accessibility testing). Contains complete UI design drawings for a more realistic practice project.
fish-redux
7343
An assembled flutter application framework.
fl_chart
6451
FL Chart is a highly customizable Flutter chart library that supports Line Chart, Bar Chart, Pie Chart, Scatter Chart, and Radar Chart.
pixez-flutter
6360
一个支持免代理直连及查看动图的第三方Pixiv flutter客户端
Flutter-Responsive-Admin-Panel-or-Dashboard
6355
Responsive Admin Panel or Dashboard using Flutter
aidea
6021
AIdea 是一款支持 GPT 以及国产大语言模型通义千问、文心一言等,支持 Stable Diffusion 文生图、图生图、 SDXL1.0、超分辨率、图片上色的全能型 APP。
riverpod
5828
A reactive caching and data-binding framework. Riverpod makes working with asynchronous code a breeze.
pikapika
5463
美观易用且无广告的漫画和游戏客户端,同时支持MacOS,Windows,Android,iOS。
provider
5029
InheritedWidgets, but simple
getwidget
4416
Most popular and easy to use open source UI library with 1000+ Widgets to build flutter app.