Rongyun SDK

The Android version of Rongyun SDK is a development source software for Android applications. Rongyun SDK provides a series of technical solutions for the different needs of developers, such as client IM components, client IM basic libraries, Web SDK, server REST API, etc. Developers can use these solutions to build their own products in the application

Software features

IM interface components - IMKit
IMKit is one of the core features of Rongyun SDK. Rongyun encapsulates the most complex functions such as conversation list, chat window, message content display, and conversation settings in instant messaging products into components. Through short codes, you can directly integrate the above interfaces into your app products, saving a lot of development and debugging time. Rongyun also supports the richest custom interface component functions in the industry, and you can freely design and develop according to your own interface needs.
The core class of IMKit is RongIM on the Android platform and RCIM on the iOS platform. These two classes will have the same meaning as IMKit in future development.
IM communication capability library - IMLib
IMLib is a basic IM communication capability library without interfaces, encapsulating communication capabilities and objects such as sessions and messages. After being referenced into the App project, developers need to implement the UI interface themselves. It is relatively lightweight and suitable for developers who have high customization requirements for UI.
The core class of IMLib is RongIMClient on the Android platform and RCIMClient on the iOS platform. These two classes will have the same meaning as IMLib in future development.
The integration process of Rongyun is shown in the figure below. Several key links need attention:
For the Token exchange process on the App server, please refer to the Server Development Document - Obtaining Token Method
For the client integration process, please refer to the Android Development Guide or iOS Development Guide
For UI interface customization, please refer to Android Development Guide - UI Customization or iOS Development Guide - UI Customization

Function introduction

Private chat
It refers to two users chatting one-on-one. The conversation relationship is established and maintained by Rongyun. You can receive push notifications after exiting the chat interface or going offline.
discussion group
It refers to two or more users chatting together. Users can add friends to generate a discussion group chat. Rongyun is responsible for establishing and maintaining the conversation relationship. You can receive push notifications after exiting the chat interface or going offline.
Group chat
Refers to two or more users chatting together. Different from discussion groups, the set of group member IDs participating in group chats is provided and maintained by your App. Rongyun is only responsible for conveying messages to all users in the group chat. You can receive push notifications after exiting the chat interface or going offline. Supports the needs of large communities of up to 3,000 people.
chat room
For group chats with no user limit, users exiting the chat interface are deemed to have left the chat room and will no longer receive any notifications or reminders. Rongyun is responsible for establishing and maintaining the conversation relationship. Through SDK related interfaces, users can join or exit the chat room.
Customer service message
Users communicate with your App backend customer service through messages, supporting single customer service and multiple customer service.
VoIP audio calls
Refers to enabling two users to establish one-to-one audio calls through the IP network.
Conversation list
Refers to the interface in which various sessions are arranged in order, where each list item in the session list is called a session. The order of sorting will depend on factors such as pinned, latest conversations, unread conversations, and time.

User Guide

Before you can develop an application, you need to create an application on the Rongyun Developer Platform. If you have already registered a Rongyun developer account, please go to the Rongyun Developer Platform to create an application.
After you create the application, the first thing you need to know is the App Key/Secret. They are the necessary identifiers for the Rongyun SDK to connect to the server. Each App corresponds to a set of App Key/Secret. For developers' production environment and development environment, we provide two sets of App Key/Secret, and the functions of the two environments are exactly the same. You can use the development environment before your application is finally launched.
image
App Key/Secret Location
The development environment App Key/Secret is specially provided for you for development use only. The development environment will be isolated from the data in the production environment to avoid conflicts between development environment data and online production environment data.
The App Key/Secret for the production environment is not provided by default. We will provide the App Key/Secret for the production environment after you submit it for online use.
4. Obtain Token
Token is called a user token, App Key is the unique identifier of your App, and Token is the identity authorization symbol of each user on your App. You can obtain a Token corresponding to the user by submitting information such as userId, and use this Token as the user's unique identity credential to communicate with other users.
The main function of Token is identity authorization and security, so you cannot directly access the Rongyun server through the client to obtain the Token. You must obtain the Token from the Rongyun server through the Server API and return it to your App, and use it when connecting later. For detailed description, please refer to the User Services and Token Obtaining Methods sections in the Server Development Guide.
In order to facilitate your use during the integration and testing process, we also provide API debugging tools. When you cannot deploy the server program, you can directly obtain the Token by passing in the userId and name. Please visit the Rongyun Developer Platform, open the application you want to test, and select "API Debugging" in the left menu.
userId: Each user corresponds to a userId. This userId is maintained by you, so you can assign it directly. Communication between two of your users is communication between two userIds for Rongyun.
name: The display name of the user, used to display the user name by default when pushing or when you do not pass in user information.
portraitUri: User avatar, used as the default avatar when you do not pass in user information. If the picture does not exist, IMKit will display the default avatar.
Through API debugging, you can get a Token return value. You can directly use this Token to send and receive messages for this user.