CorePayload Reference¶
You should not be creating this object yourself.
- class antispam.CorePayload(member_warn_count: int = 0, member_kick_count: int = 0, member_duplicate_count: int = 0, member_status: str = 'Unknown', member_was_warned: bool = False, member_was_kicked: bool = False, member_was_banned: bool = False, member_was_timed_out: bool = False, member_should_be_punished_this_message: bool = False, pre_invoke_extensions: Dict[str, Any] = _Nothing.NOTHING, after_invoke_extensions: Dict[str, Any] = _Nothing.NOTHING)¶
The CorePayload is a dataclasses which gets returned within the core punishment system for this package.
This is returned from the
antispam.AntiSpamHandler.propagate()method.- Parameters
member_warn_count (int) – How many warns this member has at this point in time
member_kick_count (int) – How many kicks this member has at this point in time
member_duplicate_count (int) – How many messages this member has marked as duplicates
member_status (str) – The status of punishment towards the member
member_was_warned (bool) – If the default punishment handler warned this member
member_was_kicked (bool) – If the default punishment handler kicked this member
member_was_banned (bool) – If the default punishment handler banned this member
member_was_timed_out (bool) – If the default punishment handler timed out this member
member_should_be_punished_this_message (bool) – If AntiSpamHandler thinks this member should receive some form of punishment this message. Useful for
antispam.plugins.AntiSpamTracker
- __init__(member_warn_count: int = 0, member_kick_count: int = 0, member_duplicate_count: int = 0, member_status: str = 'Unknown', member_was_warned: bool = False, member_was_kicked: bool = False, member_was_banned: bool = False, member_was_timed_out: bool = False, member_should_be_punished_this_message: bool = False, pre_invoke_extensions: Dict[str, Any] = _Nothing.NOTHING, after_invoke_extensions: Dict[str, Any] = _Nothing.NOTHING) None¶
Method generated by attrs for class CorePayload.