flutter mqtt chat client

عميل Flutter من MQCHAT ، وهو بروتوكول مبني على MQTT لأغراض الدردشة.

يجب على الوسيط تثبيت Hivemq الدردشة-التمديد أولاً.

سمات

استخدم MQTT كبروتوكول دردشة ، لإنشاء تطبيق دردشة حديث يدعم جميع الميزات المطلوبة. هذا هو عميل رفرفة من MQCHAT.

• تسجيل الدخول
• إرسال/تلقي الرسائل (نص ، صورة ، فيديو ، الموقع ، المستند ، رسائل الاتصال)
• إرسال الملفات
• مؤشرات الكتابة
• حضور
• دردشة جماعية
• دعوة الدردشة الخاصة

ابدء

تثبيت الحزمة flutter-mqchat :

 flutter pub add flutter-mqchat

الاستخدام

يمكن العثور على مثال كامل وغني في مجلد /example .

1. تسجيل الدخول

تسجيل دخول المستخدم باستخدام حساب موجود:

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

بعد تسجيل دخول ناجح ، سيتلقى عميل MQTT التحديثات. التحديثات الأولى التي يتم استلامها هي تفاصيل الملف الشخصي ، والغرف التي يكون المستخدمون فيها عضوًا في الدعوات والرسائل المستمرة (إذا تم دعم أرشفة الرسائل من قبل الوسيط).

2. استمع إلى تغيير ملفي الشخصي

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

3. استمع إلى الغرف

كلما تتم إضافة المستخدم المسجل إلى الغرفة (أو تفاصيل الغرفة) ، ستتم إضافة تفاصيل الغرفة إلى دفق المحادثات.

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

4. استمع إلى رسائل جديدة

 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. استمع إلى Mathmarkers

 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. استمع إلى دعوات الدردشة الجديدة

 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. استمع إلى تحديثات Invitatioin

نستخدم هذا للاستماع إلى الدعوات التي أرسلها المستخدم. يمكن أن يكون:

• معلومات: عند تلقي تأكيد بأن الدعوة يتم إرسالها
• خطأ: عندما يكون هناك خطأ (مثل عدم العثور على المستخدم)

 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. أرسل رسالة نصية

 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 أرسل الرسالة كرسالة عادية

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

8.2 أرسل الرسالة كرد على رسالة أخرى

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

9. إرسال رسالة الملف

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

10. أرسل مؤشر الكتابة

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

11. استمع إلى مؤشر الكتابة

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

12. أرسل دعوة الدردشة الجديدة

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

معلومات إضافية

TODO: أخبر المستخدمين المزيد عن الحزمة: أين يمكن العثور على مزيد من المعلومات ، وكيفية المساهمة في الحزمة ، وكيفية تقديم المشكلات ، والاستجابة التي يمكن أن يتوقعوها من مؤلفي الحزمة ، وأكثر من ذلك.