flutter mqtt chat client

Flutter -Client von Mqchat, einem Protokoll, das für Chat -Zwecke über MQTT erstellt wurde.

Der Broker sollte zuerst die HIVEMQ-Chat-Erweiterung installieren.

Merkmale

Verwenden Sie MQTT als Chat -Protokoll, um eine moderne Chat -Anwendung zu erstellen, die alle erforderlichen Funktionen unterstützt. Dies ist ein Flutter -Client von MQchat.

• Login
• Senden/Empfangen Sie Nachrichten (Text, Bild, Vide, Ort, Dokument, Kontaktnachrichten).
• Dateien senden
• Typisierungsindikatoren
• Gegenwart
• Gruppenchat
• Private Chat -Einladung

Erste Schritte

Installieren Sie das Paket flutter-mqchat :

 flutter pub add flutter-mqchat

Verwendung

Ein vollständiges und reichhaltiges Beispiel finden Sie im Ordner /example .

1. Login

Benutzeranmeldung mit einem vorhandenen Konto:

 bool connected = await ChatApp . instance () ! .clientHandler. connect (
        host : "broker.url.com" ,
        username : "[email protected]" ,
        password : "user_pass" );

Nach einer erfolgreichen Anmeldung erhält der MQTT -Client Aktualisierungen. Die ersten Aktualisierungen, die empfangen werden müssen, sind Profildetails, Räume, die Benutzer Mitglied haben, laufende Einladungen und Nachrichten (wenn die Nachrichtenarchivierung vom Broker unterstützt wird).

2. Hören Sie sich meine Profiländerungen an

 ChatApp . instance () ! .archiveHandler. getUser (). listen ((user) {
      //insert/update user to database
    });

3. Hören Sie sich die Räume an

Immer wenn der angemeldete Benutzer zu einem Raum hinzugefügt wird (oder sich die Raumdetails geändert haben), werden die Raumdetails zum Konversationen -Stream hinzugefügt.

 ChatApp . instance () ! .archiveHandler. getAllConversations (). listen ((rooms) {
      //insert/update rooms on the Database
    });

4. Hören Sie neue Nachrichten an

 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. Hören Sie sich Chatmarker an

 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. Hören Sie sich neue Chat -Einladungen an

 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. Hören Sie sich Invitatioin -Updates an

Wir verwenden dies, um die Einladungen anzuhören, die der Benutzer gesendet hat. Es könnte sein:

• Info: Wenn Sie eine Bestätigung erhalten, dass die Einladung gesendet wird
• Fehler: Wenn ein Fehler vorliegt (wie der Benutzer nicht gefunden wird)

 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. Senden Sie eine Textnachricht

 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 Senden Sie die Nachricht als reguläre Nachricht

 ChatApp . instance () !
          .messageSender
          . sendChatMessage (newMessage, "[room_id]" );

8.2 Senden Sie die Nachricht als Antwort auf eine andere Nachricht

 ChatMessage replyToMessage = ...; //the message to reply to
ChatApp . instance () !
          .messageSender
          . replyToMessage (replyToMessage, newMessage, widget.contactChat.roomId);

9. Dateinachricht senden

 ChatApp . instance () ! .messageSender. sendFileChatMessage (
          type : MessageType . ChatImage , //for example
          fileLocalPath : path,
          room : "[room_id]" );

10. Schreibanzeige senden

 ChatApp . instance () !
          .eventsSender
          . sendIsTyping ( true , "[room_id]" );

11. Hören Sie sich die Tippindikator an

 ChatApp . instance () ! .messageReader. getTypingMessages (). listen ((event) {
    //using event.roomId and event.isTyping and event.fromId, update the ui state
    
    });

12. Neue Chat -Einladung senden

 ChatApp . instance () !
        .eventsSender
        . sendInvitation ( "[invitee_username]" , "[invitation_random_id]" );

Weitere Informationen

TODO: Erzählen Sie den Benutzern mehr über das Paket: Wo können Sie weitere Informationen finden, wie Sie zum Paket beitragen, wie Sie Probleme einreichen, welche Antwort sie von den Paketautoren erwarten können, und vieles mehr.