CONFIGKEY.md

Common Function Configuration Guide

• Offline push
• 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, make the corresponding iOS configuration. Then find the following files in the code and modify the corresponding iOS side key:

• push_controller.dart

  const appID = 'your-app-id';
  const appKey = 'your-app-key';
  const appSecret = 'your-app-secret';

Android platform configuration: According to its documentation, make corresponding Android configurations, and pay attention to multi-vendor configurations. Then modify the following file contents:

• build.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) in overseas regions

According to the integration guide of FCM, replace the following files:

• google-services.json (Android platform)
• GoogleService-Info.plist (iOS platform)
• 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:

  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 for details. The code in the project needs to modify the following Key:

• webKey
• webServerKey

  static const webKey = 'webKey';
  static const webServerKey = 'webServerKey';

Once the configuration is complete, you can enable the map function.