帮助与文档

> >

1、CMSSDK

方法名称 参数列表 返回值 使用说明
getCategories Callback callback 操作回调 获取新闻分类列表
成功后返回一个ArrayList,包含一组Category对象
getNews Category category 分类
ArticleType type 文章类型
String[] fields 希望返回的字段名称
int offset 返回数据在搜索结果中的偏移值
int size 返回数据的最大个数
Callback callback 操作回调
获取指定分类下的新闻列表
其中的type和fields是可选的:
type为null,表示接受所有类型的新闻;
fields为null,表示获取每个新闻对象的所有字段
成功后返回一个ArrayList,包含一组News对象
getNewsDetails String newsId 新闻ID
Callback callback 操作回调
获取指定ID下的新闻详情
成功后返回一个News对象
getComments News news 新闻
int offset 返回数据在搜索结果中的偏移值
int size 返回数据的最大个数
Callback callback 操作回调
获取指定新闻下的评论列表
成功后返回一个ArrayList,包含一组Comment对象
getRecommendNews String newsId 新闻ID
int offset 返回数据在搜索结果中的偏移值
int size 返回数据的最大个数
Callback callback 操作回调
获取与指定新闻相关的推荐新闻列表
成功后返回一个ArrayList,包含一组News对象
likeNewsFromUMSSDKUser News news 新闻
Callback callback 操作回调
以UMSSDK用户身份称赞一个新闻
likeNewsFromCustomUser News news 新闻
String uid 用户ID
String nickname 用户昵称
String avatarUrl 用户头像URL
Callback callback 操作回调
以应用自有用户系统成员身份称赞一个新闻
likeNewsFromAnonymousUser News news 新闻
Callback callback 操作回调
以“游客”身份称赞一个新闻
commentNewsFromUMSSDKUser News news 新闻
Comment comment 评论和评论者信息
Callback callback 操作回调
以UMSSDK用户身份评论一个新闻
commentNewsFromCustomUser News news 新闻
Comment comment 评论和评论者信息
Callback callback 操作回调
以应用自有用户系统成员身份评论一个新闻
commentNewsFromAnonymousUser News news 新闻
Comment comment 评论和评论者信息
Callback callback 操作回调
以“游客”身份评论一个新闻
hasUMSSDKUserLikedTheNews News news 新闻
Callback callback 操作回调
是否UMSSDK用户已经称赞了指定的新闻
hasCustomUserLikedTheNews News news 新闻
String uid 用户ID
Callback callback 操作回调
是否应用自有用户已经称赞了指定的新闻
hasAnonymousUserLikedTheNews News news 新闻
Callback callback 操作回调
是否匿名用户已经称赞了指定的新闻
getQuery QueryView view 能用于Query的View的枚举 Query 执行Query操作的对象 返回一个query工具来往服务器查询数据

请注意,在调用任何操作之前,需要初始化SDK:

所以,一般调用代码的方法如下:

2、Callback

Callback是CMSSDK所有异步操作的结果回调,包含下面3个方法:

方法名称 参数列表 使用说明
onSuccess Object data 具体操作的结果数据 成功回调
onFailed Throwable t 具体操作的异常堆栈 错误回调
onCancel 取消回调

3、Query API

CMSSDK不提供直接获取用户数据的办法,而是提供了一套通用的Query API。您可以通过这套工具向服务端查询想要的数据。其主要方法列述如下:

方法名称 参数列表 返回值 使用说明
condition Condition condition
查询条件,包括:
大于、小于、等于、不等于、大于等于、小于等于、集合、与、或和非
Query 设置查询的条件
fields String… fields
指定要查询的字段
Query 设置返回数据每一个元素包含的字段,缺省为全部返回
sort Sort… sorts
指定优先级的字段排序方式
Query 根据设置的字段,对返回数据进行排序
offset int offset
返回数据在搜索结果中的偏移值
Query 设置从搜索结果的何处开始返回数据,缺省为从第0条开始
size int size
返回数据的最大个数
Query 设置返回数据的总量,缺省为最多50条
query String 执行查询,为联网阻塞操作,返回一个json结果

一般执行一次查询的可能步骤如下:

CMSSDK当前提供了五个可供Query的View,分别为:

名称 说明
QueryView.CATEGORY 用于获取新闻分类列表
QueryView.NEWS 用于获取指定分类下的新闻列表
QueryView.COMMENT 用于获取指定新闻下的评论列表
QueryView.RECOMMEND 用于获取与指定新闻相关的推荐新闻列表
QueryView.LIKE 用于获取指定新闻下的称赞列表

此外,并不是所有的数据类型都可以用来执行检索,只有下面特定的类型才能使用:

类型 说明
Bool 布尔类型
Number 数值类型
Date 时间类型
Text 字符串类型

这些数据类型都位于“com.mob.jimu.query.data”包下。

4、各个数据结构的字段

CMSSDK包含3个核心的数据结构:Category、News和Comment,分别用于解析和存放新闻分组、新闻详情和评论的数据。其字段名称和含义如下:

Category

字段 类型 说明
id String 分组id。只提供get方法
name String 分组名称
order Integer 分组序号
articleNumber Integer 分组下所包含的新闻数量

News

字段 类型 说明
id String 新闻ID。只提供get方法
title String 新闻标题
type ArticleType 新闻类型。包括:普通、链接、视频、图片和广告
displayType ThumbDisplayType 在新闻列表中,缩略图的显示方式。包括:无图、左侧小图、右侧小图、下方3小图、下发1大图
displayImgs Image[] 在新闻列表中的缩略图
tags String[] 标签列表
categories String[] 所属的分类ID
imgList Image[] 图片类型新闻中的图片列表
imgSize Integer 图片类型新闻中所包含的图片数量
videoUrl String 视频类型新闻中视频的地址
videoDuration Integer 视频类型新闻中视频的时常(单位:秒)
vidoDesc String 视频类型新闻中视频的描述
content String 新闻内容
topNews Boolean 是否为置顶新闻
hotNews Boolean 是否为热门新闻
reads Integer 此新闻的阅读数
comments Integer 此新闻的评论数
likes Integer 此新闻的称赞数
openingComment Boolean 是否开放评论
updateAt Long 最后更新时间(单位:毫秒)

Comment

字段 类型 说明
id String 评论ID。只提供get方法
news String 所属新闻ID
uid String 评论所属用户ID
avatar String 评论所属用户头像URL
nickname String 评论所属用户昵称
updateAt Long 评论最后更新时间(单位:毫秒)
content String 评论的内容

Like

字段 类型 说明
news String 所属新闻ID
title String 新闻标题
platform Integer 执行称赞的设备系统类型:
安卓:1
iOS:2
uid String 执行称赞的用户ID
avatar String 执行称赞的用户头像URL
nickname String 执行称赞的用户昵称
updateAt Long 执行称赞的时间(单位:毫秒)

上述数据结构,除了字段id外,都可以通过get、和set两个方法来获取或者修改其在本地的值。

0 0

相关文档