login logout share shareWithEdit
概述
Twitter 简介
witter(通称推特)是一家美国社交网络及微博客服务的网站,是全球互联网上访问量最大的十个网站之一。是微博客的典型应用。它可以让用户更新不超过140个字符的消息,这些消息也被称作“推文(Tweet)”。这个服务是由杰克·多西在2006年3月创办并在当年7月启动的。Twitter在全世界都非常流行, 据Twitter现任CEO迪克·科斯特洛宣布,截至2012年3月,Twitter共有1.4亿活跃用户,Twitter被形容为“互联网的短信服务”。
Twitter 模块概述
本模块封装了 Twitter 开放平台的原生 SDK,集成了登录、分享功能;可用于实现 Twitter 账号登录,分享内容到 Twitter 功能;轻松、高效集成 Twitter 功能到自己的 app 内。使自己的 app 和 Twitter实现无缝链接。
模块使用攻略
使用之前须从 Twitter 开放平台申请开发者账号并创建应用,获取 API key 和 API secret key。 详情参考 Twitter 文档
使用此模块之前建议先配置 config.xml 文件,配置完毕,需通过云端编译生效,配置方法如下:
- 名称:Twitter
- 参数:urlScheme、apiKey、apiSecret
- 配置示例:
<feature name="Twitter">
<param name="urlScheme" value="twitterkit-1YHTjb3ZXkETs3USSw49B**"/>
<param name="apiKey" value="p1YHTjb3ZXkETs3USSw49B***"/>
<param name="apiSecret" value="ER0ZX84u5sw4RtW5qqVPdjmntYNp11xywyslxEtaTmDRoHx***"/>
</feature>
字段描述:
urlScheme:(必须配置)用于实现应用间跳转及数据交换,本应用可以启动 Twitter 客户端,也可以从 Twitter 客户端跳回本应用。urlScheme 的 value 值是 Twitter Kit looks for a URL scheme in the format twitterkit-, where consumerKey is your application’s Twitter API key, e.g. twitterkit-dwlf79lnqfsj。
apiKey:(必须配置)从 Twitter 开放平台获取的 API key
apiSecret:从 Twitter 开放平台获取的 API secret key
Android 系统平台上需注意事项
注意:iOS端最低支持 iOS 9.0
模块接口
login
登录授权
login(callback(ret, err))
callback(ret, err)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, //布尔型;是否登录成功;true||false
userName: '' //字符串类型;The username associated with the access token.
authTokenSecret:'', //字符串类型;The authorization token secret.
userID:'', //字符串类型;The user ID associated with the access token.
authToken:'' //字符串类型; The authorization token.
}
err:
- 类型:JSON 对象
- 内部字段:
{
msg:‘’ //字符串类型;错误信息
}
示例代码
var Twitter = api.require('Twitter');
Twitter.login(function(ret, err) {
if (ret.status) {
alert(JSON.stringify(ret));
} else {
alert(err.msg);
}
});
可用性
iOS 系统,Android 系统
可提供的 1.0.0 及更高版本
logout
登出
logout()
示例代码
var Twitter = api.require('Twitter');
Twitter.logout();
可用性
iOS 系统,Android 系统
可提供的 1.0.0 及更高版本
share
分享图文内容,android可分享视频
share({params}, callback(ret, err))
params
title:
- 类型:字符串
- 描述:(可选项)分享的文本,标题
image:
- 类型:字符串
- 描述:(可选项)分享的图片,要求本地路径(widget://、fs://)
url:
- 类型:字符串
- 描述:(可选项)分享的 url
callback(ret, err)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true //布尔型;是否分享成功;true||false
}
err:
- 类型:JSON 对象
- 内部字段:
{
msg:‘’ //字符串类型;错误信息
}
示例代码
var Twitter = api.require('Twitter');
Twitter.share({
title: '',
image: 'widget://res/1.png',
url: 'https://www.apicloud.com'
}, function(ret, err) {
if (ret.status) {
alert('分享成功');
} else {
alert(err.msg);
}
});
可用性
iOS 系统,Android 系统
可提供的 1.0.0 及更高版本
shareWithEdit
分享图文,可轻量编辑(仅android支持)
shareWithEdit({params}, callback(ret, err))
params
title:
- 类型:字符串
- 描述:(可选项)分享的文本,标题
image:
- 类型:字符串
- 描述:(可选项)分享的图片,要求本地路径(widget://、fs://)
hashtags:
- 类型:字符串
- 描述:(可选项)预填充的hashtags
darkTheme:
- 类型:布尔类型
- 描述:(可选项)是否使用黑色主题
callback(ret, err)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true //布尔型;是否分享成功;true||false
}
err:
- 类型:JSON 对象
- 内部字段:
{
msg:'' //字符串类型;错误信息
}
示例代码
var Twitter = api.require('Twitter');
Twitter.shareWithEdit({
title: '',
image: 'widget://res/1.png',
}, function(ret, err) {
if (ret.status) {
alert('分享成功');
} else {
alert(err.msg);
}
});
可用性
Android 系统
可提供的 1.0.0 及更高版本