《2022年Android平台微博SDK说明文档 .pdf》由会员分享,可在线阅读,更多相关《2022年Android平台微博SDK说明文档 .pdf(18页珍藏版)》请在taowenge.com淘文阁网|工程机械CAD图纸|机械工程制图|CAD装配图下载|SolidWorks_CaTia_CAD_UG_PROE_设计图分享下载上搜索。
1、北京新潮讯捷信息技术有限公司微博 Android平台 SDK 文档北京新潮讯捷信息技术有限公司编号: WEIBO_ANDROID_SDK 版本: WEIBO_ANDROID_SDK V2.0.0 修订记录时间文档版本修订人备注2012/7/20 2.0.0 罗棚初稿2012/8/02 2.0.0 张晓伟名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 1 页,共 18 页 - - - - - - - - - 北京新潮讯捷信息技术有限公司目录微博 Android平台 SDK 文档 . 1
2、概述 . 3主要类说明: . 3主要接口说明 . 31.获取 Weibo对象 . 32.获取 Oauth2AccessToken对象 . 53.分享到微博 . 54.SSO 支持 . 6实例分析 . 61.通过 Oauth2.0授权获得 AccessToken . 72.发送微博 . 8SSO介绍 . 101.SSO 功能使用方式. 10 2.SSO 授权功能介绍. 10 3.SSO 授权优势 . 10 4.SSO 授权流程示例. 10 SDK 使用说明 . 121.使用 weibo.sdk.android(不包含sso 功能) . 12 2.使用 weibo.sdk.android.sso.
3、 15 3.SDK 使用及修改必须遵守微博开发者协议,以及开源软件协议。 . 18 名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 2 页,共 18 页 - - - - - - - - - 北京新潮讯捷信息技术有限公司概述微博 Android平台 SDK 为第三方微博应用提供了文档易用的微博API 调用服务,使第三方客户端无需了解复杂的验证,API 调用过程。 并可以实现分享到微博的功能,可以分享文字,或者多媒体信息到内置的分享页面,并发送到微博。主要类说明:1.Weibo: 微博
4、API 接口类,对外提供weiboapi 的调用,包括登录,API调用,微博分享等功能。2.Oauth2AccessToken:封装了“ access_token” , “expires_in” ,refresh_token ,并提供了他们的管理功能3.Utility :工具类,提供了url 的 encode,decode 方法。4.AsyncWeiboRunner:微博 api 异步执行类, 封装了回调接口, 通过创建线程来调用Weibo中的接口方法。5.HttpManager: 负责与服务器进行通讯的类,封装了GET、POST请求方式,并对外提供图片上传等功能6.WeiboAPI: 该类及
5、其子类封装了新浪微博对外提供的api 接口方法。7.WeiboException :微博异常封装类,封装了微博的各个异常。8.SsoHandler:单点登录认证类,对外提供了sso登录认证的方法。主要接口说明1.获取 Weibo对象获取 weibo对象接口名称com.weibo.sdk.android.Weibo.getInstance(String appKey, String redirectUrl)参数名称作用appKey第三方应用的appkey (在新浪微博开放平台上创建应用时自动分配),redirectUrl第三方应用的回调页返回结果Weibo实例对象名师资料总结 - - -精品资料
6、欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 3 页,共 18 页 - - - - - - - - - 北京新潮讯捷信息技术有限公司名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 4 页,共 18 页 - - - - - - - - - 北京新潮讯捷信息技术有限公司授权认证2.获取 Oauth2AccessToken对象获取Oauth2AccessToken对象接口名称com.weibo.sdk.and
7、roid. Oauth2AccessToken (String accessToken, String expires_in)参数名称作用accessToken通过认证后从服务器获取到的访问令牌expires_in认证有效期返回结果Oauth2AccessToken实例对象3.分享到微博StatusesAPI 构造函数接口名称com.weibo.sdk.android.api.StatusesAPI(Oauth2AccessToken accesssToken)参数名称作用accesssTokenOauth2AccessToken 对象分享文字到微博接口名称com.weibo.sdk.andr
8、oid.api.StatusesAPI.update(String content, String lat, String lon, RequestListener listener)参数名称作用content 要分享的微博内容,限140 个字Lat 、lon经纬度,格式为:ddd.ddddd 【度 . 度】格式listener用于异步返回服务器的返回结果分享文字和图片到微博接口名称com.weibo.sdk.android.api.StatusesAPI.upload(String content, String file, String lat, String lon, RequestLi
9、stener listener)参数名称作用content 要分享的微博内容,限140 个字file 要上传的照片本地所在路径授权认证接口名称com.weibo.sdk.android.Weibo.authorize(Context context, WeiboAuthListenerlistener)参数名称作用context当前 activity对象,用于获取当前网络状态,弹出对话框等。listener授权对话框回调接口。处理授权完成、授权失败、授权取消等事件名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 -
10、- - - - - - 第 5 页,共 18 页 - - - - - - - - - 北京新潮讯捷信息技术有限公司Lat 、lon经纬度,格式为:ddd.ddddd 【度 . 度】格式listener用于异步返回服务器的返回结果4.SSO 支持SSOHandler 构造函数接口名称void SSOHandler (Activity activity,Weibo weibo)参数名称作用activity 发起认证的 Activity weibo weibo对象SSO 回调接口名称void authorizeCallBack(int requestCode, int resultCode, Int
11、ent data)使用说明在Authorize Activity里 覆 写onActivityResult(int requestCode, int resultCode, Intent data),在方法中使用SSOHandler对象调用authorizeCallBack(int requestCode, intresultCode, Intent data)SSO 认证接口名称void authorize (WeiboAuthListenerlistener weiboAuthListener)使用说明发起 sso 认证时调用此方法参数名称作用weiboAuthListener用于异步返回
12、服务器的返回结果实例分析以下代码的具体信息请参考weibo.sdk.android.sso.demo 工程。 svn 地址为:http:/ android-weibo- 名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 6 页,共 18 页 - - - - - - - - - 北京新潮讯捷信息技术有限公司1.通过 Oauth2.0授权获得 AccessToken 第一步 In MainActivity :通过 Weibo 的构造函数设置应用回调页和appkey。对于 Mobile 客户
13、端应用来说,是不存在Server 的,故此处的应用回调页地址只要与新浪微博开放平台-我的应用 -应用信息 -高级应用 -授权设置 -应用回调页中的url 地址保持一致就可以了,如图所示:第二步 In MainActivity :实现 WeiboDialogListener 接口。授权成功后可在onComplete 函数中获得accesstoken 信息。具体如何保存、使用accesstoken 信息由开发者自行处理。名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 7 页,共 18 页
14、 - - - - - - - - - 北京新潮讯捷信息技术有限公司第三步In MainActivity :调用 authorize 方法,弹出授权对话框,进行授权。授权成功后即可获得accestoken。2.发送微博通过已经获取的Oauth2AccessToken ,构建 StatuesAPI 对象,然后调用发送接口update,示例如下:名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 8 页,共 18 页 - - - - - - - - - 北京新潮讯捷信息技术有限公司也可以发送一
15、片带有图片的微博,示例如下:名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 9 页,共 18 页 - - - - - - - - - 北京新潮讯捷信息技术有限公司SSO介绍1.SSO 功能使用方式使用 SSO功能需要覆写onActivityResult() 方法,并调用authorizeCallBack()方法2.SSO 授权功能介绍接入新浪微博的第三方Android 、iOS 应用可通过新浪微博官方客户端快速完成OAuth2.0 授权。3.SSO 授权优势不需要重复输入新浪微博用户
16、名、密码,只需要一步操作,直接点击授权按钮即可完成授权,增强了操作简便性及帐号安全性。目前仅3.0.0 及以上客户端版本支持SSO。4.SSO 授权流程示例第一步:选择使用SSO功能第二步:选择用于授权的微博账号第三步:使用微博账号进行授权,同意授权即可使用微博功能如果想更换微博账号,需要先解除绑定后重复上诉操作。下图为掌中新浪android 版使用 SSO示意图名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 10 页,共 18 页 - - - - - - - - - 北京新潮讯捷信
17、息技术有限公司图表1名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 11 页,共 18 页 - - - - - - - - - 北京新潮讯捷信息技术有限公司SDK 使用说明1.使用 weibo.sdk.android(不包含 sso 功能)1.1 将 SDK 的工程项目导入到eclipse中。在 eclipse 中选择 File-Import-General-Existing Projects into Workspace 。注意:SDK工程的编码格式为UTF-8。如图所示:图表21
18、.2 在需要集成本SDK 的工程项目中添加Library 。右键- Properties - Android 。设置 Library 属性,如图所示:名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 12 页,共 18 页 - - - - - - - - - 北京新潮讯捷信息技术有限公司图表3 1.3 Manifest文件中必须包含以下permission: 1.4如 果 想 在 自 建 工 程 里 直 接 使 用sdk提 供 的jar包 , 可 以 在eclipse的File-Exp
19、ort-Java-JAR file里打出 jar 文件,假设名称为oauth20.jar ,如下图所示:注意: jar 包模式和 library 模式不能混用,而且这种方式导出来的jar 包与 library 模式下自动生成的jar 包是不同的,后者无法将assets目录打进jar 文件名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 13 页,共 18 页 - - - - - - - - - 北京新潮讯捷信息技术有限公司图表4最后生成的jar 的内部结构如下图所示:图表5名师资料总结
20、 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 14 页,共 18 页 - - - - - - - - - 北京新潮讯捷信息技术有限公司2.使用 weibo.sdk.android.api Weibo.sdk.android.api 是在 weibo.sdk.android 的基础上扩展而来,里面提供了一些对新浪微博 openapi 的封装接口,供用户使用。2.1 因为api sdk 是在weibo.sdk.android的基础上开发的,所以使用api sdk之前,需要先导入weibo.sdk.
21、android sdk,步骤详见上节介绍。2.2 按照上节的步骤,导入api sdk,同样需要将此sdk 设置为 library 2.3 在 Eclipse中,进入新建工程的Properties-Android 中,按照下图所示添加library ,2.4如 果 想 在 自 建 工 程 里 直 接 使 用sdk提 供 的jar包 , 可 以 在eclipse的File-Export-Java-JAR file里打出 jar 文件,假设名称为oauth20-api.jar ,步骤同1.4 。名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - -
22、- - 名师精心整理 - - - - - - - 第 15 页,共 18 页 - - - - - - - - - 北京新潮讯捷信息技术有限公司3.使用 weibo.sdk.android.sso 3.1 因为sso sdk 是在weibo.sdk.android的基础上开发的,所以使用ssosdk之前,需要先导入weibo.sdk.android sdk(如果要使用已经封装好的api 接口 ,也可以导入weibo.sdk.android.api) ,步骤详见上节介绍。3.2 按照上节的步骤,导入sso sdk,同样需要将此sdk 设置为 library 3.3 在 Eclipse中,进入新建工
23、程的Properties-Android 中,按照下图所示添加library ,图表6 添 加 完 成 后 , 查 看 工 程 的build path , 保 证 如 下 图 所 示 , 工 程 里 已 经 分 别 引 入 了weibo.sdk.android.sso.jar 和 weibo.sdk.android.jar :名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 16 页,共 18 页 - - - - - - - - - 北京新潮讯捷信息技术有限公司图表7 3.4 如果想在
24、自建工程里直接使用sdk 提供的 jar 包,也可以按照下面的步骤来生成最终需要的 jar 文件,注意: jar 包模式和library 模式不能混用net.sf.fjep.fatjar_0.0.31.jar1)安装 fat jar:a 将上面的 jar 包放入 eclipse-plugins 目录,并重启eclipse b 在工程中点击右键,出现下面的选项Build Fat jar,说明此插件安装成功c 如果没有出现,将$eclipse_Homeconfigurationorg.eclipse.updateplatform.xml 删除,然后再重启eclipse,执行 b 步骤检查是否安装成
25、功d 如 果 还 未 不 成 功 , 可 以 在 线 安 装 此 插 件 , 插 件 的 地 址 是 :http:/kurucz-grafika.de/fatjar,执行 b 步骤检查是否安装成功e 一般经过上面几个步骤,都可以正常安装fatjar ,如果还未成功,那只好使用最后一招了,换个其他版本eclipse 吧,笔者使用3.7.2 ,没有任何问题图表8 2)点击 Build fat jar ,按照向导一步步操作,在添加资源时,应保证将上节(1.4 节)生成的 oauth20.jar 勾选进来,如下图所示, 最终生成一个jar, 此 jar 文件内将包含oauth20.jar中的所有内容,
26、文件内部结构如图表 5(如果想使用weibo.sdk.android.api 提供的接口,在生成 jar 文件时,也需要将2.4 节中生成的oauth20-api.jar 勾选进来 ) 名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 17 页,共 18 页 - - - - - - - - - 北京新潮讯捷信息技术有限公司图表9 将最终生的jar 文件作为lib 添加入自建工程中, 并且在图标4所示界面中将引入的library 删除。完成之后就可以正常使用了。4.SDK 使用及修改必须遵守微博开发者协议,以及开源软件协议。名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 18 页,共 18 页 - - - - - - - - -