邀请卡组件

 

版本历史

版本号更新时间更新描述
1.0.12022.6.15组件上线
1.0.22022.11.24优化UI
1.2.42023.8.7修复已知问题
1.2.62023.12.1升级依赖Glide4.x版本
1.2.72024.2.2修复已知问题

 

组件引入

注意:所有使用互动组件必须要引入basemodule库,最新版本见 互动组件对接文档

项目根目录build.gradle引入:

module的build.gradle引入:

Application的onCreate方法中,调用DWLiveEngine.init初始化dwlivesdk后,添加代码:

 

1. 组件描述

邀请卡组件是基于基础组件库扩展的组件服务,包括展示邀请卡,获取排行榜等功能,为业务方提供邀请卡能力。邀请卡组件包含管理器和基于管理器实现的UI界面,接入方可基于管理器对外API实现完全自定义UI的邀请卡,也可直接集成组件SDK提供的UI。

 

2. 组件架构

2.1 组件架构图

image-20220506100931572

2.2 核心对外API

IInvitationCardManager内部唯一实现类为InvitationCardManagerImpl

作用API
初始化init(BaseInvitationCardListener listener, String userId, String roomId, String interactToken, String originUrl, String avatarUrl, Context context)
获取邀请卡列表getCardList(IBaseCallBack<List> callBack)
获取邀请卡配置getCardConfig(IBaseCallBack callBack)
获取短链接getShortLink(String originUrl, IBaseCallBack callBack)
获取排行榜getCardRankList(IBaseCallBack<List> callBack)
重连reConnect()
释放release()

API接口代码

 

2.3 数据参数定义

数据类参数说明

 

3. 组件接入

3.1 使用组件提供UI

邀请卡ViewGroup为InvitationCardMainLayout

  1. 登录业务SDK(云直播等)

  2. xml中添加InvitationCardMainLayout

  3. 初始化组件

    1. 获取token-初始化组件需要传递参数token,可以通过业务SDK(云直播等)提供的对外API获取token

    2. 使用业务SDK提供的配置信息初始化组件SDK

      代码示例(以云直播为例):

  1. 销毁组件

 

3.2 使用组件管理器+自定义UI

邀请卡管理器实现类为InvitationCardManagerImpl,对外方法参照IInvitationCardManager,UI可以参考InvitationCardBaseLayout以及其子类InvitationCardMainLayout实现

 

4. 混淆配置

混淆配置

 

5. 组件库依赖