搜尋套件、儲存庫與 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

所屬分類

原始碼儲存庫

使用此套件的專案

暫無相關資料。