aiobearychat.openapi.session_channel_api
¶
临时讨论组相关 API.
auto generated by script at 2017-08-24 21:50:13.459796. don’t edit it.
-
class
aiobearychat.openapi.session_channel_api.
SessionChannelAPI
(requester: aiobearychat.abc.Requester, token: str, *, base_url: str, **kwargs)[源代码]¶ 临时讨论组相关 API.
-
archive
(session_channel_id: str, **requester_params: typing.Any) → aiobearychat.sansio.Response[源代码]¶ 归档一个临时讨论组。
官方文档地址:https://github.com/bearyinnovative/OpenAPI/blob/master/api/session_channel.archive.md
参数: session_channel_id ( str
) – 临时讨论组 id (示例:=bw52O
)返回: response. 一个 aiobearychat.sansio.Response
实例返回类型: aiobearychat.sansio.Response
response.body
返回值示例:response.status 等于 200 时: { "latest_ts": "1489242467694", "name": "临时讨论组名称", "is_member": true, "is_active": false, "type": "session", "member_uids": [ "=bw52O" ], "vchannel_id": "=bw52O", "id": "=bw52O", "team_id": "=bw52O" }
-
convert_to_channel
(session_channel_id: str, name: str, *, private: bool = True, **requester_params: typing.Any) → aiobearychat.sansio.Response[源代码]¶ 将临时讨论组转换为讨论组。
官方文档地址:https://github.com/bearyinnovative/OpenAPI/blob/master/api/session_channel.convert_to_channel.md
param session_channel_id: 临时讨论组 id (示例: =bw52O
)type session_channel_id: str
param name: 讨论组名称,可以包含 2 到 20 个英文字符或 1 到 10 个中文字符。允许使用数字、下划线 (_
)、中线 (-
) 和点。 (示例:吃喝玩乐在深圳
) :type name:str
param private: 讨论组是否为私密?默认值: True
type private: bool
return: response. 一个 aiobearychat.sansio.Response
实例rtype: aiobearychat.sansio.Response
response.body
返回值示例:response.status 等于 201 时: { "latest_ts": "1489242467694", "name": "临时讨论组名称", "is_member": true, "is_active": false, "type": "session", "member_uids": [ "=bw52O" ], "vchannel_id": "=bw52O", "id": "=bw52O", "team_id": "=bw52O" }
-
create
(member_uids: <function SessionChannelAPI.list at 0x7f9e15f759d8>, *, name: str = NOTHING, **requester_params: typing.Any) → aiobearychat.sansio.Response[源代码]¶ 创建一个临时讨论组。
官方文档地址:https://github.com/bearyinnovative/OpenAPI/blob/master/api/session_channel.create.md
param name: 临时讨论组名称,可以包含 2 到 20 个英文字符或 1 到 10 个中文字符。允许使用数字、下划线 (_
)、中线 (-
) 和点。 (示例:吃喝玩乐在深圳
) :type name:str
param member_uids: 临时讨论组成员 id 列表 (示例: ["=bw52O", "=bw52P"]
)type member_uids: list
return: response. 一个 aiobearychat.sansio.Response
实例rtype: aiobearychat.sansio.Response
response.body
返回值示例:response.status 等于 201 时: { "latest_ts": "1489242467694", "name": "临时讨论组名称", "is_member": true, "is_active": true, "type": "session", "member_uids": [ "=bw52O" ], "vchannel_id": "=bw52O", "id": "=bw52O", "team_id": "=bw52O" }
-
info
(session_channel_id: str, **requester_params: typing.Any) → aiobearychat.sansio.Response[源代码]¶ 返回一个临时讨论组的完整信息。
官方文档地址:https://github.com/bearyinnovative/OpenAPI/blob/master/api/session_channel.info.md
参数: session_channel_id ( str
) – 讨论组 id (示例:=bw52O
)返回: response. 一个 aiobearychat.sansio.Response
实例返回类型: aiobearychat.sansio.Response
response.body
返回值示例:response.status 等于 200 时: { "latest_ts": "1489242467694", "name": "临时讨论组名称", "is_member": true, "is_active": true, "type": "session", "member_uids": [ "=bw52O" ], "vchannel_id": "=bw52O", "id": "=bw52O", "team_id": "=bw52O" }
-
invite
(session_channel_id: str, invite_uid: str, **requester_params: typing.Any) → aiobearychat.sansio.Response[源代码]¶ 邀请一个团队成员加入临时讨论组。
官方文档地址:https://github.com/bearyinnovative/OpenAPI/blob/master/api/session_channel.invite.md
参数: - session_channel_id (
str
) – 临时讨论组 id (示例:=bw52O
) - invite_uid (
str
) – 邀请用户 id (示例:=bw52O
)
返回: response. 一个
aiobearychat.sansio.Response
实例返回类型: response.body
返回值示例:response.status 等于 204 时:
- session_channel_id (
-
kick
(session_channel_id: str, kick_uid: str, **requester_params: typing.Any) → aiobearychat.sansio.Response[源代码]¶ 移除一个临时讨论组成员。
官方文档地址:https://github.com/bearyinnovative/OpenAPI/blob/master/api/session_channel.kick.md
参数: - session_channel_id (
str
) – 临时讨论组 id (示例:=bw52O
) - kick_uid (
str
) – 邀请用户 id (示例:=bw52O
)
返回: response. 一个
aiobearychat.sansio.Response
实例返回类型: response.body
返回值示例:response.status 等于 204 时:
- session_channel_id (
-
kickout
(session_channel_id: str, kick_uid: str, **requester_params: typing.Any) → aiobearychat.sansio.Response[源代码]¶ 移除一个临时讨论组成员。
官方文档地址:https://github.com/bearyinnovative/OpenAPI/blob/master/api/session_channel.kickout.md
参数: - session_channel_id (
str
) – 临时讨论组 id (示例:=bw52O
) - kick_uid (
str
) – 邀请用户 id (示例:=bw52O
)
返回: response. 一个
aiobearychat.sansio.Response
实例返回类型: response.body
返回值示例:response.status 等于 204 时:
- session_channel_id (
-
leave
(session_channel_id: str, **requester_params: typing.Any) → aiobearychat.sansio.Response[源代码]¶ 离开临时讨论组。
官方文档地址:https://github.com/bearyinnovative/OpenAPI/blob/master/api/session_channel.leave.md
参数: session_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[源代码]¶ - 返回团队内已经加入的临时讨论组列表,获取某个临时讨论组的完整信息,请使用
session_channel.info
.官方文档地址:https://github.com/bearyinnovative/OpenAPI/blob/master/api/session_channel.list.md
return: response. 一个 aiobearychat.sansio.Response
实例rtype: aiobearychat.sansio.Response
response.body
返回值示例:response.status 等于 200 时: [ { "latest_ts": "1489242467694", "name": "临时讨论组名称", "is_member": true, "is_active": true, "type": "session", "member_uids": [ "=bw52O" ], "vchannel_id": "=bw52O", "id": "=bw52O", "team_id": "=bw52O" } ]
-