iamai.adapter.kook.api.model module#
- class iamai.adapter.kook.api.model.Attachments(*, type: str | None = None, url: str | None = None, name: str | None = None, size: int | None = None)[source]#
Bases:
BaseModel
附加的多媒体数据
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'name': FieldInfo(annotation=Union[str, NoneType], required=False), 'size': FieldInfo(annotation=Union[int, NoneType], required=False), 'type': FieldInfo(annotation=Union[str, NoneType], required=False), 'url': FieldInfo(annotation=Union[str, NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- name: str | None#
多媒体名
- size: int | None#
大小 单位(B)
- type: str | None#
多媒体类型
- url: str | None#
多媒体地址
- class iamai.adapter.kook.api.model.BaseMessage(*, id: str | None = None, type: int | None = None, content: str | None = None, embeds: List[dict] | None = None, attachments: bool | Attachments | None = None, create_at: int | None = None, updated_at: int | None = None, reactions: List[Reaction] | None = None, image_name: str | None = None, read_status: bool | None = None, quote: Quote | None = None, mention_info: MentionInfo | None = None)[source]#
Bases:
BaseModel
- attachments: bool | Attachments | None#
附加的多媒体数据
- content: str | None#
消息内容
- create_at: int | None#
创建时间
- embeds: List[dict] | None#
超链接解析数据
- id_: str | None#
消息 ID
- image_name: str | None#
- mention_info: MentionInfo | None#
引用特定用户或特定角色的信息
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'attachments': FieldInfo(annotation=Union[bool, Attachments, NoneType], required=False), 'content': FieldInfo(annotation=Union[str, NoneType], required=False), 'create_at': FieldInfo(annotation=Union[int, NoneType], required=False), 'embeds': FieldInfo(annotation=Union[List[dict], NoneType], required=False), 'id_': FieldInfo(annotation=Union[str, NoneType], required=False, alias='id', alias_priority=2), 'image_name': FieldInfo(annotation=Union[str, NoneType], required=False), 'mention_info': FieldInfo(annotation=Union[MentionInfo, NoneType], required=False), 'quote': FieldInfo(annotation=Union[Quote, NoneType], required=False), 'reactions': FieldInfo(annotation=Union[List[Reaction], NoneType], required=False), 'read_status': FieldInfo(annotation=Union[bool, NoneType], required=False), 'type': FieldInfo(annotation=Union[int, NoneType], required=False), 'updated_at': FieldInfo(annotation=Union[int, NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- read_status: bool | None#
是否已读
- type: int | None#
消息类型
- updated_at: int | None#
更新时间
- class iamai.adapter.kook.api.model.BlackList(*, user_id: str | None = None, created_time: int | None = None, remark: str | None = None, user: User | None = None)[source]#
Bases:
BaseModel
黑名单
- created_time: int | None#
加入黑名单的时间戳(毫秒)
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'created_time': FieldInfo(annotation=Union[int, NoneType], required=False), 'remark': FieldInfo(annotation=Union[str, NoneType], required=False), 'user': FieldInfo(annotation=Union[User, NoneType], required=False), 'user_id': FieldInfo(annotation=Union[str, NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- remark: str | None#
加入黑名单的原因
- user_id: str | None#
用户 id
- class iamai.adapter.kook.api.model.BlackListsReturn(*, meta: Meta | None = None, sort: Dict[str, Any] | None = None, items: List[BlackList] | None = None)[source]#
Bases:
ListReturn
获取黑名单列表返回信息
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'blacklists': FieldInfo(annotation=Union[List[BlackList], NoneType], required=False, alias='items', alias_priority=2), 'meta': FieldInfo(annotation=Union[Meta, NoneType], required=False), 'sort': FieldInfo(annotation=Union[Dict[str, Any], NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class iamai.adapter.kook.api.model.Channel(*, permission_overwrites: List[PermissionOverwrite] | None = None, permission_users: List[PermissionUser] | None = None, permission_sync: int | None = None, id: str | None = None, name: str | None = None, user_id: str | None = None, master_id: str | None = None, guild_id: str | None = None, topic: str | None = None, is_category: bool | None = None, parent_id: str | None = None, level: int | None = None, slow_mode: int | None = None, type: int | None = None, has_password: bool | None = None, limit_amount: int | None = None)[source]#
Bases:
ChannelRoleInfo
开黑啦 频道 字段
- guild_id: str | None#
服务器 id
- has_password: bool | None#
是否有密码
- id_: str | None#
频道 id
- is_category: bool | None#
是否为分组,事件中为 int 格式
- level: int | None#
排序 level
- limit_amount: int | None#
人数限制
- master_id: str | None#
master id
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'guild_id': FieldInfo(annotation=Union[str, NoneType], required=False), 'has_password': FieldInfo(annotation=Union[bool, NoneType], required=False), 'id_': FieldInfo(annotation=Union[str, NoneType], required=False, alias='id', alias_priority=2), 'is_category': FieldInfo(annotation=Union[bool, NoneType], required=False), 'level': FieldInfo(annotation=Union[int, NoneType], required=False), 'limit_amount': FieldInfo(annotation=Union[int, NoneType], required=False), 'master_id': FieldInfo(annotation=Union[str, NoneType], required=False), 'name': FieldInfo(annotation=Union[str, NoneType], required=False), 'parent_id': FieldInfo(annotation=Union[str, NoneType], required=False), 'permission_overwrites': FieldInfo(annotation=Union[List[PermissionOverwrite], NoneType], required=False), 'permission_sync': FieldInfo(annotation=Union[int, NoneType], required=False), 'permission_users': FieldInfo(annotation=Union[List[PermissionUser], NoneType], required=False), 'slow_mode': FieldInfo(annotation=Union[int, NoneType], required=False), 'topic': FieldInfo(annotation=Union[str, NoneType], required=False), 'type': FieldInfo(annotation=Union[int, NoneType], required=False), 'user_id': FieldInfo(annotation=Union[str, NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- name: str | None#
频道名称
- parent_id: str | None#
上级分组的 id
- slow_mode: int | None#
慢速模式下限制发言的最短时间间隔, 单位为秒(s)
- topic: str | None#
频道简介
- type: int | None#
1 文字频道, 2 语音频道
- Type:
频道类型
- user_id: str | None#
创建者 id
- class iamai.adapter.kook.api.model.ChannelMessage(*, id: str | None = None, type: int | None = None, content: str | None = None, embeds: List[dict] | None = None, attachments: bool | Attachments | None = None, create_at: int | None = None, updated_at: int | None = None, reactions: List[Reaction] | None = None, image_name: str | None = None, read_status: bool | None = None, quote: Quote | None = None, mention_info: MentionInfo | None = None, author: User | None = None, mention: List[Any] | None = None, mention_all: bool | None = None, mention_roles: List[Any] | None = None, mention_here: bool | None = None)[source]#
Bases:
BaseMessage
频道消息
- mention: List[Any] | None#
- mention_all: bool | None#
- mention_here: bool | None#
- mention_roles: List[Any] | None#
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'attachments': FieldInfo(annotation=Union[bool, Attachments, NoneType], required=False), 'author': FieldInfo(annotation=Union[User, NoneType], required=False), 'content': FieldInfo(annotation=Union[str, NoneType], required=False), 'create_at': FieldInfo(annotation=Union[int, NoneType], required=False), 'embeds': FieldInfo(annotation=Union[List[dict], NoneType], required=False), 'id_': FieldInfo(annotation=Union[str, NoneType], required=False, alias='id', alias_priority=2), 'image_name': FieldInfo(annotation=Union[str, NoneType], required=False), 'mention': FieldInfo(annotation=Union[List[Any], NoneType], required=False), 'mention_all': FieldInfo(annotation=Union[bool, NoneType], required=False), 'mention_here': FieldInfo(annotation=Union[bool, NoneType], required=False), 'mention_info': FieldInfo(annotation=Union[MentionInfo, NoneType], required=False), 'mention_roles': FieldInfo(annotation=Union[List[Any], NoneType], required=False), 'quote': FieldInfo(annotation=Union[Quote, NoneType], required=False), 'reactions': FieldInfo(annotation=Union[List[Reaction], NoneType], required=False), 'read_status': FieldInfo(annotation=Union[bool, NoneType], required=False), 'type': FieldInfo(annotation=Union[int, NoneType], required=False), 'updated_at': FieldInfo(annotation=Union[int, NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class iamai.adapter.kook.api.model.ChannelMessagesReturn(*, items: List[ChannelMessage] | None = None)[source]#
Bases:
BaseModel
获取私信聊天消息列表返回信息
- direct_messages: List[ChannelMessage] | None#
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'direct_messages': FieldInfo(annotation=Union[List[ChannelMessage], NoneType], required=False, alias='items', alias_priority=2)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class iamai.adapter.kook.api.model.ChannelRoleInfo(*, permission_overwrites: List[PermissionOverwrite] | None = None, permission_users: List[PermissionUser] | None = None, permission_sync: int | None = None)[source]#
Bases:
BaseModel
频道角色权限详情
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'permission_overwrites': FieldInfo(annotation=Union[List[PermissionOverwrite], NoneType], required=False), 'permission_sync': FieldInfo(annotation=Union[int, NoneType], required=False), 'permission_users': FieldInfo(annotation=Union[List[PermissionUser], NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- permission_overwrites: List[PermissionOverwrite] | None#
针对角色在该频道的权限覆写规则组成的列表
- permission_sync: int | None#
权限设置是否与分组同步, 1 or 0
- permission_users: List[PermissionUser] | None#
针对用户在该频道的权限覆写规则组成的列表
- class iamai.adapter.kook.api.model.ChannelRoleReturn(*, role_id: int | None = None, user_id: str | None = None, allow: int | None = None, deny: int | None = None)[source]#
Bases:
BaseModel
创建或更新频道角色权限返回信息
- allow: int | None#
- deny: int | None#
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'allow': FieldInfo(annotation=Union[int, NoneType], required=False), 'deny': FieldInfo(annotation=Union[int, NoneType], required=False), 'role_id': FieldInfo(annotation=Union[int, NoneType], required=False), 'user_id': FieldInfo(annotation=Union[str, NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- role_id: int | None#
- user_id: str | None#
- class iamai.adapter.kook.api.model.ChannelsReturn(*, meta: Meta | None = None, sort: Dict[str, Any] | None = None, items: List[Channel] | None = None)[source]#
Bases:
ListReturn
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'channels': FieldInfo(annotation=Union[List[Channel], NoneType], required=False, alias='items', alias_priority=2), 'meta': FieldInfo(annotation=Union[Meta, NoneType], required=False), 'sort': FieldInfo(annotation=Union[Dict[str, Any], NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class iamai.adapter.kook.api.model.DirectMessage(*, id: str | None = None, type: int | None = None, content: str | None = None, embeds: List[dict] | None = None, attachments: bool | Attachments | None = None, create_at: int | None = None, updated_at: int | None = None, reactions: List[Reaction] | None = None, image_name: str | None = None, read_status: bool | None = None, quote: Quote | None = None, mention_info: MentionInfo | None = None, author_id: str | None = None, from_type: int | None = None, msg_icon: str | None = None)[source]#
Bases:
BaseMessage
私聊消息
- author_id: str | None#
作者的用户 ID
- from_type: int | None#
from_type
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'attachments': FieldInfo(annotation=Union[bool, Attachments, NoneType], required=False), 'author_id': FieldInfo(annotation=Union[str, NoneType], required=False), 'content': FieldInfo(annotation=Union[str, NoneType], required=False), 'create_at': FieldInfo(annotation=Union[int, NoneType], required=False), 'embeds': FieldInfo(annotation=Union[List[dict], NoneType], required=False), 'from_type': FieldInfo(annotation=Union[int, NoneType], required=False), 'id_': FieldInfo(annotation=Union[str, NoneType], required=False, alias='id', alias_priority=2), 'image_name': FieldInfo(annotation=Union[str, NoneType], required=False), 'mention_info': FieldInfo(annotation=Union[MentionInfo, NoneType], required=False), 'msg_icon': FieldInfo(annotation=Union[str, NoneType], required=False), 'quote': FieldInfo(annotation=Union[Quote, NoneType], required=False), 'reactions': FieldInfo(annotation=Union[List[Reaction], NoneType], required=False), 'read_status': FieldInfo(annotation=Union[bool, NoneType], required=False), 'type': FieldInfo(annotation=Union[int, NoneType], required=False), 'updated_at': FieldInfo(annotation=Union[int, NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- msg_icon: str | None#
msg_icon
- class iamai.adapter.kook.api.model.DirectMessagesReturn(*, items: List[DirectMessage] | None = None)[source]#
Bases:
BaseModel
获取私信聊天消息列表返回信息
- direct_messages: List[DirectMessage] | None#
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'direct_messages': FieldInfo(annotation=Union[List[DirectMessage], NoneType], required=False, alias='items', alias_priority=2)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class iamai.adapter.kook.api.model.Emoji(*, id: str | None = None, name: str | None = None)[source]#
Bases:
BaseModel
- id_: str | None#
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'id_': FieldInfo(annotation=Union[str, NoneType], required=False, alias='id', alias_priority=2), 'name': FieldInfo(annotation=Union[str, NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- name: str | None#
- class iamai.adapter.kook.api.model.GuilRoleReturn(*, user_id: str | None = None, guild_id: str | None = None, roles: List[int] | None = None)[source]#
Bases:
BaseModel
赋予或删除用户角色返回信息
- guild_id: str | None#
服务器 id
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'guild_id': FieldInfo(annotation=Union[str, NoneType], required=False), 'roles': FieldInfo(annotation=Union[List[int], NoneType], required=False), 'user_id': FieldInfo(annotation=Union[str, NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- roles: List[int] | None#
角色 id 的列表
- user_id: str | None#
用户 id
- class iamai.adapter.kook.api.model.Guild(*, id: str | None = None, name: str | None = None, topic: str | None = None, user_id: str | None = None, icon: str | None = None, notify_type: int | None = None, region: str | None = None, enable_open: bool | None = None, open_id: str | None = None, default_channel_id: str | None = None, welcome_channel_id: str | None = None, roles: List[Role] | None = None, channels: List[Channel] | None = None)[source]#
Bases:
BaseModel
服务器
- default_channel_id: str | None#
默认频道 id
- enable_open: bool | None#
是否为公开服务器
- icon: str | None#
服务器 icon 的地址
- id_: str | None#
服务器 id
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'channels': FieldInfo(annotation=Union[List[Channel], NoneType], required=False), 'default_channel_id': FieldInfo(annotation=Union[str, NoneType], required=False), 'enable_open': FieldInfo(annotation=Union[bool, NoneType], required=False), 'icon': FieldInfo(annotation=Union[str, NoneType], required=False), 'id_': FieldInfo(annotation=Union[str, NoneType], required=False, alias='id', alias_priority=2), 'name': FieldInfo(annotation=Union[str, NoneType], required=False), 'notify_type': FieldInfo(annotation=Union[int, NoneType], required=False), 'open_id': FieldInfo(annotation=Union[str, NoneType], required=False), 'region': FieldInfo(annotation=Union[str, NoneType], required=False), 'roles': FieldInfo(annotation=Union[List[Role], NoneType], required=False), 'topic': FieldInfo(annotation=Union[str, NoneType], required=False), 'user_id': FieldInfo(annotation=Union[str, NoneType], required=False), 'welcome_channel_id': FieldInfo(annotation=Union[str, NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- name: str | None#
服务器名称
- open_id: str | None#
公开服务器 id
- region: str | None#
服务器默认使用语音区域
- topic: str | None#
服务器主题
- user_id: str | None#
服务器主的 id
- welcome_channel_id: str | None#
欢迎频道 id
- class iamai.adapter.kook.api.model.GuildEmoji(*, name: str | None = None, id: str | None = None, user_info: User | None = None)[source]#
Bases:
BaseModel
服务器表情
- id_: str | None#
表情的 ID
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'id_': FieldInfo(annotation=Union[str, NoneType], required=False, alias='id', alias_priority=2), 'name': FieldInfo(annotation=Union[str, NoneType], required=False), 'user_info': FieldInfo(annotation=Union[User, NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- name: str | None#
表情的名称
- class iamai.adapter.kook.api.model.GuildEmojisReturn(*, meta: Meta | None = None, sort: Dict[str, Any] | None = None, items: List[GuildEmoji] | None = None)[source]#
Bases:
ListReturn
获取服务器表情列表返回信息
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'meta': FieldInfo(annotation=Union[Meta, NoneType], required=False), 'roles': FieldInfo(annotation=Union[List[GuildEmoji], NoneType], required=False, alias='items', alias_priority=2), 'sort': FieldInfo(annotation=Union[Dict[str, Any], NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- roles: List[GuildEmoji] | None#
服务器表情列表
- class iamai.adapter.kook.api.model.GuildUsersRetrun(*, meta: Meta | None = None, sort: Dict[str, Any] | None = None, items: List[User] | None = None, user_count: int | None = None, online_count: int | None = None, offline_count: int | None = None)[source]#
Bases:
ListReturn
服务器中的用户列表
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'meta': FieldInfo(annotation=Union[Meta, NoneType], required=False), 'offline_count': FieldInfo(annotation=Union[int, NoneType], required=False), 'online_count': FieldInfo(annotation=Union[int, NoneType], required=False), 'sort': FieldInfo(annotation=Union[Dict[str, Any], NoneType], required=False), 'user_count': FieldInfo(annotation=Union[int, NoneType], required=False), 'users': FieldInfo(annotation=Union[List[User], NoneType], required=False, alias='items', alias_priority=2)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- offline_count: int | None#
离线用户数量
- online_count: int | None#
在线用户数量
- user_count: int | None#
用户数量
- class iamai.adapter.kook.api.model.GuildsReturn(*, meta: Meta | None = None, sort: Dict[str, Any] | None = None, items: List[Guild] | None = None)[source]#
Bases:
ListReturn
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'guilds': FieldInfo(annotation=Union[List[Guild], NoneType], required=False, alias='items', alias_priority=2), 'meta': FieldInfo(annotation=Union[Meta, NoneType], required=False), 'sort': FieldInfo(annotation=Union[Dict[str, Any], NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class iamai.adapter.kook.api.model.IntimacyImg(*, id: str | None = None, url: str | None = None)[source]#
Bases:
BaseModel
形象图片的总列表
- id_: str | None#
形象图片的 id
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'id_': FieldInfo(annotation=Union[str, NoneType], required=False, alias='id', alias_priority=2), 'url': FieldInfo(annotation=Union[str, NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- url: str | None#
形象图片的地址
- class iamai.adapter.kook.api.model.IntimacyIndexReturn(*, img_url: str | None = None, social_info: str | None = None, last_read: int | None = None, score: int | None = None, img_list: List[IntimacyImg] | None = None)[source]#
Bases:
BaseModel
获取用户亲密度返回信息
- img_list: List[IntimacyImg] | None#
形象图片的总列表
- img_url: str | None#
机器人给用户显示的形象图片地址
- last_read: int | None#
用户上次查看的时间戳
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'img_list': FieldInfo(annotation=Union[List[IntimacyImg], NoneType], required=False), 'img_url': FieldInfo(annotation=Union[str, NoneType], required=False), 'last_read': FieldInfo(annotation=Union[int, NoneType], required=False), 'score': FieldInfo(annotation=Union[int, NoneType], required=False), 'social_info': FieldInfo(annotation=Union[str, NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- score: int | None#
亲密度,0-2200
- social_info: str | None#
机器人显示给用户的社交信息
- class iamai.adapter.kook.api.model.Invite(*, guild_id: str | None = None, channel_id: str | None = None, url_code: str | None = None, url: str | None = None, user: User | None = None)[source]#
Bases:
BaseModel
邀请信息
- channel_id: str | None#
频道 id
- guild_id: str | None#
服务器 id
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'channel_id': FieldInfo(annotation=Union[str, NoneType], required=False), 'guild_id': FieldInfo(annotation=Union[str, NoneType], required=False), 'url': FieldInfo(annotation=Union[str, NoneType], required=False), 'url_code': FieldInfo(annotation=Union[str, NoneType], required=False), 'user': FieldInfo(annotation=Union[User, NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- url: str | None#
地址
- url_code: str | None#
url code
- class iamai.adapter.kook.api.model.InvitesReturn(*, meta: Meta | None = None, sort: Dict[str, Any] | None = None, items: List[Invite] | None = None)[source]#
Bases:
ListReturn
获取邀请列表返回信息
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'meta': FieldInfo(annotation=Union[Meta, NoneType], required=False), 'roles': FieldInfo(annotation=Union[List[Invite], NoneType], required=False, alias='items', alias_priority=2), 'sort': FieldInfo(annotation=Union[Dict[str, Any], NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class iamai.adapter.kook.api.model.ListReturn(*, meta: Meta | None = None, sort: Dict[str, Any] | None = None)[source]#
Bases:
BaseModel
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'meta': FieldInfo(annotation=Union[Meta, NoneType], required=False), 'sort': FieldInfo(annotation=Union[Dict[str, Any], NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- sort: Dict[str, Any] | None#
- class iamai.adapter.kook.api.model.MentionInfo(*, mention_part: List[dict] | None = None, mention_role_part: List[dict] | None = None, channel_part: List[dict] | None = None, item_part: List[dict] | None = None)[source]#
Bases:
BaseModel
- channel_part: List[dict] | None#
- item_part: List[dict] | None#
- mention_part: List[dict] | None#
- mention_role_part: List[dict] | None#
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'channel_part': FieldInfo(annotation=Union[List[dict], NoneType], required=False), 'item_part': FieldInfo(annotation=Union[List[dict], NoneType], required=False), 'mention_part': FieldInfo(annotation=Union[List[dict], NoneType], required=False), 'mention_role_part': FieldInfo(annotation=Union[List[dict], NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class iamai.adapter.kook.api.model.MessageCreateReturn(*, msg_id: str | None = None, msg_timestamp: int | None = None, nonce: str | None = None)[source]#
Bases:
BaseModel
发送频道消息返回信息
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'msg_id': FieldInfo(annotation=Union[str, NoneType], required=False), 'msg_timestamp': FieldInfo(annotation=Union[int, NoneType], required=False), 'nonce': FieldInfo(annotation=Union[str, NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- msg_id: str | None#
服务端生成的消息 id
- msg_timestamp: int | None#
消息发送时间(服务器时间戳)
- nonce: str | None#
随机字符串
- class iamai.adapter.kook.api.model.Meta(*, page: int | None = None, page_total: int | None = None, page_size: int | None = None, total: int | None = None)[source]#
Bases:
BaseModel
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'page': FieldInfo(annotation=Union[int, NoneType], required=False), 'page_size': FieldInfo(annotation=Union[int, NoneType], required=False), 'page_total': FieldInfo(annotation=Union[int, NoneType], required=False), 'total': FieldInfo(annotation=Union[int, NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- page: int | None#
- page_size: int | None#
- page_total: int | None#
- total: int | None#
- class iamai.adapter.kook.api.model.PermissionOverwrite(*, role_id: int | None = None, allow: int | None = None, deny: int | None = None)[source]#
Bases:
BaseModel
- allow: int | None#
- deny: int | None#
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'allow': FieldInfo(annotation=Union[int, NoneType], required=False), 'deny': FieldInfo(annotation=Union[int, NoneType], required=False), 'role_id': FieldInfo(annotation=Union[int, NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- role_id: int | None#
- class iamai.adapter.kook.api.model.PermissionUser(*, user: User | None = None, allow: int | None = None, deny: int | None = None)[source]#
Bases:
BaseModel
- allow: int | None#
- deny: int | None#
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'allow': FieldInfo(annotation=Union[int, NoneType], required=False), 'deny': FieldInfo(annotation=Union[int, NoneType], required=False), 'user': FieldInfo(annotation=Union[User, NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class iamai.adapter.kook.api.model.Quote(*, id: str | None = None, type: int | None = None, content: str | None = None, create_at: int | None = None, author: User | None = None)[source]#
Bases:
BaseModel
引用消息
- content: str | None#
引用消息内容
- create_at: int | None#
引用消息创建时间(毫秒)
- id_: str | None#
引用消息 id
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'author': FieldInfo(annotation=Union[User, NoneType], required=False), 'content': FieldInfo(annotation=Union[str, NoneType], required=False), 'create_at': FieldInfo(annotation=Union[int, NoneType], required=False), 'id_': FieldInfo(annotation=Union[str, NoneType], required=False, alias='id', alias_priority=2), 'type': FieldInfo(annotation=Union[int, NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- type: int | None#
引用消息类型
- class iamai.adapter.kook.api.model.Reaction(*, emoji: Emoji | None = None, count: int | None = None, me: bool | None = None)[source]#
Bases:
BaseModel
- count: int | None#
- me: bool | None#
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'count': FieldInfo(annotation=Union[int, NoneType], required=False), 'emoji': FieldInfo(annotation=Union[Emoji, NoneType], required=False), 'me': FieldInfo(annotation=Union[bool, NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class iamai.adapter.kook.api.model.ReactionUser(*, id: str | None = None, username: str | None = None, nickname: str | None = None, identify_num: str | None = None, online: bool | None = None, bot: bool | None = None, os: str | None = None, status: int | None = None, avatar: str | None = None, vip_avatar: str | None = None, mobile_verified: bool | None = None, roles: List[int] | None = None, joined_at: int | None = None, active_time: int | None = None, reaction_time: int | None = None)[source]#
Bases:
User
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'active_time': FieldInfo(annotation=Union[int, NoneType], required=False), 'avatar': FieldInfo(annotation=Union[str, NoneType], required=False), 'bot': FieldInfo(annotation=Union[bool, NoneType], required=False), 'id_': FieldInfo(annotation=Union[str, NoneType], required=False, alias='id', alias_priority=2), 'identify_num': FieldInfo(annotation=Union[str, NoneType], required=False), 'joined_at': FieldInfo(annotation=Union[int, NoneType], required=False), 'mobile_verified': FieldInfo(annotation=Union[bool, NoneType], required=False), 'nickname': FieldInfo(annotation=Union[str, NoneType], required=False), 'online': FieldInfo(annotation=Union[bool, NoneType], required=False), 'os': FieldInfo(annotation=Union[str, NoneType], required=False), 'reaction_time': FieldInfo(annotation=Union[int, NoneType], required=False), 'roles': FieldInfo(annotation=Union[List[int], NoneType], required=False), 'status': FieldInfo(annotation=Union[int, NoneType], required=False), 'username': FieldInfo(annotation=Union[str, NoneType], required=False), 'vip_avatar': FieldInfo(annotation=Union[str, NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- reaction_time: int | None#
- class iamai.adapter.kook.api.model.Role(*, role_id: int | None = None, name: str | None = None, color: int | None = None, position: int | None = None, hoist: int | None = None, mentionable: int | None = None, permissions: int | None = None)[source]#
Bases:
BaseModel
角色
- color: int | None#
颜色色值
- hoist: int | None#
是否为角色设定(与普通成员分开显示)
- mentionable: int | None#
是否允许任何人@提及此角色
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'color': FieldInfo(annotation=Union[int, NoneType], required=False), 'hoist': FieldInfo(annotation=Union[int, NoneType], required=False), 'mentionable': FieldInfo(annotation=Union[int, NoneType], required=False), 'name': FieldInfo(annotation=Union[str, NoneType], required=False), 'permissions': FieldInfo(annotation=Union[int, NoneType], required=False), 'position': FieldInfo(annotation=Union[int, NoneType], required=False), 'role_id': FieldInfo(annotation=Union[int, NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- name: str | None#
角色名称
- permissions: int | None#
权限码
- position: int | None#
顺序位置
- role_id: int | None#
角色 id
- class iamai.adapter.kook.api.model.RolesReturn(*, meta: Meta | None = None, sort: Dict[str, Any] | None = None, items: List[Role] | None = None)[source]#
Bases:
ListReturn
获取服务器角色列表返回信息
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'meta': FieldInfo(annotation=Union[Meta, NoneType], required=False), 'roles': FieldInfo(annotation=Union[List[Role], NoneType], required=False, alias='items', alias_priority=2), 'sort': FieldInfo(annotation=Union[Dict[str, Any], NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class iamai.adapter.kook.api.model.TargetInfo(*, id: str | None = None, username: str | None = None, online: bool | None = None, avatar: str | None = None)[source]#
Bases:
BaseModel
私聊会话 目标用户信息
- avatar: str | None#
头像图片链接
- id_: str | None#
目标用户 ID
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'avatar': FieldInfo(annotation=Union[str, NoneType], required=False), 'id_': FieldInfo(annotation=Union[str, NoneType], required=False, alias='id', alias_priority=2), 'online': FieldInfo(annotation=Union[bool, NoneType], required=False), 'username': FieldInfo(annotation=Union[str, NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- online: bool | None#
是否在线
- username: str | None#
目标用户名
- class iamai.adapter.kook.api.model.URL(*, url: str | None = None)[source]#
Bases:
BaseModel
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'url': FieldInfo(annotation=Union[str, NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- url: str | None#
资源的 url
- class iamai.adapter.kook.api.model.User(*, id: str | None = None, username: str | None = None, nickname: str | None = None, identify_num: str | None = None, online: bool | None = None, bot: bool | None = None, os: str | None = None, status: int | None = None, avatar: str | None = None, vip_avatar: str | None = None, mobile_verified: bool | None = None, roles: List[int] | None = None, joined_at: int | None = None, active_time: int | None = None)[source]#
Bases:
BaseModel
开黑啦 User 字段
https://developer.kaiheila.cn/doc/objects
- active_time: int | None#
上次在线时间
- avatar: str | None#
用户的头像的 url 地址
- bot: bool | None#
是否为机器人
- id_: str | None#
用户的 id
- identify_num: str | None#
用户名的认证数字,用户名正常为:user_name#identify_num
- joined_at: int | None#
加入服务器时间
- mobile_verified: bool | None#
是否手机号已验证
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'active_time': FieldInfo(annotation=Union[int, NoneType], required=False), 'avatar': FieldInfo(annotation=Union[str, NoneType], required=False), 'bot': FieldInfo(annotation=Union[bool, NoneType], required=False), 'id_': FieldInfo(annotation=Union[str, NoneType], required=False, alias='id', alias_priority=2), 'identify_num': FieldInfo(annotation=Union[str, NoneType], required=False), 'joined_at': FieldInfo(annotation=Union[int, NoneType], required=False), 'mobile_verified': FieldInfo(annotation=Union[bool, NoneType], required=False), 'nickname': FieldInfo(annotation=Union[str, NoneType], required=False), 'online': FieldInfo(annotation=Union[bool, NoneType], required=False), 'os': FieldInfo(annotation=Union[str, NoneType], required=False), 'roles': FieldInfo(annotation=Union[List[int], NoneType], required=False), 'status': FieldInfo(annotation=Union[int, NoneType], required=False), 'username': FieldInfo(annotation=Union[str, NoneType], required=False), 'vip_avatar': FieldInfo(annotation=Union[str, NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- nickname: str | None#
用户在当前服务器的昵称
- online: bool | None#
当前是否在线
- os: str | None#
os
- roles: List[int] | None#
用户在当前服务器中的角色 id 组成的列表
- username: str | None#
用户的名称
- vip_avatar: str | None#
vip 用户的头像的 url 地址,可能为 gif 动图
- class iamai.adapter.kook.api.model.UserChat(*, code: str | None = None, last_read_time: int | None = None, latest_msg_time: int | None = None, unread_count: int | None = None, target_info: TargetInfo | None = None)[source]#
Bases:
BaseModel
私聊会话
- code: str | None#
私信会话 Code
- last_read_time: int | None#
上次阅读消息的时间 (毫秒)
- latest_msg_time: int | None#
最新消息时间 (毫秒)
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'code': FieldInfo(annotation=Union[str, NoneType], required=False), 'last_read_time': FieldInfo(annotation=Union[int, NoneType], required=False), 'latest_msg_time': FieldInfo(annotation=Union[int, NoneType], required=False), 'target_info': FieldInfo(annotation=Union[TargetInfo, NoneType], required=False), 'unread_count': FieldInfo(annotation=Union[int, NoneType], required=False)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- target_info: TargetInfo | None#
目标用户信息
- unread_count: int | None#
未读消息数
- class iamai.adapter.kook.api.model.UserChatsReturn(*, meta: Meta | None = None, sort: Dict[str, Any] | None = None, items: List[UserChat] | None = None)[source]#
Bases:
ListReturn
获取私信聊天会话列表返回信息
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'meta': FieldInfo(annotation=Union[Meta, NoneType], required=False), 'sort': FieldInfo(annotation=Union[Dict[str, Any], NoneType], required=False), 'user_chats': FieldInfo(annotation=Union[List[UserChat], NoneType], required=False, alias='items', alias_priority=2)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.