跳转至

配置说明

配置文件使用说明

配置文件用于构造 RCUserInfo 的对象。其中的参数信息,需要提供给客户端开发人员和运营人员,以便能够正确的实现消息中心相关消息的发送和保存。

客户端开发人员:读取配置文件中的数据,设置用户信息缓存,并且会根据数据进行布局设置。

布局注释截图:

image

运营人员:登录开发者平台,进入“运营管理”页面。将配置文件中的 id 信息,添加到消息中心/分类设置中,以保证后台投放消息能够正确发送到指定的 id 中。

image

配置文件
{
  "h-users": [
    {
      "id": "rong_system_trading",
      "name": "交易信息",
      "portrait": "https://rongcloud-res.cn.ronghub.com/6fb522d997abb6e7fda21b090593b8a6"
    },
    {
      "id": "rong_system_notice",
      "name": "系统通知",
      "portrait": "https://rongcloud-res.cn.ronghub.com/029050d88b0d75a3507550eaf7ce63ed"
    },
    {
      "id": "rong_system_event",
      "name": "活动福利",
      "portrait": "https://rongcloud-res.cn.ronghub.com/125c94ebe629dc0b539f2126f01a105b"
    }
  ],
  "v-users": [
    {
      "id": "rong_system_community",
      "name": "社区消息",
      "portrait": "https://rongcloud-res.cn.ronghub.com/381b9fe0009d146035d6356e30cd2a4a"
    },
    {
      "id": "rong_system_interaction",
      "name": "互动消息",
      "portrait": "https://rongcloud-res.cn.ronghub.com/808ce1ebad4aba400491ce0005ea75de"
    }
  ],
  "display-friends": true
}
配置文件构成

建议配置文件由应用服务器端生成,将一致的配置文件提供给运营人员和客户端开发人员。

  1. h-users:表示在消息中心页面中置顶并横向显示的图标的信息集合,集合中元素的数量要求小于等于 5 个,如果超过 5 个,页面上只会显示前 5 个。
  2. v-users:表示在消息中心页面的列表中纵向显示的会话的信息集合,集合中元素的数量不限。(纵向显示的会话只有收到消息后,才会显示,虽然配置文件中 v-users 有 2 个元素,但是只有其中 1 个收到的消息,所以只显示了 1 个)
  3. display-friends:表示是否显示“我的好友”,true 为显示,false 为不显示。

h-users 和 v-users 中的每一个数据元素由 "id"、"name" 和 "portrait" 组成:

"id":发送“消息中心”消息的 UserId。

"name":客户端本地通知栏中显示的昵称。

"portrait":消息展示页面中,接收消息中需要展示的头像地址。

客户端开发人员需要从配置文件中读取这些数据模型,构造 RCUserInfo 的对象,并将构造的对象刷新到用户信息缓存中。

iOS 端示例代码:

- (void)loadUserInfo:(NSArray*)userInfoList {
    if (userInfoList.count > 0) {
        //从配置文件中读取用户信息列表,并刷新用户信息缓存。
        for (NSDictionary *user in userInfoList) {
            RCUserInfo *userInfo = [RCUserInfo new];
            userInfo.userId = user[@"id"];
            userInfo.name = user[@"name"];
            userInfo.portraitUri = user[@"portrait"];
            [[RCIM sharedRCIM] refreshUserInfoCache:userInfo withUserId:userInfo.userId];
        }
    }
}

注意事项

  • 配置文件的文件名不能修改。
  • 配置文件 json 中 key 对应的 value 值可以增加和减少,但是格式不能被修改,否则将无法正确解析。