状态

class ehforwarderbot.status.Status[源代码]

状态的抽象类

destination_channel

收到这条状态的信道，通常是主端。

类型

Channel

class ehforwarderbot.status.ChatUpdates(channel, new_chats=(), removed_chats=(), modified_chats=())[源代码]

通知主端关于从端会话的更新。

channel

发送更新的从端

类型

SlaveChannel

new_chats

新会话的唯一 ID

类型

Optional[Collection[str]]

removed_chats

已移除会话的唯一 ID

类型

Optional[Collection[str]]

modified_chats

已变更会话的唯一 ID

类型

Optional[Collection[str]]

__init__(channel, new_chats=(), removed_chats=(), modified_chats=())[源代码]
参数

  • channel (SlaveChannel) – 发送更新的从端

  • new_chats (Optional[Collection[str]]) – 新会话的唯一 ID

  • removed_chats (Optional[Collection[str]]) – 已移除会话的唯一 ID

  • modified_chats (Optional[Collection[str]]) – 已变更会话的唯一 ID

class ehforwarderbot.status.MemberUpdates(channel, chat_id, new_members=(), removed_members=(), modified_members=())[源代码]

通知主端关于从端群组成员的更新。

channel

发送更新的从端

类型

SlaveChannel

chat_id

会话的唯一 ID。

类型

str

new_members

新成员的唯一 ID

类型

Optional[Collection[str]]

removed_members

已移除成员的唯一 ID

类型

Optional[Collection[str]]

modified_members

已变更成员的唯一 ID

类型

Optional[Collection[str]]

__init__(channel, chat_id, new_members=(), removed_members=(), modified_members=())[源代码]
参数

  • channel (SlaveChannel) – 发送更新的从端

  • chat_id (str) – 会话的唯一 ID。

  • new_members (Optional[Collection[str]]) – 新成员的唯一 ID

  • removed_members (Optional[Collection[str]]) – 已移除成员的唯一 ID

  • modified_members (Optional[Collection[str]]) – 已变更成员的唯一 ID

class ehforwarderbot.status.MessageReactionsUpdate(chat, msg_id, reactions)[源代码]

更新一条消息附带的回应，由从端发送至主端。

参数

  • chat (Chat) – 发送消息的会话

  • msg_id (str) – 被回应的消息 ID

  • reactions (Mapping[NewType()(ReactionName, str), Collection[ChatMember]]) – 指定对消息的回应。字典的键表示回应名，通常是一个 emoji；值为使用此 emoji 对该消息作出回应的用户列表。字典中所有 Chat 对象必须（MUST）为会话的成员。

  • destination_channel (MasterChannel) – 状态发送至的信道，通常为主端。

__init__(chat, msg_id, reactions)[源代码]
参数

  • chat (Chat) – 发送消息的会话

  • msg_id (str) – 被回应的消息 ID

  • reactions (Mapping[NewType()(ReactionName, str), Collection[ChatMember]]) – 指定对消息的回应。字典的键表示回应名，通常是一个 emoji；值为使用此 emoji 对该消息作出回应的用户列表。字典中所有 Chat 对象必须（MUST）为会话的成员。

class ehforwarderbot.status.MessageRemoval(source_channel, destination_channel, message)[源代码]

通知信道删除特定消息。

在不同的即时通讯平台，该操作通常被称为「从所有人删除」、「从收件人处删除」、「撤回」等。

某些信道可能（MAY）不支持删除消息，并会抛出 exceptions.EFBOperationNotSupported 异常。

当此对象来自主端时，从端不需要再次发送 MessageRemoval 作为反馈。主端应（SHOULD）将成功递送此对象视为消息被成功移除的标志。

source_channel

发送状态的信道

类型

Channel

destination_channel

接收状态的信道

类型

Channel

message

要删除的消息。该对象可能（MAY）不是一个完整的 message.Message 对象。

类型

Message

引发

.exceptions.EFBOperationNotSupported – 当该信道不支持信息移除时。

__init__(source_channel, destination_channel, message)[源代码]

创建消息删除状态

尝试提供尽可能多的信息，但必须保证如下信息存在：

  • 从端 ID 与会话 ID（message.chat.module_id 和 message.chat.uid）

  • 来自该从端的消息唯一 ID（message.uid）

参数

  • source_channel (Channel) – 发送状态的信道

  • destination_channel (Channel) – 接收状态的信道

  • message (Message) – 要移除的消息。

class ehforwarderbot.status.ReactToMessage(chat, msg_id, reaction)[源代码]

当用户向消息发出回应时被创建，由主端发送。

当此状态被发送时，建议（RECOMMEND）向主端发送 status.MessageReactionsUpdate。

参数

  • chat (Chat) – 发送消息的会话

  • msg_id (str) – 被回应的消息 ID

  • reaction (Optional[str]) – 将发送的回应名，通常是一个 emoji。发送 None 来移除回应。

  • destination_channel (SlaveChannel) – 状态发送至的信道，从会话对象中抽出。

引发

  • .exceptions.EFBMessageReactionNotPossible – 当回应无效时（例如，该回应不在支持的回应列表中）抛出。

  • .exceptions.EFBOperationNotSupported – 当该消息不支持任何形式的回应时抛出。

__init__(chat, msg_id, reaction)[源代码]
参数

  • chat (Chat) – 发送消息的会话

  • msg_id (str) – 被回应的消息 ID

  • reaction (Optional[NewType()(ReactionName, str)]) – 要发送的回应名，通常是一个 emoji。