iOS Client SDK for OpenIM 👨‍💻💬

Use this SDK to add instant messaging capabilities to your 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 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.

Documentation 📚

Visit https://docs.openim.io/ for detailed documentation and guides.

For the SDK reference, see Quick Start guide.

Installation 💻

Adding Dependencies

pod 'OpenIMSDK'

Usage 🚀

The following examples demonstrate how to use the SDK. Objective-C is used, providing complete type hints.

Importing the SDK

@import OpenIMSDK;

Logging In and Listening for Connection Status

Note: You need to Deploy OpenIM Server first, the default port of OpenIM Server is 10001, 10002.

OIMInitConfig *config = [OIMInitConfig new];
config.apiAddr = @"";
config.wsAddr = @"";
config.objectStorage = @"";

BOOL success = [OIMManager.manager initSDKWithConfig:config
                                        onConnecting:^{
    // The SDK is currently connecting to the IM server.
} onConnectFailure:^(NSInteger code, NSString * _Nullable msg) {
    // Callback function for connection failure
    // code: Error code
    // error: Error message
} onConnectSuccess:^{
    // The SDK has successfully connected to the IM server.
} onKickedOffline:^{
    // Kicked offline.
} onUserTokenExpired:^{
    // Token expired while online: In this situation, you need to generate a new token and then call the `login()` function again to log in.
}];

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.

@import OpenIMSDK;

// Listenfor new messages 📩
[OIMManager.callbacker setAdvancedMsgListenerWithOnRecvMessageRevoked:^(OIMMessageRevokedInfo * _Nullable msgRovoked) {
} onRecvC2CReadReceipt:^(NSArray<OIMReceiptInfo *> * _Nullable msgReceiptList) {
} onRecvGroupReadReceipt:^(NSArray<OIMReceiptInfo *> * _Nullable msgReceiptList) {
} onRecvNewMessage:^(OIMMessageInfo * _Nullable message) {
}];

OIMMessageInfo *testMessage = [OIMMessageInfo createTextMessage:@"Hello!"];

[OIMManager.manager sendMessage:testMessage
                         recvID:@""
                        groupID:@""
                offlinePushInfo:nil
                      onSuccess:^(OIMMessageInfo * _Nullable message) {
            // Please note here that the returned message needs to be replaced with the data source.
            testMessage = message;
} onProgress:^(NSInteger number) {
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
}];

Examples 🌟

You can find a demo app that uses the SDK in the open-im-ios-demo repository.

Requirements 🌐

• The minimum deployment target is iOS 11.0.

Community :busts_in_silhouette:

• 📚 OpenIM Community
• 💕 OpenIM Interest Group
• 🚀 Join our Slack community
• :eyes: Join our wechat (微信群)

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:

OpenIM is licensed under the Apache 2.0 license. See LICENSE for the full license text.