IDO Icon API Documentation

1. Function Overview

Provides the ability to set the country code, cache server address, app key, language unit, query icon update status, app package names, and retrieve/delete local sandbox cache, and deliver app icons.

2. API Capabilities

1. Country Code (IOS)

1.1 Function Overview:

Provides the country code member, only used for IOS.

1.2 API ID:

String? ios_countryCode;

1.3 API Parameter Description:

@param: ios_countryCode - Country code, e.g., 'US' for the United States, 'CN' for China.

2. Cache Server Address (IOS)

2.1 Function Overview:

Provides the cache server address member, only used for IOS.

2.2 API ID:

String? ios_baseUrlPath;

2.3 API Parameter Description:

@param: ios_baseUrlPath - Cache server address, e.g., 'https://cn-user.idoocloud.com/api/ios/lookup/get'. If not assigned, the Apple interface will be used (slower response).

3. App Key (IOS)

3.1 Function Overview:

Provides the app key member, only valid when using the cache server, only used for IOS.

3.2 API ID:

String? ios_appKey;

3.3 API Parameter Description:

@param: ios_appKey - The app key assigned by the backend. Each app has its own unique app key. Please consult the backend developer for details, e.g., '800a6444f9c0433c8e88741b6ddf1443'.

4. Language Unit (IOS)

4.1 Function Overview:

Provides the language unit member, only used for IOS.

4.2 API ID:

int? ios_languageUnit;

4.3 API Parameter Description:

@param: ios_languageUnit - The language unit. If not specified, the default language unit is English.

Jump to language unit content description => IDO Language Unit Content Description

5. Query Icon Update Status (IOS)

5.1 Function Overview:

Provides the ability to query the current update status.

5.2 API ID:

Future<bool> get updating;

5.3 API Parameter Description:

@return: updating - Update flag, Future boolean type. false: idle, true: updating icons and names.

6. Query Default Notification App Package Names (IOS)

6.1 Function Overview:

Provides the ability to query the package names of default notification apps supported by the device, only used for IOS.

6.2 API ID:

List<String>? ios_defaultPackNames();

6.3 API Parameter Description:

@return: List of strings, the package name collection, include:

class IDOAppIconInfoModel {
  int? version;              /// Version number
  int? iconWidth;            /// Icon width
  int? iconHeight;           /// Icon height
  int? colorFormat;          /// Color format
  int? blockSize;            /// Compression block size
  int? totalNum;             /// Total number
  List<IDOAppIconItemModel>? items; /// Package name details collection
};

class IDOAppIconItemModel extends IDOAppInfo {

    int? itemId;             /// Unique item ID assigned to each package name, starting from 0
    int? msgCount;           /// Number of received messages
    String? iconCloudPath;   /// Icon cloud address
    int? state;              /// Icon update status: 0 - no update needed, 1 - icon update needed, 2 - app name update needed, 3 - both icon and app name update needed
    String? iconLocalPathBig;/// Icon local address of the large size icon in the sandbox (displayed in the app list)   
    String? countryCode;     /// Country code
    bool? isDownloadAppInfo; /// Whether the app information has been downloaded
    bool? isUpdateAppName;   /// Whether the app name has been updated
    bool? isUpdateAppIcon;   /// Whether the app icon has been updated
    bool? isDefault;         /// Whether it is a default app
  }

7. Query Cached App Information (IOS)

7.1 Function Overview:

Provides the ability to query the cached version number, icon information (size, color format, quantity, compression block size), and package name details, only used for IOS.

7.2 API ID:

Future<IDOAppIconInfoModel> getCacheInfoModel();

7.3 API Parameter Description:

@return: Cached app information, including:

class IDOAppIconInfoModel {
  int? version;              /// Version number
  int? iconWidth;            /// Icon width
  int? iconHeight;           /// Icon height
  int? colorFormat;          /// Color format
  int? blockSize;            /// Compression block size
  int? totalNum;             /// Total number
  List<IDOAppIconItemModel>? items; /// Package name details collection
};

class IDOAppIconItemModel extends IDOAppInfo {

    int? itemId;             /// Unique item ID assigned to each package name, starting from 0
    int? msgCount;           /// Number of received messages
    String? iconCloudPath;   /// Icon cloud address
    int? state;              /// Icon update status: 0 - no update needed, 1 - icon update needed, 2 - app name update needed, 3 - both icon and app name update needed
    String? iconLocalPathBig;/// Icon local address of the large size icon in the sandbox (displayed in the app list)   
    String? countryCode;     /// Country code
    bool? isDownloadAppInfo; /// Whether the app information has been downloaded
    bool? isUpdateAppName;   /// Whether the app name has been updated
    bool? isUpdateAppIcon;   /// Whether the app icon has been updated
    bool? isDefault;         /// Whether it is a default app
  }

8. Query Icon Image Directory Path (IOS)

8.1 Function Overview:

Provides the ability to query the directory path where the icon images are stored, only used for IOS.

8.2 API ID:

Future<String> ios_getIconDirPath();

8.3 API Parameter Description:

@return: Icon image directory path, string type.

9. Reset App Icon Information (IOS)

9.1 Function Overview:

Provides the ability to delete locally cached images in the sandbox, only used for IOS.

9.2 API ID:

Future<bool> resetIconInfoData({required String macAddress, bool deleteIcon = true});

9.3 API Parameter Description:

@param:mac of need to delete cache

@param:is delete icon picture file, true:yes,false:no,default yes

@return: Deletion result, false: failed, true: successful.

10. Register Listener for Update Messages Icon (IOS)

10.1 Function Overview:

Provides the ability to register a listener for update messages icon, only used for IOS. Register once globally.

10.2 API ID:

void ios_registerListenUpdate();

10.3 API Parameter Description:

No parameters.

11.android已安装所有app信息集合：

11.1 功能概括:

提供查询android已安装所有app信息集合的能力，只有Android使用。

ios需要执行获取默认的APP包名列表信息，因为event_type是固件分配的(force强制更新应用名称)

11.2 API ID:

Future<List<IDOAppIconItemModel>> firstGetAllAppInfo({bool force = false});

11.3 API参数说明:

@param:force,强制更新Android 消息图标和名字

@param:消息应用图标内容，包括：

11.android has installed all app information collection:

11.1 Function Summary:

Provides the ability to query the information collection of all installed apps on android, which is only used by Android.

ios needs to perform to get the default APP package name list information, because event_type is firmware assigned (force to update the app name)

11.2 API ID:

Future<List<IDOAppIconItemModel>> firstGetAllAppInfo({bool force = false});

11.3 API parameters:

@param:force to update the Android message icon and name

@param: Message app icon content, including:

class IDOAppIconInfoModel {
  int? version;              /// Version number
  int? iconWidth;            /// Icon width
  int? iconHeight;           /// Icon height
  int? colorFormat;          /// Color format
  int? blockSize;            /// Compression block size
  int? totalNum;             /// Total number
  List<IDOAppIconItemModel>? items; /// Package name details collection
};

class IDOAppIconItemModel extends IDOAppInfo {

    int? itemId;             /// Unique item ID assigned to each package name, starting from 0
    int? msgCount;           /// Number of received messages
    String? iconCloudPath;   /// Icon cloud address
    int? state;              /// Icon update status: 0 - no update needed, 1 - icon update needed, 2 - app name update needed, 3 - both icon and app name update needed
    String? iconLocalPathBig;/// Icon local address of the large size icon in the sandbox (displayed in the app list)   
    String? countryCode;     /// Country code
    bool? isDownloadAppInfo; /// Whether the app information has been downloaded
    bool? isUpdateAppName;   /// Whether the app name has been updated
    bool? isUpdateAppIcon;   /// Whether the app icon has been updated
    bool? isDefault;         /// Whether it is a default app
  }