Docs For Class SaeTClient

Class SaeTClient

Description

新浪微博操作类

使用前需要先手工调用saet.ex.class.php
Demo程序：http://apidoc.sinaapp.com/demo/saetdemo.zip
Demo使用说明：

下载,然后解压,修改config.php中的key
打开index.php,将13行最后一个url改成你网站对应的callback.php的url
上传到SAE平台即可

author: Easy Chen
version: 1.0

Located in /saet.ex.class.php (line 934)

Method Summary

void __construct (mixed $akey, mixed $skey, mixed $accecss_token, mixed $accecss_token_secret)

array add_to_favorites (mixed $sid)

array comments_by_me ([int $page = 1], [int $count = 20])

array comments_timeline ([int $page = 1], [int $count = 20])

array comment_destroy (int $cid)

array delete (mixed $sid)

array delete_dm (mixed $did)

array destroy (mixed $sid)

array end_session ()

array follow (mixed $uid_or_name)

array followers ([int $cursor = false], [int $count = false], [mixed $uid_or_name = null])

array followers_ids ([int $cursor = false], [int $count = false], [mixed $uid_or_name = null])

array friends ([int $cursor = false], [int $count = false], [mixed $uid_or_name = null])

array friends_ids ([int $cursor = false], [int $count = false], [mixed $uid_or_name = null])

array friends_timeline ()

array get_comments_by_sid (mixed $sid, [int $page = 1], [int $count = 20])

array get_count_info_by_ids (mixed $sids)

array get_favorites ([int $page = false])

array home_timeline ()

array is_followed (mixed $target, [mixed $source = NULL])

array list_dm ([int $page = 1], [int $count = 20])

array list_dm_sent ([int $page = 1], [int $count = 20])

array mentions ([int $page = 1], [int $count = 20])

array provinces ()

array public_timeline ()

array rate_limit_status ()

array register ( $nick, string $gender, string $password, string $email, string $ip, [string $province = NULL], [string $city = NULL], string $nick.)

array remove_from_favorites (mixed $sid)

array reply (mixed $sid, mixed $text, mixed $cid)

array repost (mixed $sid, [string $text = false])

array send_comment (mixed $sid, mixed $text, [int $cid = false])

array send_dm (mixed $uid_or_name, mixed $text)

array show_status (mixed $sid)

array show_user (mixed $uid_or_name)

array unfollow (mixed $uid_or_name)

array unread ()

array update (mixed $text)

array update_profile (array $profile)

array update_profile_image (string $image_path)

array upload (string $text, string $pic_path)

array user_timeline ([int $page = 1], [int $count = 20], [mixed $uid_or_name = null])

array verify_credentials ()

Methods

Constructor __construct (line 946)

构造函数

access: public

void __construct (mixed $akey, mixed $skey, mixed $accecss_token, mixed $accecss_token_secret)

mixed $akey: 微博开放平台应用APP KEY
mixed $skey: 微博开放平台应用APP SECRET
mixed $accecss_token: OAuth认证返回的token
mixed $accecss_token_secret: OAuth认证返回的token secret

add_to_favorites (line 1418)

收藏一条微博信息

access: public

array add_to_favorites (mixed $sid)

mixed $sid: 收藏的微博id

comments_by_me (line 1308)

获取当前用户发出的评论

access: public

array comments_by_me ([int $page = 1], [int $count = 20])

int $page: 页码
int $count: 每次返回的最大记录数，最多返回200条，默认20。

comments_timeline (line 1321)

最新评论(按时间)

access: public

array comments_timeline ([int $page = 1], [int $count = 20])

int $page: 页码
int $count: 每次返回的最大记录数，最多返回200条，默认20。

comment_destroy (line 1295)

删除当前用户的微博评论信息。注意：只能删除自己发布的评论，发部微博的用户不可以删除其他人的评论。

access: public

array comment_destroy (int $cid)

int $cid: 要删除的评论id

delete (line 1058)

删除一条微博删除微博。注意：只能删除自己发布的信息。

access: public

array delete (mixed $sid)

mixed $sid: 要删除的微博ID

delete_dm (line 1243)

删除一条私信按ID删除私信。操作用户必须为私信的接收人。

access: public

array delete_dm (mixed $did)

mixed $did: 要删除的私信主键ID

destroy (line 1071)

删除一条微博删除微博。注意：只能删除自己发布的信息。

access: public

array destroy (mixed $sid)

mixed $sid: 要删除的微博ID

end_session (line 1469)

当前用户退出登录清除已验证用户的session，退出登录，并将cookie设为null。主要用于widget等web应用场合。

access: public

array end_session ()

follow (line 1127)

关注一个用户成功则返回关注人的资料，目前的最多关注2000人，失败则返回error_code 400和一条字符串的说明。如果已经关注了此人，则返回error_code 403.

access: public

array follow (mixed $uid_or_name)

mixed $uid_or_name: 要关注的用户UID或微博昵称

followers (line 1114)

粉丝列表返回用户的粉丝列表，并返回粉丝的最新微博。按粉丝的关注时间倒序返回，每次返回100个。注意目前接口最多只返回5000个粉丝。

access: public

array followers ([int $cursor = false], [int $count = false], [mixed $uid_or_name = null])

int $cursor: 单页只能包含100个粉丝列表，为了获取更多则cursor默认从-1开始，通过增加或减少cursor来获取更多的粉丝列表
int $count: 每次返回的最大记录数（即页面大小），不大于200,默认返回20。
mixed $uid_or_name: 要获取的 UID或微博昵称

followers_ids (line 1572)

返回用户粉丝uid列表如果没有提供cursor参数，将只返回最前面的5000个粉丝id

access: public

array followers_ids ([int $cursor = false], [int $count = false], [mixed $uid_or_name = null])

int $cursor: 单页只能包含5000个id，为了获取更多则cursor默认从-1开始，通过增加或减少cursor来获取更多的粉丝列表
int $count: 每次返回的最大记录数（即页面大小），不大于5000,默认返回500。
mixed $uid_or_name: 要获取的 UID或微博昵称

friends (line 1099)

获取当前用户关注对象列表及最新一条微博信息返回用户关注对象列表，并返回最新微博文章。按关注人的关注时间倒序返回。可以通过ID,nickname,user_id参数来获取其他人的关注人列表。

access: public

array friends ([int $cursor = false], [int $count = false], [mixed $uid_or_name = null])

int $cursor: 单页只能包含100个关注列表，为了获取更多则cursor默认从-1开始，通过增加或减少cursor来获取更多的关注列表
int $count: 每次返回的最大记录数（即页面大小），不大于200,默认返回20
mixed $uid_or_name: 要获取的 UID或微博昵称

friends_ids (line 1557)

返回用户关注对象uid列表如果没有提供cursor参数，将只返回最前面的5000个关注id

access: public

array friends_ids ([int $cursor = false], [int $count = false], [mixed $uid_or_name = null])

int $cursor: 单页只能包含5000个id，为了获取更多则cursor默认从-1开始，通过增加或减少cursor来获取更多的关注列表
int $count: 每次返回的最大记录数（即页面大小），不大于5000,默认返回500。
mixed $uid_or_name: 要获取的 UID或微博昵称

friends_timeline (line 970)

获取当前用户所关注用户的最新微博信息返回用户所有关注用户最新n条微博信息。和用户“我的首页”返回内容相同。

access: public

array friends_timeline ()

get_comments_by_sid (line 1335)

单条微博的评论列表

access: public

array get_comments_by_sid (mixed $sid, [int $page = 1], [int $count = 20])

mixed $sid: 指定的微博ID
int $page: 页码
int $count: 每次返回的最大记录数，最多返回200条，默认20。

get_count_info_by_ids (line 1354)

批量获取一组微博的评论数及转发数批量统计微博的评论数，转发数，一次请求最多获取100个。

access: public

array get_count_info_by_ids (mixed $sids)

mixed $sids: 微博ID号列表，用逗号隔开

get_favorites (line 1403)

获取当前用户的收藏列表返回用户的发布的最近20条收藏信息，和用户收藏页面返回内容是一致的。

access: public

array get_favorites ([int $page = false])

int $page: 返回结果的页序号。

home_timeline (line 982)

获取当前用户所关注用户的最新微博信息返回用户所有关注用户最新n条微博信息。和用户“我的首页”返回内容相同。

access: public

array home_timeline ()

is_followed (line 1155)

返回两个用户关系的详细情况如果用户已登录，此接口将自动使用当前用户ID作为source_id。但是可强制指定source_id来查询关系如果源用户或目的用户不存在，将返回http的400错误

access: public

array is_followed (mixed $target, [mixed $source = NULL])

mixed $target: 要判断的用户UID或要判断的目的微博昵称
mixed $source: 源用户UID或源微博昵称，可选

list_dm (line 1196)

获取当前用户最新私信列表返回用户的最新n条私信，并包含发送者和接受者的详细资料。

access: public

array list_dm ([int $page = 1], [int $count = 20])

int $page: 页码
int $count: 每次返回的最大记录数，最多返回200条，默认20。

list_dm_sent (line 1210)

获取当前用户发送的最新私信列表返回登录用户已发送最新20条私信。包括发送者和接受者的详细资料。

access: public

array list_dm_sent ([int $page = 1], [int $count = 20])

int $page: 页码
int $count: 每次返回的最大记录数，最多返回200条，默认20。

mentions (line 995)

获取@当前用户的微博列表

access: public

array mentions ([int $page = 1], [int $count = 20])

int $page: 返回结果的页序号。
int $count: 每次返回的最大记录数（即页面大小），不大于200，默认为20。

provinces (line 1542)

省份城市编码表获取省份及城市编码ID与文字对应。由于微博接口用户province, city字段设置及返回都是ID，API调用方需要显示时转换成对应文字。转换关系如下

access: public

array provinces ()

public_timeline (line 958)

获取最新更新的公共微博消息返回最新更新的20条微博消息。为避免资源浪费及提高效率，对消息缓存60秒。

access: public

array public_timeline ()

rate_limit_status (line 1457)

获取当前用户API访问频率限制关于API的访问频率限制。返回当前小时还能访问的次数。频率限制是根据用户请求来做的限制，具体可以参加频率限制说明。

access: public

array rate_limit_status ()

注册新浪微博帐号注册新浪微博用户接口，该接口为受限接口（只对受邀请的合作伙伴开放）。

access: public

array register ( $nick, string $gender, string $password, string $email, string $ip, [string $province = NULL], [string $city = NULL], string $nick.)

string $nick.: 昵称, 必须参数.不超过20个汉字.
string $gender: 性别, 必须参数. m,男，f,女.
string $password: 密码, 必须参数.
string $email: 注册邮箱, 必须参数.
string $ip: 注册用户用户当前真实的IP.必须参数.
string $province: 可选参数. 参考省份城市编码表
string $city: 可选参数. 参考省份城市编码表,1000为不限
$nick

remove_from_favorites (line 1433)

删除微博收藏。

access: public

array remove_from_favorites (mixed $sid)

mixed $sid: 要删除的收藏微博信息ID.

reply (line 1384)

对一条微博评论信息进行回复。为防止重复，发布的信息与最后一条评论/回复信息一样话，将会被忽略。

access: public

array reply (mixed $sid, mixed $text, mixed $cid)

mixed $sid: 微博id
mixed $text: 评论内容。
mixed $cid: 评论id

repost (line 1257)

转发一条微博信息。可加评论。为防止重复，发布的信息与最新信息一样话，将会被忽略。

access: public

array repost (mixed $sid, [string $text = false])

mixed $sid: 转发的微博ID
string $text: 添加的评论信息。

send_comment (line 1276)

对一条微博信息进行评论为防止重复，发布的信息与最后一条评论信息一样话，将会被忽略。

access: public

array send_comment (mixed $sid, mixed $text, [int $cid = false])

mixed $sid: 要评论的微博id
mixed $text: 评论内容
int $cid: 要评论的评论id

send_dm (line 1224)

发送私信发送一条私信。成功将返回完整的发送消息。

access: public

array send_dm (mixed $uid_or_name, mixed $text)

mixed $uid_or_name: UID或微博昵称
mixed $text: 要发生的消息内容，文本大小必须小于300个汉字。

show_status (line 1045)

根据ID获取单条微博信息内容获取单条ID的微博信息，作者信息将同时返回。

access: public

array show_status (mixed $sid)

mixed $sid: 要获取已发表的微博ID

show_user (line 1084)

根据用户ID获取用户资料按用户UID或昵称返回用户资料，同时也将返回用户的最新发布的微博。

access: public

array show_user (mixed $uid_or_name)

mixed $uid_or_name: 用户UID或微博昵称。

unfollow (line 1140)

取消关注某用户取消关注某用户。成功则返回被取消关注人的资料，失败则返回一条字符串的说明。

access: public

array unfollow (mixed $uid_or_name)

mixed $uid_or_name: 要取消关注的用户UID或微博昵称

unread (line 1369)

获取当前用户未读消息数获取当前用户Web未读消息数，包括@我的, 新评论，新私信，新粉丝数。

access: public

array unread ()

update (line 1009)

发表微博发布一条微博信息。为防止重复，发布的信息与当前最新信息一样话，将会被忽略。

access: public

array update (mixed $text)

mixed $text: 要更新的微博信息。

update_profile (line 1502)

更改用户资料

access: public

array update_profile (array $profile)

array $profile
: 要修改的资料。格式：array('key1'=>'value1', 'key2'=>'value2', .....)。
支持修改的项：
- name 昵称，可选参数.不超过20个汉字
- gender 性别，可选参数. m,男，f,女。
- province 所在省. 可选参数. 参考省份城市编码表
- city 所在城市. 可选参数. 参考省份城市编码表,1000为不限
- description 一句话介绍. 可选参数. 不超过160个汉字.

update_profile_image (line 1481)

更改头像

access: public

array update_profile_image (string $image_path)

string $image_path: 要发布的图片路径,支持url。[只支持png/jpg/gif三种格式,增加格式请修改get_image_mime方法]

upload (line 1027)

发表图片微博上传图片及发布微博信息。为防止重复，发布的信息与当前最新信息一样话，将会被忽略。目前上传图片大小限制为<1M。

access: public

array upload (string $text, string $pic_path)

string $text: 要更新的微博信息。
string $pic_path: 要发布的图片路径,支持url。[只支持png/jpg/gif三种格式,增加格式请修改get_image_mime方法]

user_timeline (line 1179)

获取用户发布的微博信息列表返回用户的发布的最近n条信息，和用户微博页面返回内容是一致的。此接口也可以请求其他用户的最新发表微博。

access: public

array user_timeline ([int $page = 1], [int $count = 20], [mixed $uid_or_name = null])

int $page: 页码
int $count: 每次返回的最大记录数，最多返回200条，默认20。
mixed $uid_or_name: 指定用户UID或微博昵称

verify_credentials (line 1445)

验证当前用户身份是否合法如果用户新浪通行证身份验证成功且用户已经开通微博则返回 http状态为 200；如果是不则返回401的状态和错误信息。此方法用了判断用户身份是否合法且已经开通微博。

access: public

array verify_credentials ()

Documentation generated on Wed, 11 Aug 2010 17:35:18 +0800 by phpDocumentor 1.4.3