flutter mqtt chat client

ไคลเอนต์ Flutter ของ MQChat ซึ่งเป็นโปรโตคอลที่สร้างขึ้นเหนือ MQTT เพื่อการแชท

นายหน้าควรติดตั้ง HiveMQ Chat-Extension ก่อน

คุณสมบัติ

ใช้ MQTT เป็นโปรโตคอลการแชทเพื่อสร้างแอปพลิเคชันแชทที่ทันสมัยซึ่งรองรับคุณสมบัติที่จำเป็นทั้งหมด นี่คือไคลเอนต์ Flutter ของ 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. ฟัง 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. ฟังคำเชิญแชทใหม่

 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: บอกผู้ใช้เพิ่มเติมเกี่ยวกับแพ็คเกจ: สถานที่ที่จะหาข้อมูลเพิ่มเติมวิธีการมีส่วนร่วมในแพ็คเกจวิธีการยื่นปัญหาการตอบสนองที่พวกเขาสามารถคาดหวังได้จากผู้แต่งแพ็คเกจและอื่น ๆ