Initial commit with latest code

Author: std-s

CONFIGKEY.md

@@ -0,0 +1,88 @@
+
+# Common Function Configuration Guide
+
+- [Offline push](#offlinepush)
+- [Map](#map)
+
+## Offlinepush
+
+Currently using the integrated solution.
+
+### Client configuration
+
+#### 1. Use Getui (https://getui.com/) in mainland China
+
+###### Configure iOS and Android in the integration guide of Getui
+
+**iOS platform configuration:**
+According to [its documentation](https://docs.getui.com/getui/mobile/ios/overview/), make the corresponding iOS configuration. Then find the following files in the code and modify the corresponding iOS side key:
+
+- **[push_controller.dart](openim_common/lib/src/controller/push_controller.dart)**
+
+```dart
+  const appID = 'your-app-id';
+  const appKey = 'your-app-key';
+  const appSecret = 'your-app-secret';
+```
+
+**Android platform configuration:**
+According to [its documentation](https://docs.getui.com/getui/mobile/android/overview/), make corresponding Android configurations, and pay attention to [multi-vendor](https://docs.getui.com/getui/mobile/vendor/vendor_open/) configurations. Then modify the following file contents:
+
+- **[build.gradle](android/app/build.gradle)**
+
+```gradle
+  manifestPlaceholders = [
+      GETUI_APPID    : "",
+      XIAOMI_APP_ID  : "",
+      XIAOMI_APP_KEY : "",
+      MEIZU_APP_ID   : "",
+      MEIZU_APP_KEY  : "",
+      HUAWEI_APP_ID  : "",
+      OPPO_APP_KEY   : "",
+      OPPO_APP_SECRET: "",
+      VIVO_APP_ID    : "",
+      VIVO_APP_KEY   : "",
+      HONOR_APP_ID   : "",
+  ]
+```
+
+#### 2. Use [FCM (Firebase Cloud Messaging)](https://firebase.google.com/docs/cloud-messaging) in overseas regions
+
+According to the integration guide of [FCM](https://firebase.google.com/docs/cloud-messaging), replace the following files:
+
+- **[google-services.json](android/app/google-services.json)** (Android platform)
+- **[GoogleService-Info.plist](ios/Runner/GoogleService-Info.plist)** (iOS platform)
+- **[firebase_options.dart](openim_common/lib/src/controller/firebase_options.dart)** (Firebase configuration in Dart project)
+
+### Offline push banner settings
+
+Currently, the SDK is designed to directly control the display content of the push banner by the client. When sending a message, set the input parameter [offlinePushInfo](https://github.com/openimsdk/openim-flutter-demo/blob/cc72b6d7ca5f70ca07885857beecec512f904f8c/lib/pages/chat/chat_logic.dart#L543):
+
+```dart
+  final offlinePushInfo = OfflinePushInfo(
+  title: "Fill in the title",
+  desc: "Fill in the description, such as the message content",
+  iOSBadgeCount: true,
+  );
+  // If you do not customize offlinePushInfo, the title defaults to the app name, and the desc defaults to "You received a new message"
+```
+
+According to actual needs, you can enable the offline push function after completing the corresponding client and server configurations.
+
+---
+
+## Map
+
+### Configuration Guide
+
+Need to configure the corresponding AMap Key. Please refer to [AMap Document](https://lbs.amap.com/) for details. The code in the project needs to modify the following Key:
+
+- **[webKey](https://github.com/openimsdk/openim-flutter-demo/blob/5720a10a31a0a9bc5319775f9f4da83d6996dbfe/openim_common/lib/src/config.dart#L49)**
+- **[webServerKey](https://github.com/openimsdk/openim-flutter-demo/blob/5720a10a31a0a9bc5319775f9f4da83d6996dbfe/openim_common/lib/src/config.dart#L50)**
+
+```dart
+  static const webKey = 'webKey';
+  static const webServerKey = 'webServerKey';
+```
+
+Once the configuration is complete, you can enable the map function.

CONFIGKEY.zh-CN.md

@@ -0,0 +1,88 @@
+
+# 常见功能配置指南
+
+- [离线推送功能](#离线推送功能)
+- [地图功能](#地图功能)
+
+## 离线推送功能
+
+目前使用的是集成方案。
+
+### 客户端配置
+
+#### 1. 中国大陆地区使用个推（[Getui](https://getui.com/)）
+
+###### 在[Getui](https://getui.com/)的集成指南，配置iOS和Android。
+
+**iOS 平台配置：**
+根据[其文档](https://docs.getui.com/getui/mobile/ios/overview/)做好相应的iOS配置。然后在代码中找到以下文件并修改对应的 iOS侧Key：
+
+- **[push_controller.dart](openim_common/lib/src/controller/push_controller.dart)**
+
+```dart
+  const appID = 'your-app-id';
+  const appKey = 'your-app-key';
+  const appSecret = 'your-app-secret';
+```
+
+**Android 平台配置：**
+根据[其文档](https://docs.getui.com/getui/mobile/android/overview/)做好相应的Android配置，注意[多厂商](https://docs.getui.com/getui/mobile/vendor/vendor_open/)配置。然后修改以下文件内容：
+
+- **[build.gradle](android/app/build.gradle)**
+
+```gradle
+  manifestPlaceholders = [
+      GETUI_APPID    : "",
+      XIAOMI_APP_ID  : "",
+      XIAOMI_APP_KEY : "",
+      MEIZU_APP_ID   : "",
+      MEIZU_APP_KEY  : "",
+      HUAWEI_APP_ID  : "",
+      OPPO_APP_KEY   : "",
+      OPPO_APP_SECRET: "",
+      VIVO_APP_ID    : "",
+      VIVO_APP_KEY   : "",
+      HONOR_APP_ID   : "",
+  ]
+```
+
+#### 2. 海外地区使用 [FCM（Firebase Cloud Messaging）](https://firebase.google.com/docs/cloud-messaging)
+
+根据 [FCM](https://firebase.google.com/docs/cloud-messaging) 的集成指南，替换以下文件：
+
+- **[google-services.json](android/app/google-services.json)**（Android 平台）
+- **[GoogleService-Info.plist](ios/Runner/GoogleService-Info.plist)**（iOS 平台）
+- **[firebase_options.dart](openim_common/lib/src/controller/firebase_options.dart)**（Dart 项目中的 Firebase 配置）
+
+### 离线推送横幅设置
+
+目前SDK的设计是直接由客户端控制推送横幅的展示内容。发送消息时，设置入参[offlinePushInfo](https://github.com/openimsdk/openim-flutter-demo/blob/cc72b6d7ca5f70ca07885857beecec512f904f8c/lib/pages/chat/chat_logic.dart#L543)：
+
+```dart
+  final offlinePushInfo = OfflinePushInfo(
+    title: "填写标题",
+    desc: "填写描述信息，例如消息内容",
+    iOSBadgeCount: true,
+  );
+  // 如果不自定义offlinePushInfo，则title默认为app名称，desc默认为为“你收到了一条新消息”
+```
+
+根据实际需求，完成对应的客户端和服务端配置后即可启用离线推送功能。
+
+---
+
+## 地图功能
+
+### 配置指南
+
+需要配置对应的 AMap Key。具体请参考 [AMap 文档](https://lbs.amap.com/)，工程中的代码需要修改以下 Key：
+
+- **[webKey](https://github.com/openimsdk/openim-flutter-demo/blob/5720a10a31a0a9bc5319775f9f4da83d6996dbfe/openim_common/lib/src/config.dart#L49)**
+- **[webServerKey](https://github.com/openimsdk/openim-flutter-demo/blob/5720a10a31a0a9bc5319775f9f4da83d6996dbfe/openim_common/lib/src/config.dart#L50)**
+
+```dart
+  static const webKey = 'webKey';
+  static const webServerKey = 'webServerKey';
+```
+
+完成配置后即可启用地图功能。

LICENSE

@@ -0,0 +1,45 @@
+OpenIM Open Source License
+This repository is licensed under the GNU Affero General Public License version 3 (AGPL-3.0) and is subject to the following additional terms:
+1. Commercial Use
+1.1 Prohibition of Commercial Use
+This repository and its contents may not be used for any commercial purposes. If you wish to use OpenIM for commercial purposes, you must obtain a commercial license from the producer.
+1.2 Commercial License Application
+For commercial licensing, please contact [email protected]. Commercial licenses will be tailored to your specific needs and use cases to ensure that you use OpenIM legally and compliantly.
+1.3 License After Commercial Authorization
+If you have paid the relevant commercial licensing fees to the producer, you may use OpenIM in accordance with the terms of the commercial license without adhering to the provisions of AGPL-3.0. The commercial license grants you the rights to use, modify, and distribute OpenIM under specific conditions detailed in the commercial licensing agreement.
+2. LOGO and Copyright Information
+2.1 Protection of LOGO and Copyright Information
+During the use of this repository, you may not remove, modify, or hide the LOGO or copyright information within the OpenIM console or applications.
+2.2 LOGO Definition
+All unified text or icons bearing the words OpenIM or OpenIMSDK within the user interfaces of this repository are collectively referred to as the LOGO. This includes, but is not limited to, textual and iconographic identifiers in software interfaces, documentation, and promotional materials.
+3. Contributor Agreement
+As a contributor, you agree to the following terms:
+3.1 Right to Adjust the Agreement
+The producer reserves the right to adjust the strictness or leniency of the open-source agreement as necessary to ensure that the agreement aligns with the development and needs of the project.
+3.2 Commercial Use of Code
+The code you contribute may be used for commercial purposes, including but not limited to cloud business operations. By contributing, you agree that the producer has the right to use your contributions for commercial purposes without additional compensation or authorization.
+4. Other Terms
+4.1 Compliance with AGPL-3.0
+Except for the specific conditions mentioned above, all other rights and restrictions are governed by the GNU Affero General Public License version 3 (AGPL-3.0). For detailed information about the AGPL-3.0 license, please refer to the GNU AGPL-3.0 License.
+4.2 Patent Protection
+The interactive design of this product is protected by design patents. Any unauthorized copying, modification, or distribution of the interactive design constitutes infringement and will be subject to legal action.
+5. Disclaimer
+This software is provided "as is," without any form of express or implied warranty, including but not limited to warranties of merchantability, fitness for a particular purpose, or non-infringement. Users assume all risks associated with the use of this software.
+6. Contact Information
+For any licensing-related questions or to obtain a commercial license, please contact [email protected].
+
+GNU Affero General Public License Version 3 (AGPL-3.0)
+© 2024 OpenIMSDK
+
+This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as
+    published by the Free Software Foundation, either version 3 of the
+    License, or (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.