帮助与文档

> >

一、集成、初始化和配置sdk

集成,初始化和配置sdk请参考快速集成

二、API调用

所有API调用均心APICallback接口回调的方式返回数据结果。

数据实体对象说明:

    • ForumForum 论坛版块
    • ForumThread 主题帖子
    • ForumPost 回帖
    • ForumThreadAttachment 主题帖子附件
    • User 用户信息
    • UserQuestion 用户登录安全问题
    • Banner 首页用到的banner
    • FavoriteReturn 收藏帖子返回
    • FavoriteThread 收藏的帖子
    • Follower 粉丝用户
    • Following 关注用户
    • Notification 消息
    • UserOperations 用户的操作

(更详细的字段说明请见下载的SDK中的BBSSDK for Android ApiDoc)

1) 论坛信息相关API

ForumAPI forumAPI = BBSSDK.getApi(ForumAPI.class);

其包含接口如下:

    • getForumList 获取所有版块或某版块子版块列表
    • getThreadListByForumId 获取某版块主题帖子列表
    • getThreadDetailsByThreadId 获取某主题帖子详情
    • getPostListByThreadId 获取某主题帖子回帖列表
    • createThread 创建主题帖子
    • createPost 创建回帖
    • uploadImage 上传图片(图片最大不能超过10M)

例如:
调用异步获取所有版块列表方式如下:

ForumAPI forumAPI = BBSSDK.getApi(ForumAPI.class);
forumAPI.getForumList(0, false, new APICallback<ArrayList<ForumForum>>() {
   public void onSuccess(API api, int action,
                    ArrayList<ForumForum> result) {
      //TODO 获取版块列表成功
   }
   public void onError(API api, int action, int errorCode, Throwable      details) {
      //TODO 获取失败
   }
});

2) 用户信息相关API

UserAPI userAPI = BBSSDK.getApi(UserAPI .class);

其包含接口如下:

    • register 注册
    • login 登录
    • forgotPwd 找回密码
    • sendAuthEmail 发送认证邮件
    • updateUserInfo 更新用户信息
    • getUserInfo 获取用户信息
    • logout 退出登录
    • getCurrentUser 获取当前缓存的用户信息
    • getUserOperations 获取关注、粉丝、文章收藏、个人帖子计数
    • resportAccusation 举报用户
    • recordLikePost 喜欢帖子
    • favoritePost 收藏帖子
    • unfavoritePost 取消收藏帖子
    • getPersonalPostList 获取个人发过的帖子列表
    • getFavoritePostList 获取个人收藏帖子列表
    • searchPosts 搜索接口
    • getNotificationList 获取消息列表
    • followUser 关注用户
    • unfollowUser 取消关注用户
    • getFollowingList 获取关注的用户列表
    • getFollowersList 获取关注我的用户列表
    • getBannerList 获取banner列表
    • setNotificationReaded 设置消息已读
    • delNotification 删除消息

例如:
异步调用注册接口方式如下:

UserAPI userAPI = BBSSDK.getApi(UserAPI.class);
userAPI.register("userName", "password", "email", false, new APICallback<User>() {
   public void onSuccess(API api, int action, ArrayList<User> result) {
      //TODO 注册成功
   }
   public void onError(API api, int action, int errorCode, Throwable details) {
      //TODO 注册失败
   }
});

三、API错误码

API返回的错误码说明如下:(详见ErrorCode.java说明)

    • 200 成功
    • 500 服务器异常
    • 1000 网络超时,或者数据处理异常
    • 1001 appkey未配置
    • 1002 论坛尚未初始化成功
    • 1003 请求服务器端接口失败
    • 1004 论坛插件端返回数据异常,请检查插件是否正确安装和启用
    • 1100 论坛返回的错误提示信息(如发帖回帖失败等相关原因)
    • 1101 上传图片失败
    • 1200 用户登录信息过期,请重新登录
    • 1201 用户名或密码不正确或用户状态异常
    • 1202 当前不允许注册
    • 1203 用户名或密码或邮箱格式不正确或邮箱已存在
    • 1204 用户名或邮箱已被占用
    • 1205 必须提交正确安全问题答案才能登陆
    • 1206 用户未激活,请前往邮箱验证
    • 1207 邮件发送失败,可申请重新发送邮箱认证
    • 1208 信息提交还需人工审核,请联系管理员
    • 1209 找回密码失败,提交的邮箱和用户的邮箱不匹配
    • 1210 登录失败,用户名或邮箱不能同时为空

相关文档