Android评论库SDK

优质

小牛编辑

133浏览

2023-12-01

概述

消息sdk是用来订阅消息的开发工具包，为开发者提供简单易用的接口，可以很方便地接收消息信息。

阅读对象

本文档面向所有使用该 SDK 的开发人员、测试人员以及对此感兴趣的用户,要求开发者对消息的基本功能有一定的解。

开发准备

设备和系统版本

android 4.0.3 及以上

开发步骤

首先需要在安卓应用程序中声明以下权限

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

然后引入开发包，将tv.mudu.commentlib.jar放入app/libs包，在build.gradle加入

implementation fileTree(include: ['*.jar'], dir: 'libs')

其次按照下面步骤使用sdk进行开发

DEMO示例

步骤说明

1.创建评论管理对象

//创建管理对象需要传入频道HashId(可通过频道详情接口actid字段获取)
commenter = new Commenter(String activityHashId);

2.设置登陆

//设置登录的评论者昵称和头像，此接口会创建一个匿名角色
commenter.login("评论者昵称", "https://www.xnip.cn/wp-content/uploads/2021/docimg28/49-bzqhbynm2gy.com", new Commenter.Callback() {
    @Override
    public void onSuccess(String s) {
        //s：OK
        //登录成功
    }

    @Override
    public void onError(Exception e) {
        //登录失败
    }
});

功能:用户登陆

3.进行订阅消息

        // 进行频道订阅，在发送评论之前必须先注册成功该订阅消息，否则消息将无法收取。
        commenter.subscribe(new Commenter.IConnectCallback() {

            @Override
            public void handle(int connectCode, String error) {

                if (connectCode == Commenter.ConnectCode_Success) {

                    showMsg("连接成功");
                } else if (connectCode == Commenter.ConnectCode_Error) {

                    showMsg(error);

                } else if (connectCode == Commenter.ConnectCode_Close) {
                    //可做重连操作，退出页面时无需重连
                    commenter.reconnect();
                }

            }
        }, new Commenter.IMessageCallback(){
            @Override
            public void handle(String msg, String type, String subject) {
                //获取消息
                showMsg("type:" + type + "  msg:" + msg);
            }
});

4.发送评论消息

// 发送频道消息
commenter.pubilsh(editText.getText().toString(), new Commenter.Callback(){

    @Override
    public void onSuccess(String result) {
        //result: {"id":xxxxx}
        showMsg("发送成功");
    }

    @Override
    public void onError(Exception e) {
        //e.
        showMsg("发送失败");
    }

});

5.取消订阅

// 取消订阅，离开页面时调用
commenter.unsubscribe();

接口说明

tv.mudu.commentlib.Commenter

类名:Commenter

构造

public Commenter(String activityId)

根据频道actId

login

public void login(String username, String avatarUrl, Commenter.Callback callback)

功能：登陆并设置头像(头像可选设置，不设置为默认头像)

public String subscribe(Commenter.IMessageCallback cb)

功能：开始订阅评论消息参数：传入收到消息后的处理

pubilsh

public void pubilsh(String message, Commenter.Callback callback)

功能：发布评论消息参数： 1.message 发布的评论 2.callback 发布结果回调

unsubscribe

public void unsubscribe()

功能：取消订阅备注：取消订阅不影响发布评论消息

close

public void close()

功能：销毁评论会话

isConnected

public boolean isConnected()

功能：判断评论管理对象是否连接到频道返回：连接状态

获取用户信息

public JSONObject getUserInfo()

功能：获取用户相关信息返回：用户信息JSON对象