flutter mqtt chat client

Flutter Client of MQChat, протокола, построенного над MQTT для чата.

Брокер должен сначала установить Hivemq Chat-Extension.

Функции

Используйте 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. Слушайте чатмаркеры

 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: Расскажите пользователям больше о пакете: где найти больше информации, как внести свой вклад в пакет, как подать проблемы, какой ответ они могут ожидать от авторов пакета и многое другое.