搜索插件、代码仓与 APP 分类

插件详情v3.8.3+hotfix.15

flutter_openim_sdk

一个支持 Android 和 IOS 的即时通讯插件。服务器也是完全开源的。

AndroidiOS
近 30 天下载
307
喜欢数
27
Pub 分数
140

安装插件

flutter pub add flutter_openim_sdk

插件介绍

基于插件公开信息、社区数据与项目使用情况整理的选型参考。

Flutter OpenIM SDK 是一个跨平台的即时通讯插件,适用于 Flutter,支持 Android 和 iOS。它提供实时聊天功能,如文本、图片和语音消息,并拥有完全开源的服务器后端。设计用于无缝集成,通过提供强大的 API 来简化消息处理、用户管理和在线状态跟踪,从而降低消息应用的开发难度。该 SDK 非常适合希望获得可定制、可扩展且安全的通信解决方案而无需受制于特定供应商的团队。

适合场景

  • 实时聊天应用
  • 群组消息
  • 用户间聊天
  • 可定制的聊天界面
  • 企业通信工具

主要特点

  • 跨平台支持(Android 和 iOS)
  • 完全开源的服务器
  • 实时消息传递
  • 可扩展的 API 设计
  • 安全通信协议

适合对象

  • 开发聊天应用的开发者
  • 需要开源替代方案的团队
  • 初创企业需要经济实惠的短信服务
  • 具有自定义用户体验需求的应用程序
  • 项目优先考虑数据控制

使用建议

  • 需要设置开源服务器
  • 需要熟悉IM概念
  • 可能需要额外的后端自定义
  • 依赖稳定的网络连接
  • 初始配置可能很复杂

原始 README

以下为关联源码仓库的 README 原文快照,最新内容请访问源码仓库。

Flutter Client SDK for OpenIM 👨‍💻💬

Use this SDK to add instant messaging capabilities to your Flutter app. By connecting to a self-hosted OpenIM server, you can quickly integrate instant messaging capabilities into your app with just a few lines of code.

The underlying SDK core is implemented in OpenIM SDK Core. Using gomobile, it can be compiled into an AAR file for Android integration. Android interacts with the OpenIM SDK Core through JSON, and the SDK exposes a re-encapsulated API for easy usage. In terms of data storage, Android utilizes the SQLite layer provided internally by the OpenIM SDK Core.

The underlying SDK core is implemented in OpenIM SDK Core. Using gomobile, it can be compiled into an XCFramework for iOS integration. iOS interacts with the OpenIM SDK Core through JSON, and the SDK exposes a re-encapsulated API for easy usage. In terms of data storage, iOS utilizes the SQLite layer provided internally by the OpenIM SDK Core.

Based on the above AAR and XCFramework packages, the IM SDK for Flutter is encapsulated through the Flutter plug-in.

Documentation 📚

Visit https://docs.openim.io/ for detailed documentation and guides.

For the SDK reference, see https://docs.openim.io/sdks/quickstart/flutter.

Installation 💻

Adding Dependencies
  flutter_openim_sdk: lastest

Usage 🚀

The following examples demonstrate how to use the SDK.

Importing the SDK
import 'package:flutter_openim_sdk/flutter_openim_sdk.dart';
Initialize
final success = await OpenIM.iMManager.initSDK(
  platform: 0,   // Platform, referring to the IMPlatform class.
  apiAddr: "",   // SDK's API interface address.
  wsAddr: "",    // SDK's WebSocket address.
  dataDir: "",   // Data storage path. For example, you can use getApplicationDocumentsDirectory() to get a path.
  logLevel: 6,   // Log level (default value is 6).
  listener: OnConnectListener(
    onConnectSuccess: () {
      // Successfully connected to the server.
    },
    onConnecting: () {
      // Connecting to the server, suitable for showing a "Connecting" status on the UI.
    },
    onConnectFailed: (code, errorMsg) {
      // Failed to connect to the server, you can notify the user that the current network connection is not available.
    },
    onUserSigExpired: () {
      // User's login token (UserSig) has expired, prompting the user to log in again with a new token.
    },
    onKickedOffline: () {
      // The current user has been kicked offline, and you can prompt the user to log in again with a message like "You have been logged in on another device. Do you want to log in again?"
    },
  ),
);

Logging In and Listening for Connection Status

Note1: You need to deploy OpenIM Server first, the default port of OpenIM Server is 10001, 10002.
Note2: You need to set up the listeners first and then log in.

// Set listener
    OpenIM.iMManager
      //
      ..userManager.setUserListener(OnUserListener(
      ))
      // Add message listener (remove when not in use)
      ..messageManager.setAdvancedMsgListener(OnAdvancedMsgListener(
      ))

      // Set up message sending progress listener
      ..messageManager.setMsgSendProgressListener(OnMsgSendProgressListener(
      ))
      ..messageManager.setCustomBusinessListener(
      )
      // Set up friend relationship listener
      ..friendshipManager.setFriendshipListener(OnFriendshipListener(
      ))

      // Set up conversation listener
      ..conversationManager.setConversationListener(OnConversationListener(
      ))

      // Set up group listener
      ..groupManager.setGroupListener(OnGroupListener(
      ));

// Retrieve the profile of the currently logged-in user
final userInfo = await OpenIM.iMManager.login(
      userID: "", // userID is obtained from your own business server
      token: "", // The token should be acquired by your business server by exchanging with OpenIM server based on a secret key
    );

To log into the IM server, you need to create an account and obtain a user ID and token. Refer to the access token documentation for details.

Receiving and Sending Messages 💬

OpenIM makes it easy to send and receive messages. By default, there is no restriction on having a friend relationship to send messages (although you can configure other policies on the server). If you know the user ID of the recipient, you can conveniently send a message to them.

//Send
 OpenIM.iMManager.messageManager.sendMessage(
            message: await OpenIM.iMManager.messageManager.createTextMessage(
              text: 'hello openim',
            ),
            userID: userID
          ).catchError((error, _){
          // Message sent successfully ✉️	

         } )
        .whenComplete(() {
 	  // Failed to send message ❌

         });

//Receive
OpenIM.iMManager.messageManager.setAdvancedMsgListener(OnAdvancedMsgListener(
        onRecvNewMessage:(Message msg) {
     	// Received new message 📨

	  }
      ))

Examples 🌟

You can find a demo Flutter app that uses the SDK in the open-im-flutter-demo repository.

Community :busts_in_silhouette:

Community Meetings :calendar:

We want anyone to get involved in our community and contributing code, we offer gifts and rewards, and we welcome you to join us every Thursday night.

Our conference is in the OpenIM Slack 🎯, then you can search the Open-IM-Server pipeline to join

We take notes of each biweekly meeting in GitHub discussions, Our historical meeting notes, as well as replays of the meetings are available at Google Docs :bookmark_tabs:.

Who are using OpenIM :eyes:

Check out our user case studies page for a list of the project users. Don't hesitate to leave a 📝comment and share your use case.

License :page_facing_up:

This software is licensed under a dual-license model:

  • The GNU Affero General Public License (AGPL), Version 3 or later; OR
  • Commercial license terms from OpenIMSDK.

If you wish to use this software under commercial terms, please contact us at: contact@openim.io

For more information, see: https://www.openim.io/en/licensing

所属分类

源码仓库

使用此插件的项目

暂无相关数据。