一点资讯开放平台SDK-Android

阅读对象

本文档面向所有使用一点资讯开放平台SDK的开发、测试人员等, 要求读者具有一定的Android编程开发经验，点击查看详细wiki文档。

1.产品概述

一点资讯开放平台Android SDK是一点资讯Android开发团队推出的Android平台上的个性化信息流推荐开发集成包(SDK)，为Android开发者提供简单、快捷的接口，帮助开发者实现Android平台上的个性化信息流产品。

1.1 Demo

下载地址：点击下载

2.SDK 功能说明

• [1] 提供完整个性化推荐信息流解决方案
• [2] 一键接入多频道推荐列表
• [3] 一键接入自定义单频道频道页面
• [4] 支持列表中单插信息流推荐卡片
• [5] SDK初始化流程便捷，接入成本低
• [6] SDK体积轻，大小仅有1M+
• [7] 卡片样式丰富，有小图、大图、组图、视频、图集卡片
• [8] 正文页用户体验佳，侧滑返回、视频推荐、评论页应有尽有
• [9] 强大的后台管理
• [10] 主题换肤

3.SDK使用

3.1 Download

jcenter

• 1.先在工程目录下的build.gradle的repositories添加：

 buildscript {

    repositories {
        google()
        jcenter()
        maven { url "https://jitpack.io" }
        maven { url "https://dl.bintray.com/yidian-android/open_android_sdk/" }
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:3.0.0'
        classpath 'org.greenrobot:greendao-gradle-plugin:3.2.2' // 一定要添加，greendao使用
    }
}

备注：SDK使用到了greendao数据库框架，开发者需要在dependencies中进行配置

• 2.然后在app的build.gradle的denpendencies中添加：

dependencies {
    implementation ("com.android.support:support-fragment:${rootProject.ext.supportVersion}")
    implementation ("com.android.support:support-annotations:${rootProject.ext.supportVersion}")
    implementation ("com.android.support:recyclerview-v7:${rootProject.ext.supportVersion}")
    implementation "org.greenrobot:greendao:3.2.2"
    implementation 'com.yidian.android:feeds:+'

}

• 3.添加混淆

-keep class com.yidian.newssdk.** {
    *;
}

备注：开放平台SDK一直在更新迭代，为了稳定性及新特性，请开发者依赖最新版本，查看各个版本更新信息请点击版本更新记录

3.2 使用方法

com.yidian.newssdk.NewsFeedsSDK.java 这是SDK的配置入口类，目前对外提供了响应的配置方法，开发者可以通过配置

private String mAppKey; SDK初始化所需要的APP_KEY

private String mAppId; SDK初始化所需的APP_ID

private boolean debug; 是否开启DEBUG模式，开启Debug模式后会输出更多的log信息。

在自定义Application的onCreate中添加如下代码，初始化我们的SDK。由于您的应用可能不止一个进程，建议只在主进程初始化我们的SDK。 SDK初始化示例：

new NewsFeedsSDK.Builder()
        .setAppId(BuildConfig.APP_ID)
        .setAppKey(BuildConfig.APP_KEY)
        .setContext(getApplicationContext())
        .setDebugEnabled(BuildConfig.DEBUG)
        .build();
}

您需要在SDK初始化代码中传入APP_ID、APP_KEY。

4.接入场景

4.1 多频道多列表的形式

NewsPortalFragment

SDK目前支持接入方采用多TAB的形式接入，SDK已经对NewsPortalFragment进行封装，接入方只需将NewsPortalFragment放置在对应的container容器中即可，具体调用方式可以参考：com.yidian.geek.page.NewsPortalActivity，接入代码如下：

fragmentNavi = new NewsPortalFragment();
getSupportFragmentManager().beginTransaction()
                .replace(R.id.portal_container, fragmentNavi)
                .commitNowAllowingStateLoss();

4.2 自定义单频道、单列表的形式

NewsListFragment

NewsListFragment为单列表的Fragment，接入方式示例具体参考：com.yidian.geek.page. NewsListActivity NewsListFragment支持展示自定义的频道列表，接入方需要在构造NewsListFragment传入需要配置的频道名称及是ViewPager中接入，如：

fragment = NewsListFragment.newInstance("视频集锦", false);
getSupportFragmentManager().beginTransaction()
        .replace(R.id.portal_container, fragment)
        .commitNowAllowingStateLoss();

NewsListFragment.newInstance(String channelName, boolean inViewPager)参数含义：

注意事项：

在使用NewsListFragment单列表接入的情况下，如果是接入在ViewPager中的话，需要注意：

1、NewsListFragment.newInstance方法的第二个参数需要设置成true，否则会出现一些问题

2、如果接入方式是采用接入方自己的Fragment包装了NewsListFragment的话，需要在接入方的包装的Fragment的setUserVisibleHint方法中调用下NewsListFragment的setUserVisibleHint方法，不然和1一样会出现一些问题，如：

    @Override
    public void setUserVisibleHint(boolean isVisibleToUser) {
        super.setUserVisibleHint(isVisibleToUser);
        newlistFragment.setUserVisibleHint(isVisibleToUser);
    }

4.3 View的形式接入

NewsEmbedFragment

NewsEmbedFragment支持接入方将信息流插入在接入方的布局中，接入方可根据自己的实际场景需要使用该Fragment。 NewsEmbedFragment的构造需要传入频道名及信息流列表卡片的数量，如：

fragment = NewsEmbedFragment.newInstance("推荐", 1);
getSupportFragmentManager().beginTransaction()
        .replace(R.id.portal_container, fragment)
        .commitNowAllowingStateLoss();

具体使用方式请参考：com.yidian.geek.page.NewsViewActivity

4.4 SDK对外暴露方法

SDK提供对外暴露接口或方法的方式，辅助开发者实现一些功能.

4.4.1 外部刷新方法

开发者接入多频道列表或单频道列表过程中，可能需要通过点击底部Tab或者其他的方式进行信息流刷新操作，目前SDK对外暴露刷新方法来帮助开发者实现刷新操作。

4.4.2 滑动到顶部

开发者可调用此方法将列表滑动到顶部

4.4.3 判断当前列表是否在最顶部

4.4.4 多频道接入时，切换频道回调频道名信息

考虑到在使用NewsPortalFragment多频道接入方式时，接入方可能需要切换频道时的频道名信息，以便数据统计使用。SDK提供了接口调用来支持接入方完成此操作，接入代码如下：

   NewsFeedsSDK.getInstance().setReportInterface(new IReportInterface() {

            @Override
            public void onPageSelected(String channelPageName) {
                Toast.makeText(getApplicationContext(), channelPageName, Toast.LENGTH_SHORT).show();
            }
        });

5.其他

5.1 声明必要权限

客户端需要在AndroidManifest.xml文件中增加SDK所需要的访问网络等权限，代码示例：

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

6.反馈与建议

6.1 反馈模板

6.2 联系方式

• 主页：一点资讯开放平台 
• Issues：https://github.com/yidianzixun/YdNewsFeedsSDK_Android/issues