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,
apiAddr: "",
wsAddr: "",
dataDir: "",
logLevel: 6,
listener: OnConnectListener(
onConnectSuccess: () {
},
onConnecting: () {
},
onConnectFailed: (code, errorMsg) {
},
onUserSigExpired: () {
},
onKickedOffline: () {
},
),
);
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.
OpenIM.iMManager
..userManager.setUserListener(OnUserListener(
))
..messageManager.setAdvancedMsgListener(OnAdvancedMsgListener(
))
..messageManager.setMsgSendProgressListener(OnMsgSendProgressListener(
))
..messageManager.setCustomBusinessListener(
)
..friendshipManager.setFriendshipListener(OnFriendshipListener(
))
..conversationManager.setConversationListener(OnConversationListener(
))
..groupManager.setGroupListener(OnGroupListener(
));
final userInfo = await OpenIM.iMManager.login(
userID: "",
token: "",
);
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.
OpenIM.iMManager.messageManager.sendMessage(
message: await OpenIM.iMManager.messageManager.createTextMessage(
text: 'hello openim',
),
userID: userID
).catchError((error, _){
} )
.whenComplete(() {
});
OpenIM.iMManager.messageManager.setAdvancedMsgListener(OnAdvancedMsgListener(
onRecvNewMessage:(Message msg) {
}
))
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