パッケージ、リポジトリ、アプリカテゴリを検索

パッケージ詳細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を提供することで、メッセージアプリの開発を簡素化します。ベンダーに縛られないカスタマイズ可能でスケーラブルかつセキュアな通信ソリューションを求めるチームにとって最適です。

用途

  • リアルタイムチャットアプリ
  • グループメッセージ
  • ユーザー間チャット
  • カスタマイズ可能なチャットUI
  • エンタープライズコミュニケーションツール

主な機能

  • クロスプラットフォーム対応(Android および iOS)
  • 完全オープンソースのサーバー
  • リアルタイムメッセージ配信
  • 拡張可能な API デザイン
  • セキュアな通信プロトコル

適している対象

  • チャットアプリを開発する開発者
  • オープンソースの代替案が必要なチーム
  • コスト効率の良いメッセージングを必要とするスタートアップ
  • カスタムUX要件を持つアプリ
  • データコントロールを重視するプロジェクト

注意事項

  • オープンソースサーバーのセットアップが必要です
  • 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

カテゴリー

ソースリポジトリ

このパッケージを使用しているプロジェクト

データはまだありません。