flutter mqtt chat client

Flutter Client do MQCHAT, um protocolo construído sobre o MQTT para fins de bate -papo.

O corretor deve instalar primeiro o hivemq chat-extension.

Características

Use o MQTT como um protocolo de bate -papo, para criar um aplicativo de bate -papo moderno que suporta todos os recursos necessários. Este é um cliente fleta do MQCHAT.

• Conecte-se
• Enviar/receber mensagens (texto, imagem, vide, localização, documento, mensagens de contato)
• Enviar arquivos
• Indicadores de digitação
• Presença
• Bate -papo em grupo
• Convite de bate -papo privado

Começando

Instale o pacote flutter-mqchat :

 flutter pub add flutter-mqchat

Uso

Um exemplo completo e rico pode ser encontrado na pasta /example .

1. Login

Login do usuário usando uma conta existente:

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

Após um login bem -sucedido, o cliente MQTT receberá atualizações. As primeiras atualizações a serem recebidas são detalhes do perfil, salas dos quais os usuários são membros, convites e mensagens em andamento (se o arquivamento de mensagens for suportado pelo corretor).

2. Ouça as mudanças de meu perfil

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

3. Ouça os quartos

Sempre que o usuário conectado é adicionado a uma sala (ou detalhes da sala alterados), os detalhes da sala serão adicionados ao fluxo de conversas.

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

4. Ouça novas mensagens

 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. Ouça os 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. Ouça novos convites de bate -papo

 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. Ouça as atualizações do Invitatioin

Usamos isso para ouvir os convites que o usuário enviou. Pode ser:

• Informações: quando receber uma afirmação de que o convite é enviado
• Erro: quando há um erro (como o usuário não é encontrado)

 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. Envie uma mensagem 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 Envie a mensagem como mensagem regular

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

8.2 Envie a mensagem como uma resposta para outra mensagem

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

9. Envie a mensagem do arquivo

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

10. Envie o indicador de digitação

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

11. Ouça o indicador de digitação

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

12. Envie um novo convite de bate -papo

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

Informações adicionais

TODO: diga aos usuários mais sobre o pacote: onde encontrar mais informações, como contribuir para o pacote, como arquivar problemas, que resposta eles podem esperar dos autores do pacote e muito mais.