Welcome to your go-to guide for adding instant messaging capabilities to your Flutter applications using the OpenIM SDK. By connecting to a self-hosted OpenIM server, you can easily embed real-time messaging functionality with minimal code complexity. Let’s dive into the essentials of deploying this SDK!

Getting Started with OpenIM SDK

The underlying SDK core is crafted in OpenIM SDK Core. Leveraging gomobile, it allows for smooth integration into both Android as an AAR file and iOS as an XCFramework. Under the hood, both platforms communicate with the SDK via JSON, simplifying the API usage.

Installation

Adding Dependencies

• Add the OpenIM SDK to your Dart dependencies:

  flutter_openim_sdk: latest

Usage

Importing the SDK

Begin by importing the OpenIM SDK in your Dart file:

import 'package:flutter_openim_sdk/flutter_openim_sdk.dart';

Initialization

To initialize the SDK, execute the following code:

final success = await OpenIM.iMManager.initSDK(
    platform: 0,
    apiAddr: 'your_api_address',
    wsAddr: 'your_websocket_address',
    dataDir: 'your_data_directory', // e.g., getApplicationDocumentsDirectory()
    logLevel: 6, // Log level (default is 6)
    listener: OnConnectListener(
        onConnectSuccess: () {
            // Successfully connected
        },
        onConnecting: () {
            // Connection in progress
        },
        onConnectFailed: (code, errorMsg) {
            // Connection failed
        },
        onUserSigExpired: () {
            // Token expired, prompt user to log in again
        },
        onKickedOffline: () {
            // User kicked offline, send message to log in again
        },
    ),
);

Understanding the Code: An Analogy

Think of the initialization process as setting up a conversation over coffee in your favorite café. You (the Flutter app) need to find the right café (OpenIM server) and order a cup (start the SDK). Each parameter you provide, like `apiAddr` and `wsAddr`, represents specific requests you make to ensure your coffee (data) is just right. This setup prepares your app for smooth and effective communications, akin to how you’d have an engaging discussion over a freshly brewed cup!

Logging In and Connection Status

Before logging in, make sure the OpenIM Server is deployed. Set up your listeners first:

OpenIM.iMManager
    ..userManager.setUserListener(OnUserListener(/* configure your listener */))
    ..messageManager.setAdvancedMsgListener(OnAdvancedMsgListener(/* configure your listener */))
    ..messageManager.setMsgSendProgressListener(OnMsgSendProgressListener(/* configure your listener */))
    ..friendshipManager.setFriendshipListener(OnFriendshipListener(/* configure your listener */))
    ..conversationManager.setConversationListener(OnConversationListener(/* configure your listener */))
    ..groupManager.setGroupListener(OnGroupListener(/* configure your listener */));

Retrieve User Profile

To log into the IM server:

final userInfo = await OpenIM.iMManager.login(
    userID: 'your_user_id', // Get this from your server
    token: 'your_token' // Obtain from your server
);

Sending and Receiving Messages

OpenIM simplifies the messaging process. To send a message:

OpenIM.iMManager.messageManager.sendMessage(
    message: await OpenIM.iMManager.messageManager.createTextMessage(text: 'hello openim'),
    userID: 'recipient_user_id')
.catchError((error, _) {
    // Message sent successfully
}).whenComplete(() {
    // Failed to send message
});

Receiving Messages

Set up a listener to receive messages:

OpenIM.iMManager.messageManager.setAdvancedMsgListener(OnAdvancedMsgListener(
    onRecvNewMessage: (Message msg) {
        // Handle received message
    }
));

Troubleshooting Common Issues

• Ensure that your OpenIM Server is correctly deployed. The default ports are 10001 and 10002.
• Check your networking settings if you face connection issues.
• Make sure to retrieve the user ID and token correctly from your server.
• If you experience token expiration messages, prompt the user to log in with a new token.

For more insights, updates, or to collaborate on AI development projects, stay connected with fxis.ai.

Additional Resources

For detailed documentation and guides, please visit OpenIM Documentation. You can also refer to the SDK reference at OpenIM SDK Quickstart for Flutter.

Conclusion

At fxis.ai, we believe that such advancements are crucial for the future of AI, as they enable more comprehensive and effective solutions. Our team is continually exploring new methodologies to push the envelope in artificial intelligence, ensuring that our clients benefit from the latest technological innovations.

Good luck with your project, and may your instant messaging capabilities soar to new heights!