API Reference¶
Fan¶
-
class
van.
Fan
(consumer_key, consumer_secret, oauth_token=None, mobile=False)¶ API操作入口
引导用户访问的授权页面URL 当 oauth_callback = 'oob' 时表示使用 PIN码授权
当前会话是否已授权
-
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)
-
me
¶ 获取授权用户的信息
-
oauth
(pin_code=None, redirect_url=None)¶ 通过授权后的PIN码或者浏览器重定向的URL获取最终的token
-
request
(method, endpoint, params=None, data=None, files=None, **kwargs)¶ 发出请求
-
session
¶ 获取session
-
unblock
(user)¶ 解除屏蔽
参数: user (str|User) -- 被屏蔽的用户User对象或者id,loginname 返回类型: (bool, str)
-
unfollow
(user)¶ 取消关注用户
参数: user (User|str) -- 被关注的用户, User对象,或id,或 loginname
-
update_status
(status, photo=None, in_reply_to_user_id=None, in_reply_to_status_id=None, repost_status_id=None, location=None, source=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
- location (str) -- 位置信息,使用'地点名称' 或 '一个半角逗号分隔的经纬度坐标'
- source (str) -- source 消息来源
User¶
-
class
van.
User
(fan, **kwargs)¶ 用户类
-
favorites
¶ 浏览此用户收藏的消息
-
followers
¶ 返回此用户的关注者 此用户为当前用户的关注对象或未设置隐私
参数: count (int) -- 每次获取的数量
-
followers_id
¶ 返回此用户关注者的id列表
参数: count (int) -- 每次获取的数量
-
friends
¶ 返回此用户的关注对象 此用户为当前用户的关注对象或未设置隐私
-
friends_id
¶ 返回此用户关注对象的id列表
-
relationship
(other)¶ 返回此用户与 other 的关系: 是否屏蔽,是否关注,是否被关注
参数: other (str|User) -- 其他用户 返回类型: (a_blocked_b, a_following_b, a_followed_b)
-
Status¶
-
class
van.
Status
(fan, **kwargs)¶ 消息类
-
context
¶ 按照时间先后顺序显示消息上下文
-
delete
()¶ 删除此消息(当前用户发出的消息)
-
favorite
()¶ 收藏此消息
-
reply
(response, photo=None, location=None, format='@{poster} {response}', **kwargs)¶ 回复这条消息
-
repost
(repost, photo=None, location=None, format='{repost}{repost_style_left}@{name} {origin}{repost_style_right}', **kwargs)¶ 转发这条消息
-
unfavorite
()¶ 取消收藏此消息
-
Timeline¶
-
class
van.
Timeline
(fan, user_id, endpoint)¶ 时间线管理类
-
fetch
(since_id=None, max_id=None, count=60)¶ 调用 API 获取数据。 可以自己控制 since_id, max_id 和 count 参数,获取的结果不加入内部缓存。
参数: - since_id -- 开始的消息ID
- max_id -- 结束的消息ID
- count -- 获取数量,最大为60
返回: Status
数组返回类型: [Status]
-
read
(count=10)¶ 从当前游标位置处往后读取 count 条消息, 数组长度可能小于要求的大小。
参数: count (int) -- 读取数量 返回: Status
数组返回类型: [Status]
-
rewind
()¶ 获取最新的状态插入到时间线的头部,并将指针置为0(指向最新的状态)
返回类型: int
-
seek
(offset=None, whence=0)¶ 移动游标的位置
参数: - offset (int) -- 偏移量
- whence (int) --
相对位置
- 0 -- 相对于时间线开始位置,偏移量必须 >= 0
- 1 -- 相对于当前游标位置,偏移量可正可负,超出范围的偏移量会被纠正为边界值
- 2 -- 相对于时间线结尾,偏移量 <=0
注意
此函数只能在有限范围满足索引要求,超出范围太多的偏移量会被自动纠正为合法值。
返回: 移动后的游标位置 返回类型: int
-
tell
()¶ 返回当前游标的位置
返回类型: int
-
Stream¶
-
class
van.
Stream
(fan)¶ Streamming API, 实时监测用户动作
-
install_listener
(listener)¶ 添加新的监听器 :param Listener listener: Listener 对象
-
on
(event, ttl=None)¶ 作为装饰器使用,添加新的监听器
参数: event -- 监听的事件, 多个事件请用 | 连接。如 Event.MESSAGE | Event.FREIENDS :param int priority:监听器的优先级,数字越小优先级越高 :param int ttl: 此监听器执行的次数,None 表示不限次数
-
run
()¶ 开始监听事件
-
stop
()¶ 停止监听事件
-
Event¶
-
class
van.
Event
(fan, type, data=None)¶ 事件对象,模拟一个事件发生时相关的数据
每个事件都有一个类型,当前可用的类型有:
- MESSAGE_CREATE: 当前用户发布一条状态。source为当前用户,如果消息中@其他人,则target为被提及用户,object为发布的状态
- MESSAGE_DELETE: 当前用户删除一条状态
- MESSAGE: 与 MESSAGE 相关的所有类型的事件,即 MESSAGE_CREATE 与 MESSAGE_DELETE 的合事件。
- FRIENDS_CREATE:当前用户关注其他用户。source为当前用户,target为被关注的对象
- FRIENDS_DELETE: 当前用户取消关注其他用户
- FRIENDS_REQUEST: 当前用户对其他用户发起关注请求
- FRIENDS:FRIENDS 相关的所有类型的事件
- FAV_CREATE:当前用户收藏一条状态。 source 为发起收藏操作的用户,target为状态被收藏的用户,object为被收藏的状态
- FAV_DELETE:当前用户取消收藏一条状态
- FAV:FAV 相关的所有事件
- DM_CREATE: 用户收到一条私信
- USER_UPDATE_PROFILE:当前用户更新个人资料
- ALL:所有事件
Listener¶
监听器对象
Misc¶
-
van.
Photo
= <class 'van.Photo'>¶ https://www.mtyun.com/doc/api/mss/mss/tu-pian-chu-li-fu-wu-api#图片处理服务状态码