API Reference¶
Fan¶
-
class
van.
Fan
(cfg=None, **kwargs)¶ 模拟
-
blocked_users_id
¶ 获取用户黑名单id列表
返回类型: (bool, [str])
-
follow
(user)¶ 关注用户
参数: user (User|str) -- 被关注的用户, User对象,或id,或 loginname
-
is_blocked
(user)¶ 检查是否屏蔽用户
参数: user (str|User) -- 用户User对象或者id,loginname 返回类型: (bool, str)
-
mentions
= None¶ 返回提到当前用户的20条消息
-
public_timeline
= None¶ 返回公共时间线
-
replies
= None¶ 返回当前用户收到的回复
-
unblock
(user)¶ 解除屏蔽
参数: user (str|User) -- 被屏蔽的用户User对象或者id,loginname 返回类型: (bool, str)
-
unfollow
(user)¶ 取消关注用户
参数: user (User|str) -- 被关注的用户, User对象,或id,或 loginname
-
update_status
(text, photo=None, in_reply_to_user_id=None, in_reply_to_status_id=None, repost_status_id=None)¶ 发表新状态,
Status.send()
的快捷方式。参数: - text (str) -- 文字
- photo (str) -- 照片路径或者URL
- in_reply_to_user_id (str) -- 要回复的用户ID
- in_reply_to_status_id (str) -- 要回复的消息ID
- repost_status_id (str) -- 要转发的消息ID
-
User¶
-
class
van.
User
(id=None, data=None, **kwargs)¶ -
favorites
¶ 浏览此用户收藏的消息
-
followers
¶ 返回此用户的关注者(前100个) 此用户为当前用户的关注对象或未设置隐私
-
followers_id
¶ 返回此用户关注者的id列表
-
friends
¶ 返回此用户的关注对象(前100个) 此用户为当前用户的关注对象或未设置隐私
-
friends_id
¶ 返回此用户关注对象的id列表
-
relationship
(other)¶ 返回此用户与 other 的关系: 是否屏蔽,是否关注,是否被关注
参数: other (str|User) -- 其他用户 返回类型: (a_blocked_b, a_following_b, a_followed_b)
-
Status¶
Timeline¶
-
class
van.
Timeline
(user, endpoint)¶ -
__call__
(since_id=None, max_id=None, count=60)¶ 调用内部 _fetch 方法获取数据。 可以自己控制 since_id, max_id 和 count 参数,获取的结果不加入内部缓存。
参数: - since_id -- 开始的消息ID
- max_id -- 结束的消息ID
- count -- 获取数量,最大为60
返回: Status
数组返回类型: [Status]
-
__iter__
()¶ 从当前游标位置开始获取消息,可以像普通数组一样在循环中使用。 :return:
Status
-
rewind
()¶ 获取最新的状态插入到时间线的头部,并将指针置为0(指向最新的状态)
返回类型: int
-
seek
(offset=None, whence=0)¶ 移动游标的位置
参数: - offset (int) -- 偏移量
- whence (int) --
相对位置
- 0 -- 相对于时间线开始位置,偏移量必须 >= 0
- 1 -- 相对于当前游标位置,偏移量可正可负,超出范围的偏移量会被纠正为边界值
- 2 -- 相对于时间线结尾,偏移量 <=0
警告
此函数只能在有限范围检查索引范围,请小心使用
返回: 移动后的游标位置 返回类型: int
-
tell
()¶ 返回当前游标的位置
返回类型: int
-