flutter mqtt chat client

Flutter Client de MQChat, un protocolo construido sobre MQTT para fines de chat.

El corredor debe instalar primero la extensión de chat hivemq.

Características

Use MQTT como un protocolo de chat, para crear una aplicación de chat moderna que admita todas las características necesarias. Este es un cliente de Flutter de MQCHAT.

• Acceso
• Enviar/recibir mensajes (texto, imagen, vide, ubicación, documento, mensajes de contacto)
• Enviar archivos
• Indicadores de escritura
• Presencia
• Chat grupal
• Invitación de chat privado

Empezando

Instale el paquete flutter-mqchat :

 flutter pub add flutter-mqchat

Uso

Se puede encontrar un ejemplo completo y rico en la carpeta /example .

1. Iniciar sesión

Inicio de sesión del usuario utilizando una cuenta existente:

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

Después de un inicio de sesión exitoso, el cliente MQTT recibirá actualizaciones. Las primeras actualizaciones que se recibirán son los detalles del perfil, las habitaciones de las que los usuarios son miembros, invitaciones y mensajes continuos (si el corredor es compatible con el archivo de mensajes).

2. Escuche los cambios de mi perfil

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

3. Escuche las habitaciones

Cada vez que se agrega el usuario iniciado en una habitación (o detalles de la habitación), los detalles de la habitación se agregarán a la transmisión de conversaciones.

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

4. Escuche nuevos mensajes

 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. Escuche a 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. Escuche nuevas invitaciones de chat

 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. Escuche las actualizaciones de invitatioína

Usamos esto para escuchar las invitaciones que el usuario ha enviado. Podría ser:

• Información: cuando reciba una afirmación de que se envía la invitación
• Error: cuando hay un error (como no se encuentra el usuario)

 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. Envíe un mensaje de texto

 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 Enviar el mensaje como mensaje regular

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

8.2 Enviar el mensaje como respuesta a otro mensaje

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

9. Envíe un mensaje de archivo

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

10. Enviar indicador de escritura

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

11. Escuche el indicador de escritura

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

12. Envíe una nueva invitación de chat

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

Información adicional

TODO: Cuéntele a los usuarios más sobre el paquete: dónde encontrar más información, cómo contribuir al paquete, cómo presentar problemas, qué respuesta pueden esperar de los autores del paquete y más.