搜尋套件、儲存庫與 APP 分類

套件詳情v0.1.2

flutter_mqchat

MqChat 客戶端,此套件讓您能使用 MQTT 協定作為通訊協定,代理伺服器應實作 HiveMq-Chat-Extension 規範。

AndroidiOSmacOSWindowsLinux
近 30 天下載
48
喜歡數
15
Pub 分數
125

安裝套件

flutter pub add flutter_mqchat

套件介紹

根據套件公開資料產生的選型評估,僅供參考。

FlutterMQChat 是一個 Flutter 套件,可使用 MQTT 協定實現即時聊天功能,專為支援 HiveMQ-Chat-Extension 規範的代理伺服器設計。它透過抽象 MQTT 複雜性,簡化雙向訊息傳遞,非常適合輕量級、低延遲的聊天應用。該套件支援 Android、iOS、macOS、Windows 和 Linux 等多個平台,確保跨平台的一致性。對於需要即時訊息傳遞且開銷極小的應用程式尤為有用。

適用情境

  • 即時訊息應用
  • 基於物聯網的聊天系統
  • 跨平台聊天客戶端
  • 低延遲通訊
  • 協作工具

主要特色

  • 基於MQTT的聊天協議
  • HiveMQ-Chat-Extension 相容
  • 多平台支援
  • 訊息處理的簡單 API
  • 輕便高效

適合對象

  • 開發即時聊天功能的開發者
  • 在基礎設施中使用 MQTT 的團隊
  • 需要可擴展訊息傳遞的應用程式
  • 針對多個操作系統的專案
  • 物聯網或嵌入式聊天應用

使用建議

  • 需要一個帶有 HiveMQ-Chat-Extension 的代理
  • 僅限支援 MQTT 的環境
  • 無內建使用者驗證
  • 依賴外部代理設定
  • 不適用於高安全性聊天,除非採取額外措施

原始 README

以下為關聯原始碼儲存庫的 README 原文快照,最新內容請造訪原始碼儲存庫。

Flutter 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.

所屬分類

依賴

依賴清單 6 項

原始碼儲存庫

使用此套件的專案

暫無相關資料。