Flutter即时通讯插件sitesurface_flutter_chat的使用

标题

Flutter即时通讯插件sitesurface_flutter_chat的使用

内容

Sitesurface Flutter Chat

The #1 Chat Package for Custom Messaging Apps.
建立实时聊天消息，节省时间。快速交付内置消息功能，我们的高可靠性和功能丰富的包。提高您的整体应用内转化率、参与度和保留率。

如果您觉得这个包有用，请👍该包并与其他开发者分享。

使用 Sitesurface Flutter Chat 插件，您可以通过几行代码轻松集成高度可定制的聊天功能到您的应用中。 创建您所需的 Flutter 聊天体验，包括实时消息、媒体上传、本地化和完整的离线支持。

• Flutter UI 组件. 从我们的高度可定制的消息组件中选择所需的功能，或者通过与核心类交互来构建自己的 UI 组件。

• 核心控制器和业务逻辑. Flutter 包括核心控制器和组件以简化业务逻辑和状态管理。 它们处理繁重的工作，让您专注于有趣的部分 - 构建您的聊天体验。

• 附件. 默认提供画廊图片、相机图片和当前位置。 更多内容即将推出...

• 实时事件. 新消息、在线状态、打字指示器、未读消息、通知等。

• 本地化和主题. 您可以轻松添加自定义本地化和主题以适应您的设计。

• 本地数据持久化. 我们为您提供完整的离线支持，以便在聊天应用程序中查看所有消息，无论连接状态如何，并在重新建立连接时自动重发失败的消息。

Getting Started #

Requirements #

Dart >=2.18.2 和 Flutter >=1.17.0

要使用此插件，请访问 Flutter Chat 使用文档 或参见 示例

#

请将 Sitesurface Flutter Chat 特定的问题、错误或功能请求提交到我们的 问题跟踪器。

不是特定于 Sitesurface Flutter Chat 的插件问题可以提交到 Flutter 问题跟踪器

欢迎为本项目做出贡献。

如果您发现了一个bug或想要一个功能，但不知道如何修复/实现它，请填写一个 问题。 如果您修复了bug或实现了功能，请发送一个 合并请求。

示例代码

import 'dart:io';

import 'package:flutter/material.dart';
import 'package:image_picker/image_picker.dart';
import 'package:sitesurface_flutter_chat/sitesurface_flutter_chat.dart';

import 'firebase_options.dart';
import 'login_screen.dart';

/// You will also need to create index in your firebase project. First time you will run the project you will
/// get error in console with the link to create index you just need to follow that link and click create index.

Future<void> main() async {
  // initialise firebase
  WidgetsFlutterBinding.ensureInitialized();
  await Firebase.initializeApp(
    options: DefaultFirebaseOptions.currentPlatform,
  );

  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Sitesurface Flutter Chat',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const LoginScreen(),
    );
  }
}

class ChatScreen extends StatefulWidget {
  const ChatScreen({super.key});
  [@override](/user/override)
  State<ChatScreen> createState() => _ChatScreenState();
}

class _ChatScreenState extends State<ChatScreen> {
  final fcmKey =
      "AAAAUjQxMDI:APA91bFAQTX1nlAt4CYAJgX3soefu9UM7nyIKvg8PGtOyUOZsNVkksN83yB0_n46QcQM1LEMJ8XBfZiKI3kbI2qEvQMQpTlLHdG3_ThfuAqEvQMQpTl";
  [@override](/user/override)
  Widget build(BuildContext context) {
    /// wrap your main widget like app dashboard with [ChatHandler] and pass the required data
    return ChatHandler(
      name: currentUserName,
      profilePic: currentUserProfilePic,
      userId: currentUserId,
      fcmServerKey: fcmKey,

      /// extend ChatDelegate and implement the required methods
      chatDelegate: ChatWidget(),
      child: Scaffold(
        appBar: AppBar(
          title: Text(currentUserName),
          actions: [
            // Get no. of unread chats
            Center(
              child: UnreadMessageCountWidget(builder: (context, count) {
                return Text("Unread Messages : $count   ");
              }),
            )
          ],
        ),

        /// [ChatListWidget] shows list of all active chats
        body: ChatListWidget(
          delegate: ChatWidget(),
        ),
        floatingActionButton: FloatingActionButton(
          onPressed: () {
            /// send message to other user using [openChat]
            openChat(
                context: context,
                delegate: ChatWidget(),
                recepientId: receiverId);
          },
          child: const Icon(Icons.message),
        ),
      ),
    );
  }
}

class ChatWidget extends ChatDelegate {
  final _imagePicker = ImagePicker();
  [@override](/user/override)
  Future<File?> getCameraImage() async {
    var xfile = await _imagePicker.pickImage(source: ImageSource.camera);
    if (xfile != null {
      return File(xfile.path);
    }
    return null;
  }

  [@override](/user/override)
  Future<SfcLatLng?> getCurrentLocation(BuildContext context) async {
    return SfcLatLng(latitude: 28.6488893, longitude: 77.1390096);
  }

  [@override](/user/override)
  Future<File?> getGalleryImage() async {
    var xfile = await _imagePicker.pickImage(source: ImageSource.gallery);
    if (xfile != null {
      return File(xfile.path);
    }
    return null;
  }
}