aiobearychat.openapi.channel_api
¶
讨论组相关 API.
auto generated by script at 2017-08-24 21:50:13.459796. don’t edit it.
-
class
aiobearychat.openapi.channel_api.
ChannelAPI
(requester: aiobearychat.abc.Requester, token: str, *, base_url: str, **kwargs)[源代码]¶ 讨论组相关 API.
-
archive
(channel_id: str, **requester_params: typing.Any) → aiobearychat.sansio.Response[源代码]¶ 归档一个讨论组。
官方文档地址:https://github.com/bearyinnovative/OpenAPI/blob/master/api/channel.archive.md
参数: channel_id ( str
) – 讨论组 id (示例:=bw52O
)返回: response. 一个 aiobearychat.sansio.Response
实例返回类型: aiobearychat.sansio.Response
response.body
返回值示例:response.status 等于 200 时: { "private": false, "general": true, "latest_ts": 1486367046281, "uid": "=bw52O", "name": "所有人", "is_member": false, "is_active": false, "type": "normal", "topic": null, "member_uids": [ "=bw52O" ], "vchannel_id": "=bw52O", "id": "=bw52O", "team_id": "=bw52O" }
-
create
(name: str, *, topic: str = NOTHING, private: bool = NOTHING, **requester_params: typing.Any) → aiobearychat.sansio.Response[源代码]¶ 创建一个讨论组.
官方文档地址:https://github.com/bearyinnovative/OpenAPI/blob/master/api/channel.create.md
param name: 讨论组名称,可以包含 2 到 20 个英文字符或 1 到 10 个中文字符。允许使用数字、下划线 (_
)、中线 (-
) 和点。 (示例:吃喝玩乐在深圳
) :type name:str
param topic: 讨论组话题 (示例: 今天吃什么?
)type topic: str
param private: 讨论组是否为私密? type private: bool
return: response. 一个 aiobearychat.sansio.Response
实例rtype: aiobearychat.sansio.Response
response.body
返回值示例:response.status 等于 201 时: { "private": false, "general": true, "latest_ts": 1486367046281, "uid": "=bw52O", "name": "所有人", "is_member": false, "is_active": true, "type": "normal", "topic": null, "member_uids": [ "=bw52O" ], "vchannel_id": "=bw52O", "id": "=bw52O", "team_id": "=bw52O" }
-
info
(channel_id: str, **requester_params: typing.Any) → aiobearychat.sansio.Response[源代码]¶ 返回指定讨论组的完整信息。
官方文档地址:https://github.com/bearyinnovative/OpenAPI/blob/master/api/channel.info.md
参数: channel_id ( str
) – 讨论组 id (示例:=bw52O
)返回: response. 一个 aiobearychat.sansio.Response
实例返回类型: aiobearychat.sansio.Response
response.body
返回值示例:response.status 等于 200 时: { "private": false, "general": true, "latest_ts": 1486367046281, "uid": "=bw52O", "name": "所有人", "is_member": false, "is_active": true, "type": "normal", "topic": null, "member_uids": [ "=bw52O" ], "vchannel_id": "=bw52O", "id": "=bw52O", "team_id": "=bw52O" }
-
invite
(channel_id: str, invite_uid: str, **requester_params: typing.Any) → aiobearychat.sansio.Response[源代码]¶ 当前用户邀请一个团队成员加入讨论组。
官方文档地址:https://github.com/bearyinnovative/OpenAPI/blob/master/api/channel.invite.md
参数: - channel_id (
str
) – 讨论组 id (示例:=bw52O
) - invite_uid (
str
) – 邀请用户 id (示例:=bw52O
)
返回: response. 一个
aiobearychat.sansio.Response
实例返回类型: response.body
返回值示例:response.status 等于 204 时:
- channel_id (
-
join
(channel_id: str, **requester_params: typing.Any) → aiobearychat.sansio.Response[源代码]¶ 当前用户加入指定讨论组。
官方文档地址:https://github.com/bearyinnovative/OpenAPI/blob/master/api/channel.join.md
参数: channel_id ( str
) – 讨论组 id (示例:=bw52O
)返回: response. 一个 aiobearychat.sansio.Response
实例返回类型: aiobearychat.sansio.Response
response.body
返回值示例:response.status 等于 200 时: { "private": false, "general": false, "latest_ts": 1486367046281, "uid": "=bw52O", "name": "吃喝玩乐在深圳", "is_member": false, "is_active": true, "type": "normal", "topic": null, "member_uids": [ "=bw52O" ], "vchannel_id": "=bw52O", "id": "=bw52O", "team_id": "=bw52O" }
-
kick
(channel_id: str, kick_uid: str, **requester_params: typing.Any) → aiobearychat.sansio.Response[源代码]¶ 当前用户移除一个讨论组成员。
官方文档地址:https://github.com/bearyinnovative/OpenAPI/blob/master/api/channel.kick.md
参数: - channel_id (
str
) – 讨论组 id (示例:=bw52O
) - kick_uid (
str
) – 移除用户 id (示例:=bw52O
)
返回: response. 一个
aiobearychat.sansio.Response
实例返回类型: response.body
返回值示例:response.status 等于 204 时:
- channel_id (
-
kickout
(channel_id: str, kick_uid: str, **requester_params: typing.Any) → aiobearychat.sansio.Response[源代码]¶ 当前用户移除一个讨论组成员。
官方文档地址:https://github.com/bearyinnovative/OpenAPI/blob/master/api/channel.kickout.md
参数: - channel_id (
str
) – 讨论组 id (示例:=bw52O
) - kick_uid (
str
) – 移除用户 id (示例:=bw52O
)
返回: response. 一个
aiobearychat.sansio.Response
实例返回类型: response.body
返回值示例:response.status 等于 204 时:
- channel_id (
-
leave
(channel_id: str, **requester_params: typing.Any) → aiobearychat.sansio.Response[源代码]¶ 当前用户离开讨论组。
官方文档地址:https://github.com/bearyinnovative/OpenAPI/blob/master/api/channel.leave.md
参数: channel_id ( str
) – 讨论组 id (示例:=bw52O
)返回: response. 一个 aiobearychat.sansio.Response
实例返回类型: aiobearychat.sansio.Response
response.body
返回值示例:response.status 等于 204 时:
-
list
(**requester_params: typing.Any) → aiobearychat.sansio.Response[源代码]¶ 返回团队内的讨论组列表,获取某个讨论组的完整信息,请使用
channel.info
.官方文档地址:https://github.com/bearyinnovative/OpenAPI/blob/master/api/channel.list.md
返回: response. 一个 aiobearychat.sansio.Response
实例返回类型: aiobearychat.sansio.Response
response.body
返回值示例:response.status 等于 200 时: [ { "private": false, "general": true, "latest_ts": 1486367046281, "uid": "=bw52O", "name": "所有人", "is_member": false, "is_active": true, "type": "normal", "topic": null, "member_uids": [ "=bw52O" ], "vchannel_id": "=bw52O", "id": "=bw52O", "team_id": "=bw52O" } ]
-
unarchive
(channel_id: str, **requester_params: typing.Any) → aiobearychat.sansio.Response[源代码]¶ 恢复一个已被归档的讨论组。
官方文档地址:https://github.com/bearyinnovative/OpenAPI/blob/master/api/channel.unarchive.md
参数: channel_id ( str
) – 讨论组 id (示例:=bw52O
)返回: response. 一个 aiobearychat.sansio.Response
实例返回类型: aiobearychat.sansio.Response
response.body
返回值示例:response.status 等于 200 时: { "private": false, "general": true, "latest_ts": 1486367046281, "uid": "=bw52O", "name": "所有人", "is_member": false, "is_active": true, "type": "normal", "topic": null, "member_uids": [ "=bw52O" ], "vchannel_id": "=bw52O", "id": "=bw52O", "team_id": "=bw52O" }
-