帮助与文档

> >

一、集成、初始化和配置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)

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

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 删除消息

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

三、API错误码

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

    • 80001 上传图片失败
    • 90000 网络连接超时
    • 90001 客户端网络请求或返回时出错
    • 111 用户登录信息过期,请重新登录(token验证失败)
    • 200 成功
    • 201 查询无返回
    • 302 请求报文解析失败
    • 303 APPKEY未配置
    • 304 请求错误,缺少必要字段
    • 305 用户名和email不能同时为空
    • 306 论坛尚未初始化成功
    • 403 参数错误
    • 405 论坛返回的错误提示信息
    • 406 论坛服务出错,返回异常
    • 408 Json解析异常
    • 499 论坛服务无返回或网络超时
    • 500 服务器内部出错,请联系管理员
    • 601 用户名或密码不正确或用户状态异常
    • 602 当前不允许注册
    • 603用户名或密码不正确或不合规或邮箱格式不对或邮箱已存在
    • 604 用户名或邮箱已被占用
    • 605 必须提交正确安全问题答案才能登陆
    • 606 用户未激活,请前往邮箱验证
    • 607 邮件发送失败,可申请重新发送邮箱认证
    • 608 信息提交还需人工审核,请联系管理员
    • 609 当前无权发帖
    • 610 当前无权回帖
    • 611 找回密码失败,提交的邮箱和用户的邮箱不匹配
    • 612 无权查看
    • 800 服务器异常
    • 801 论坛插件返回异常
0 0