패키지, 저장소 및 앱 카테고리 검색

패키지 상세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

카테고리

소스 저장소

이 패키지를 사용하는 프로젝트

아직 데이터가 없습니다.