接入指南

优质
小牛编辑
128浏览
2023-12-01

表情云商店SDK接入说明

欢迎使用表情云商店SDK

SDK主要包括jar包、jni库、AndroidManifest.xml,以及res目录下的一些资源文件。我们建议将它作为一个模块(module)集成到gradle项目中去。

第一步:下载并引入module

首先将DongtuStoreSDK目录复制到项目中。

修改settings.gradle,加入如下代码,让gradle识别这个module:

include 'DongtuStoreSDK'

找到需要使用DongtuStoreSDK的module(一般是应用的module,或者应用所用到的UI组件库module),修改它的build.gradle,在dependencies中加入:

api project(':DongtuStoreSDK')

然后,module的引入就宣告完成了。

第二步:传入必要信息

开发者通过如下方法传入配置信息:

DongtuStore.initConfig(context, APP_ID, APP_SECRET);

该方法在APP的生命周期中调用一次即可,但需要早于SDK的任何其他方法被调用。我们建议在Application.onCreate()中调用它。

该方法的主要作用有两个:

  1. 注册在动图宇宙官网申请到的App IDApp Secret,以便SDK调用后台接口;

  2. 传入一个Context进行一些数据的准备(例如查找资源ID、得到cache的路径等)。

在使用SDK的功能之前,还需要确认此方法是否正确调用(注:用户信息非必须,可以为空字符串)。传入用户信息的代码如下:

DongtuStore.setUserInfo(USER_ID, USER_NAME, USER_GENDER, USER_ADDRESS, USER_EMAIL, USER_PHONE, EXTRA_INFO);

第三步:使用功能

1. 单例的加载与销毁

DongtuStore在使用时,会有一个单例一直存在于内存中。单例的加载和销毁由SDK内部处理,开发者不需要特别关心。

但如果有需要的话,也可以在合适的时机预先加载,避免冷启动,加快响应速度:

DongtuStore.load()

在有一段时间不会用到SDk时,可以按需销毁单例,节省一些内存:

DongtuStore.destroy()

2. 传入UI组件

加载单例之后,需要调用方法传入一些UI组件。DongtuStore会给这些组件加上必要的Listener、填充数据。

DongtuStore.setKeyboard(mKeyboard);
DongtuStore.setEditText(mEditView);

3. 设置联想功能

联想功能可以在用户输入文字时实时地进行文字搜索,将搜到的动图以弹窗形式展示给用户。

为了保证弹窗能够正常地显示和隐藏,所在Activity的windowSoftInputMode属性需要被设置为adjustResize

DongtuStore.setupSearchPopupAboveView(anchorView, editView);

其中anchorView是定位弹窗用的。

4. 设置消息发送回调

开发者需要设置回调来处理两种通过DongtuStore发送的消息,并对消息进行封装和发送。这里演示的是将消息封装为JSON的方法。

DongtuStore.setSendMessageListener(new DTStoreSendMessageListener() {
    /**
     * 在表情键盘中点击表情发送的消息
     */
    @Override
    public void onSendSticker(DTStoreSticker sticker) {
        JSONArray messageData = new JSONArray();
        JSONArray messageItem = new JSONArray();
        messageItem.put(sticker.code);
        messageItem.put(2);
        messageData.put(messageItem);
        sendMessage(messageData);
    }

    /**
     * 通过动图搜索弹窗发送的消息
     */
    @Override
    public void onSendDTImage(DTImage image) {
        HashMap<String, Object> messageDataMap = new HashMap<>();
        messageDataMap.put("image", image.getImage());
        messageDataMap.put("id", image.getId());
        messageDataMap.put("width", image.getWidth());
        messageDataMap.put("height", image.getHeight());
        messageDataMap.put("is_animated", image.isAnimated());
        JSONObject messageData = new JSONObject(messageDataMap)
        sendMessage(messageData);
    }
});

5. 展示消息

展示消息需要用到的控件有两种。商店表情和文字需要用DTStoreMessageView展示,而动图需要使用DTImageView来展示。

展示文字时:

dtStoreMessageView.showText(text);

展示商店表情时:

dtStoreMessageView.showSticker(stickerCode);

展示动图时:

DongtuStore.loadImageInto(dtImageView, image, id, width, height);

widthheight参数的作用是指定动图的显示长宽。

6. 消息的封装与解析

封装消息的格式与SDK无关,只要保证将必要的信息传送到接收端,令其能够正确解析和展示动图即可。

对于不同的消息类型,必要的信息分别为:

  • 文字消息

    • 文本
  • 商店表情消息

    • 表情code
  • 动图消息

    • image(String,由DTImage.getImage()获得)
    • ID(String,由DTImage.getId()获得)
    • width(int,由DTImage.getWidth()获得)
    • height(int,由DTImage.getHeight()获得)
    • isAnimated(int,0代表否,1代表是,由DTImage.isAnimated()获得,iOS需要)

7. 表情收藏

SDK从3.1版本开始提供了表情收藏功能,无论是商店中提供的表情还是搜索UI提供的Gif,都可以由用户加入收藏。开发者只需做两件事请:

  • 在需要进行收藏操作的时候,调用collectionHasStickercollectStickerremoveCollectedStickercollectionHasGifcollectGifremoveCollectedGif这几个接口;

  • 在调用setUserInfo时,给每个用户提供一个唯一的UserId。

一个用户收藏的表情可以在键盘中的“收藏”tab查看并发送,在该tab中还有一个收藏管理按钮,点击之后可以进入用于对收藏内容进行删除和排序的界面。

7. UI定制

SDK对部分UI提供了定制。

对于表情商店等界面,开发者如果需要更改颜色,可以修改dtstore_color.xml中的相应值,如果需要更改控件大小,可以修改dtstore_dimens.xml中的相应值。

对于展示商店表情消息的控件DTStoreMessageView,可以通过style来设置其中文本的样式,具体方法在类和开放接口文档中有详细描述。

8. proguard配置

参见Demo中的proguard-rules.txt