API 说明

下面是对内容中台(MPContent )SDK 相关 API 的详细说明。

初始化 MPContent SDK

MPContent.getInstance().init(application, userId, feedType);

请求参数

参数

类型

描述

application

Application

App 上下文

userId

String

用户标识

feedType

MPContent.FeedType

Feed 流类型

返回参数

无。

创建首页 Feed 流

创建首页 Feed 流,返回首页 Feed 流 View 供您添加到自己的项目中去。

View  MPContent.getInstance().createFeedListView(Context context)

请求参数

参数

类型

描述

Context

context

上下文

返回参数

参数

类型

描述

view

View

Feed 流页面的 View

在图文详情页插入自定义 View

MPContent.getInstance().setDetailADViewListen(DetailADViewListen detailADViewListen) 

请求参数

参数

类型

描述

detailADViewListen

DetailADViewListen

图文详情页回调数据给用户,用户返回一个 View 插入详情页底部。

返回参数

无。

获取当前视频播放播状态

默认视频自动播放。

boolean MPContent.getInstance().isAutoPlay()

请求参数

无。

返回参数

参数

类型

描述

isAutoPlay

boolean

视频是否自动播放

设置视频是否自动播放

默认视频自动播放。

MPContent.getInstance().setAutoPlay(boolean autoPlay)

请求参数

参数

类型

描述

autoPlay

boolean

视频是否自动播放

返回参数

无。

点击购买产品时回调

当用户在详情页点击购物车时弹框,在用户点击购买产品时进行回调。点击后,用户将跳转到业务自定义的下单页面。

MPContent.getInstance().setJumpDetailsListener(JumpListener jumpListener)

请求参数

参数

类型

描述

jumpListener

JumpListener 接口

购买产品时回调

返回参数

无。

未登录回调

点赞未登录时进行回调。用户需要在登录后才能进行点赞操作。

MPContent.getInstance().setNoLoginListener(NoLoginListener noLoginListener)

请求参数

参数

类型

描述

noLoginListener

NoLoginListener 接口

点赞时未登录回调,在用户成功登录后设置用户的 userId

返回参数

无。

首页 Feed 流列表指定位置插入自定义 View

MPContent.getInstance().setCustomFeedItemADView(int itemIndex, View customFeedItemADView)

请求参数

参数

类型

描述

itemIndex

int

recyclerView 列表指定下标插入 View。

customFeedItemADView

View

要插入的自定义 View。

返回参数

无。

请求首页 Feed 流数据

   MPContent.getInstance().getFeedListData(feedsRequestPBParam , new FeedListDataCallBack() {
            @Override
            public void feedListSuccess(FeedsResponsePB feedsResponsePB) {
                //子线程
            }

            @Override
            public void feedListFail(int i, String s) {
            
            }
        });

请求参数

参数

类型

描述

feedsRequestPBParam

FeedsRequestPBParam

Feed 流请求数据,参数说明见下表。

feedListSuccess

FeedListDataCallBack

成功回调,默认在子线程

feedListDataCallBack

FeedListDataCallBack

失败回调,默认在子线程

FeedsRequestPBParam 字段说明:

参数

类型

描述

requestType

String

必填,请求内容的类型:

  • 1000:图文视频混排

  • 1001:图文

  • 1002:视频

  • 1003:沉浸式视频

  • 1004:聚合类型

requestCategory

FeedCategoryPB

必填,请求场景:

  • FEATURED(0),表示推荐

  • FOLLOW(1),表示关注

  • HOMEPAGE(2),表示个人主页

refreshType

RefreshTypePB

必填,刷新类型:

  • MPFeedListRefreshTypeHome = 0,表示覆盖

  • MPFeedListRefreshTypeReload = 1,表示下拉刷新

  • MPFeedListRefreshTypeLoadMore = 2,表示上拉加载更多

topFeedIds

String

选填,指定内容 ID

excludeFeedIds

String

选填,去重内容 ID

publisherId

String

作者 ID, 获取个人主页内容时必填。

extInfo

MapStringString

选填,扩展信息。如需设置返回结果的个数,可传参 {"pageSize": "3"}

返回参数

参数

类型

描述

resPB

FeedsResponsePB

Feed 流返回数据,参数说明详见下表。

resPB 字段说明:

参数

类型

描述

success

boolean

请求是否成功

resultCode

int

请求结果码:

  • 200:请求成功

  • 202:系统异常

  • 203:无效参数

resultMsg

String

请求结果信息

pb_hasMore

BOOL

是否还有更多数据

promotes

NSArray

运营位信息

feeds

Array

Feed 列表

attachInfo

ByteString

分页的标记,业务方可忽略

newcount

int

新数据数量

extInfo

PBMapStringString

扩展信息

跳转视频详情页面

//转到视频列表页面,0 指视频首页 1 指个人页面
    public void jumpVideoActivity(Context context, FeedDataPB feedDataPB ,String isUserHomeActivityJump){
        LiveActivity.jump2LiveActivity(context, feedDataPB ,isUserHomeActivityJump);
    }

请求参数

参数

类型

描述

context

Context

上下文信息

FeedDataPB

feedDataPB

Feed 流列表内容数据

isUserHomeActivityJump

String

用户进入视频详情页的方式:

  • 0:从首页 Feed 流进入

  • 1:从个人页面点击 Feed 流进入

返回参数

无。

跳转图文详情页

 public void jumpDetailActivity(Context context, String feedId ,String publisherId){
     DetailActivity.jumpDetailActivity(context, feedId, publisherId);
 }

请求参数

参数

类型

描述

context

Context

上下文信息

feedId

String

Feed 流的唯一 ID

publisherId

String

作者 ID, 获取个人主页内容时必填。

返回参数

无。

阿里云首页 移动开发平台 mPaaS 相关技术圈