Android JShare API

SDK 初始化 API

API - init

初始化接口，建议在项目的 Application 的 OnCreate 中使用。

• SDK 1.5.0 之前的版本支持

  接口定义

  public static void init(Context context)

  参数说明

• context 应用的 ApplicationContext

API - init

初始化接口，建议在项目的 Application 的 OnCreate 中使用，这个初始化API支持代码中设置第三方平台信息。

• SDK 1.5.0 及以后版本支持

  接口定义

  public static void init(Context context, PlatformConfig platformConfig)

  参数说明

• context 应用的 ApplicationContext
• platformConfig 第三方平台信息配置，详情见第三方平台信息设置API

第三方平台信息设置 API

JShare 提供PlatformConfig类，实例化后可选择设置相应的第三方平台信息。

API - setWechat

设置微信平台信息。

接口定义

public PlatformConfig setWechat(String appId, String appSecret)

参数说明

• appId 微信平台appId
• appSecret 微信平台appSecret

API - setQQ

设置QQ平台信息。

接口定义

public PlatformConfig setQQ(String appId, String appKey)

参数说明

• appId QQ平台appId
• appKey QQ平台appKey

API - setSinaWeibo

设置新浪微博平台信息。

接口定义

public PlatformConfig setSinaWeibo(String appKey, String appSecret, String redirectUrl)

参数说明

• appKey 新浪微博平台appKey
• appSecret 新浪微博平台appSecret
• redirectUrl 新浪微博平台的回调url

API - setFacebook

设置Facebook平台信息。

接口定义

public PlatformConfig setFacebook(String appId, String appName)

参数说明

• appId Facebook平台appId
• appName Facebook平台appName

API - setTwitter

设置Twitter平台信息。

接口定义

public PlatformConfig setTwitter(String consumerKey, String consumerSecret)

参数说明

• consumerKey Twitter平台consumerKey
• consumerSecret Twitter平台consumerSecret

API - setJchatPro

设置 JChatpro 平台信息。

接口定义

public PlatformConfig setJchatPro(String auth)

参数说明

• auth JchatPro平台auth

获取已经正确配置的平台 API

API - getPlatformList

获取 SDK 所有能用的平台名称，如要使用某个平台，必须正确配置相应的jar以及第三方平台信息。

接口定义

public static List<String> getPlatformList()

设置调试模式 API

API - setDebugMode

设置调试模式。
注：该接口需在 init 接口之前调用，避免出现部分日志没打印的情况。多进程情况下建议在自定义的 Application 中 onCreate 中调用。

接口定义

public static void setDebugMode(boolean enable)

参数说明

• enable 为 true 则会打印 debug 级别的日志，false 则只会打印 warning 级别以上的日志

判断某平台分享是否有效 API

API - isClientValid

判断该平台的分享是否有效。

接口定义

public static boolean isClientValid(String name)

参数说明

• name 平台名称，值可选 Wechat.Name、WechatMoments.Name、WechatFavorite.Name、SinaWeibo.Name、SinaWeiboMessage.Name、QQ.Name、QZone.Name、Facebook.Name、FbMessenger.Name、Twitter.Name、JChatPro.Name。

分享 API

API - share

分享接口

接口定义

public static void share(String name, ShareParams shareParams, PlatActionListener shareActionListener))

参数说明

• name 平台名称，值可选 Wechat.Name、WechatMoments.Name、WechatFavorite.Name、SinaWeibo.Name、SinaWeiboMessage.Name、QQ.Name、QZone.Name、Facebook.Name、FbMessenger.Name、Twitter.Name、JChatPro.Name。
• shareParams 分享的配置参数，具体设置请参考各个平台的分享参数说明。
• shareActionListener 回调接口，可为 null，为 null 时则没有回调

判断某平台是否支持授权 API

API - isSupportAuthorize

判断某平台是否支持授权

• SDK 1.2.0 以上版本支持

  接口定义

  public static boolean isSupportAuthorize(String name)

  参数说明

• name 平台名称，值可选 Wechat.Name、WechatMoments.Name、WechatFavorite.Name、SinaWeibo.Name、SinaWeiboMessage.Name、QQ.Name、QZone.Name、Facebook.Name、FbMessenger.Name、Twitter.Name。

授权 API

API - authorize

授权接口

• SDK 1.2.0 以上版本支持

  接口定义

  public static void authorize(String name, AuthListener authListener)

  参数说明

• name 平台名称，值可选 Wechat.Name、SinaWeibo.Name、QQ.Name、Facebook.Name、Twitter.Name、JChatPro.Name。

• authListener 回调接口，可为 null，为 null 时则没有回调。

  代码示例

  JShareInterface.authorize(platform, new AuthListener() {
    @Override
    public void onComplete(Platform platform, int action, BaseResponseInfo data) {
        Logger.dd(TAG, "onComplete:" + platform + ",action:" + action + ",data:" + data);
        String toastMsg = null;
        switch (action) {
            case Platform.ACTION_AUTHORIZING:
                if (data instanceof AccessTokenInfo) {        //授权信息
                    String token = ((AccessTokenInfo) data).getToken();//token
                    long expiration = ((AccessTokenInfo) data).getExpiresIn();//token有效时间，时间戳
                    String refresh_token = ((AccessTokenInfo) data).getRefeshToken();//refresh_token
                    String openid = ((AccessTokenInfo) data).getOpenid();//openid
                    //授权原始数据，开发者可自行处理
                    String originData = data.getOriginData();
                    toastMsg = "授权成功:" + data.toString();
                    Logger.dd(TAG, "openid:" + openid + ",token:" + token + ",expiration:" + expiration + ",refresh_token:" + refresh_token);
                    Logger.dd(TAG, "originData:" + originData);
                }
                break;
        }
    }
    @Override
    public void onError(Platform platform, int action, int errorCode, Throwable error) {
        String toastMsg = null;
        switch (action) {
            case Platform.ACTION_AUTHORIZING:
                toastMsg = "授权失败";
                break;
        }
    }
    @Override
    public void onCancel(Platform platform, int action) {
        Logger.dd(TAG, "onCancel:" + platform + ",action:" + action);
        String toastMsg = null;
        switch (action) {
            case Platform.ACTION_AUTHORIZING:
                toastMsg = "取消授权";
                break;
        }
    }
  });

判断是否已经授权 API

API - isAuthorize

判断是否已经授权接口

• SDK 1.2.0以上版本支持

  接口定义

  public static boolean isAuthorize(String name)

  参数说明

• name 平台名称，值可选 Wechat.Name、WechatMoments.Name、WechatFavorite.Name、SinaWeibo.Name、SinaWeiboMessage.Name、QQ.Name、QZone.Name、Facebook.Name、FbMessenger.Name、Twitter.Name。

删除授权 API

API - removeAuthorize

删除授权接口

• SDK 1.2.0 以上版本支持

  接口定义

  public static void removeAuthorize(String name, AuthListener actionListener)

  参数说明

• name 平台名称，值可选 Wechat.Name、WechatMoments.Name、WechatFavorite.Name、SinaWeibo.Name、SinaWeiboMessage.Name、QQ.Name、QZone.Name、Facebook.Name、FbMessenger.Name、Twitter.Name。

• authListener 回调接口，可为 null，为 null 时则没有回调

  代码示例

  JShareInterface.removeAuthorize(platform, new AuthListener() {
    @Override
    public void onComplete(Platform platform, int action, BaseResponseInfo data) {
       Logger.dd(TAG, "onComplete:" + platform + ",action:" + action + ",data:" + data);
       String toastMsg = null;
       switch (action) {
           case Platform.ACTION_REMOVE_AUTHORIZING:
               toastMsg = "删除授权成功";
               break;
       } 
    }
    @Override
    public void onError(Platform platform, int action, int errorCode, Throwable error) {
        Logger.dd(TAG, "onError:" + platform + ",action:" + action + ",error:" + error);
        String toastMsg = null;
        switch (action) {
            case Platform.ACTION_REMOVE_AUTHORIZING:
                toastMsg = "删除授权失败";
                break;
        }
    }
    @Override
    public void onCancel(Platform platform, int i) {
    }
  });

获取个人信息 API

API - getUserInfo

获取个人信息接口

• SDK 1.2.0 以上版本支持

  接口定义

  public static void getUserInfo(String platName, AuthListener authListener)

  参数说明

• name 平台名称，值可选 Wechat.Name、WechatMoments.Name、WechatFavorite.Name、SinaWeibo.Name、SinaWeiboMessage.Name、QQ.Name、QZone.Name、Facebook.Name、FbMessenger.Name、Twitter.Name。

• authListener 回调接口，可为 null，为 null 时则没有回调

  代码示例

  JShareInterface.getUserInfo(platform, new AuthListener() {
    @Override
    public void onComplete(Platform platform, int action, BaseResponseInfo data) {
        Logger.dd(TAG, "onComplete:" + platform + ",action:" + action + ",data:" + data);
        String toastMsg = null;
        switch (action) {
            case Platform.ACTION_USER_INFO:
                if (data instanceof UserInfo) {      //第三方个人信息
                    String openid = ((UserInfo) data).getOpenid();  //openid
                    String name = ((UserInfo) data).getName();  //昵称
                    String imageUrl = ((UserInfo) data).getImageUrl();  //头像url
                    int gender = ((UserInfo) data).getGender();//性别, 1表示男性；2表示女性
                    //个人信息原始数据，开发者可自行处理
                    String originData = data.getOriginData();
                    toastMsg = "获取个人信息成功:" + data.toString();
                    Logger.dd(TAG, "openid:" + openid + ",name:" + name + ",gender:" + gender + ",imageUrl:" + imageUrl);
                    Logger.dd(TAG, "originData:" + originData);
                }
                break;
        }
    }
    @Override
    public void onError(Platform platform, int action, int errorCode, Throwable error) {
        Logger.dd(TAG, "onError:" + platform + ",action:" + action + ",error:" + error);
        String toastMsg = null;
        switch (action) {
            case Platform.ACTION_USER_INFO:
                toastMsg = "获取个人信息失败";
                break;
        }
    }
    @Override
    public void onCancel(Platform platform, int action) {
        Logger.dd(TAG, "onCancel:" + platform + ",action:" + action);
        String toastMsg = null;
        switch (action) {
            case Platform.ACTION_USER_INFO:
                toastMsg = "取消获取个人信息";
                break;
        }
    }
  });

各个平台的分享参数说明

微信(包括微信朋友圈、微信收藏)

1）分享文本

ShareParams shareParams = new ShareParams();
shareParams.setShareType(Platform.SHARE_TEXT);
shareParams.setText("Text");//必须

2）分享图片

ShareParams shareParams = new ShareParams();
shareParams.setShareType(Platform.SHARE_IMAGE);
shareParams.setImagePath(file.getAbsolutePath());
//shareParams.setImageData(bitmap);

3）分享音乐

ShareParams shareParams = new ShareParams();
shareParams.setTitle(share_title);
shareParams.setText(share_text);
shareParams.setShareType(Platform.SHARE_MUSIC);
shareParams.setUrl(url);
shareParams.setMusicUrl(music_url);
shareParams.setImagePath(file.getAbsolutePath());

4）分享视频

ShareParams shareParams = new ShareParams();
shareParams.setTitle(share_title);
shareParams.setText(share_text);
shareParams.setShareType(Platform.SHARE_VIDEO);
shareParams.setUrl(share_videourl);
shareParams.setImagePath(file.getAbsolutePath());

5）分享网页

ShareParams shareParams = new ShareParams();
shareParams.setTitle(share_title);
shareParams.setText(share_text);
shareParams.setShareType(Platform.SHARE_WEBPAGE);
shareParams.setUrl(share_url);//必须
shareParams.setImagePath(file.getAbsolutePath());

6）分享 Emoji 表情（朋友圈、微信收藏不支持）

ShareParams shareParams = new ShareParams();
shareParams.setShareType(Platform.SHARE_EMOJI);
shareParams.setImagePath(file.getAbsolutePath());

7）分享文件（朋友圈、微信收藏不支持）

ShareParams shareParams = new ShareParams();
shareParams.setShareType(Platform.SHARE_FILE);
shareParams.setFilePath(file.getAbsolutePath());

8）分享小程序（朋友圈、微信收藏不支持）

ShareParams shareParams = new ShareParams();
shareParams.setShareType(Platform.SHARE_MINI_PROGRAM);
shareParams.setTitle(share_title);
shareParams.setText(share_text);
shareParams.setUrl(share_url);//用于微信低版本兼容，当微信客户端为低版本时，小程序分享变网页分享
shareParams.setImagePath(file.getAbsolutePath());
shareParams.setMiniProgramWithShareTicket(false);//
shareParams.setMiniProgramType(0);// 正式版:0，开发版（测试版）:1，体验版（预览版）:2
shareParams.setMiniProgramImagePath(file.getAbsolutePath());//小程序图片地址
shareParams.setMiniProgramPath("pages/index/index");//小程序页面路径
shareParams.setMiniProgramUserName("gh_cd370c00d3d4");//小程序原始id

QQ

1）分享图片

ShareParams shareParams = new ShareParams();
shareParams.setShareType(Platform.SHARE_IMAGE);
shareParams.setImagePath(file.getAbsolutePath());

2）分享链接

ShareParams shareParams = new ShareParams();
shareParams.setShareType(Platform.SHARE_WEBPAGE);
shareParams.setTitle(share_title);
shareParams.setText(share_text);
shareParams.setUrl(share_url);
shareParams.setImagePath(file.getAbsolutePath());

3）分享app

ShareParams shareParams = new ShareParams();
shareParams.setShareType(Platform.SHARE_APPS);
shareParams.setTitle(share_title);
shareParams.setText(share_text);
shareParams.setImagePath(file.getAbsolutePath());

4）分享音乐

ShareParams shareParams = new ShareParams();
shareParams.setShareType(Platform.SHARE_MUSIC);
shareParams.setTitle(share_title);
shareParams.setText(share_text);
shareParams.setUrl(share_url);
shareParams.setMusicUrl(music_url);
shareParams.setImagePath(file.getAbsolutePath());
//shareParams.setImageUrl("http://inews.gtimg.com/newsapp_bt/0/876781763/1000");

QQ空间

1)分享文本

ShareParams shareParams = new ShareParams();
shareParams.setShareType(Platform.SHARE_TEXT);
shareParams.setText(share_text);

2)分享图片

ShareParams shareParams = new ShareParams();
shareParams.setShareType(Platform.SHARE_IMAGE);
shareParams.setImagePath(MyApplication.ImagePath);
//shareParams.setImageUrl(share_imageurl);
//String[] array = new String[]{ share_imageurl, share_imageurl_1};
//shareParams.setImageArray(array);

3)分享链接

ShareParams shareParams = new ShareParams();
shareParams.setShareType(Platform.SHARE_WEBPAGE);
shareParams.setTitle(share_title);
shareParams.setUrl(share_url);
shareParams.setImagePath(file.getAbsolutePath());
//shareParams.setImageUrl("http://inews.gtimg.com/newsapp_bt/0/876781763/1000");

4)分享音乐

ShareParams shareParams = new ShareParams();
shareParams.setShareType(Platform.SHARE_MUSIC);
shareParams.setTitle(share_title);
shareParams.setMusicUrl(share_musicurl);
shareParams.setUrl(music_shareUrl);
shareParams.setImagePath(file.getAbsolutePath());
//shareParams.setImageUrl("http://inews.gtimg.com/newsapp_bt/0/876781763/1000");

5)分享本地视频

ShareParams shareParams = new ShareParams();
shareParams.setShareType(Platform.SHARE_VIDEO);
shareParams.setVideoPath(MyApplication.VideoPath);

新浪微博

1)分享文本

ShareParams shareParams = new ShareParams();
shareParams.setShareType(Platform.SHARE_IMAGE);
shareParams.setText(share_text);
shareParams.setImagePath(file.getAbsolutePath());

2)分享图片

ShareParams shareParams = new ShareParams();
shareParams.setShareType(Platform.SHARE_IMAGE);
shareParams.setText(share_text);
shareParams.setImagePath(file.getAbsolutePath());

3)分享链接

ShareParams shareParams = new ShareParams();
shareParams.setShareType(Platform.SHARE_WEBPAGE);
shareParams.setText(share_text);
shareParams.setImagePath(file.getAbsolutePath());
shareParams.setUrl(share_url);

新浪微博私信

1)分享链接

ShareParams shareParams = new ShareParams();
shareParams.setShareType(Platform.SHARE_WEBPAGE);
shareParams.setText(share_text);
shareParams.setImagePath(file.getAbsolutePath());
shareParams.setUrl(share_url);

Facebook、FbMessenger

1)分享链接

ShareParams shareParams = new ShareParams();
shareParams.setShareType(Platform.SHARE_WEBPAGE);
shareParams.setUrl(share_url);
shareParams.setQuote(quote);

2)分享图片

ShareParams shareParams = new ShareParams();
shareParams.setShareType(Platform.SHARE_IMAGE);
shareParams.setImagePath(file.getAbsolutePath());

2)分享视频

ShareParams shareParams = new ShareParams();
shareParams.setShareType(Platform.SHARE_VIDEO);
shareParams.setVideoPath(file.getAbsolutePath());

Twitter

1)分享文本

ShareParams shareParams = new ShareParams();
shareParams.setShareType(Platform.SHARE_TEXT);
shareParams.setText(text);

2)分享链接

ShareParams shareParams = new ShareParams();
shareParams.setShareType(Platform.SHARE_WEBPAGE);
shareParams.setUrl(share_url);

3)分享图片

ShareParams shareParams = new ShareParams();
shareParams.setShareType(Platform.SHARE_IMAGE);
shareParams.setImagePath(file.getAbsolutePath());

4)分享视频

ShareParams shareParams = new ShareParams();
shareParams.setShareType(Platform.SHARE_VIDEO);
shareParams.setVideoPath(videoPath);

JChatPro

1)分享图文

ShareParams shareParams = new ShareParams();
shareParams.setShareType(Platform.SHARE_IMAGETEXT);
shareParams.setAppName("JShareDemo");
shareParams.setTitle(share_title);
shareParams.setText(share_text);
shareParams.setUrl(share_url);
shareParams.setTargetPkg("com.tencent.mm");
shareParams.setTargetClass("com.tencent.mm.ui.LauncherUI");
shareParams.setExtra("this message from jshare.");

2)分享文本

ShareParams shareParams = new ShareParams();
shareParams.setShareType(Platform.SHARE_TEXT);
shareParams.setAppName("JShareDemo");
shareParams.setText(share_text);
shareParams.setUrl(share_url);
shareParams.setTargetPkg("com.tencent.mm");
shareParams.setTargetClass("com.tencent.mm.ui.LauncherUI");
shareParams.setExtra("this message from jshare.");

3)分享图片

ShareParams shareParams = new ShareParams();
shareParams.setShareType(Platform.SHARE_IMAGE);
shareParams.setAppName("JShareDemo");
//shareParams.setImageUrl(image_url);
//shareParams.setImagePath(image_path);
//shareParams.setImageArray(image_array);
shareParams.setUrl(share_url);
shareParams.setTargetPkg("com.tencent.mm");
shareParams.setTargetClass("com.tencent.mm.ui.LauncherUI");
shareParams.setExtra("this message from jshare.");