Filter Triggers

class FilterTriggers

Text-based triggers.

chat = <class 'gramhopper.triggers.filter_triggers._ChatFilterBasedTrigger'>

A user filter trigger. See more in _ChatFilterBasedTrigger.

language = <class 'gramhopper.triggers.filter_triggers._LanguageFilterBasedTrigger'>

A user filter trigger. See more in _LanguageFilterBasedTrigger.

message_type = <class 'gramhopper.triggers.filter_triggers._MessageTypeFilterBasedTrigger'>

A user filter trigger. See more in _MessageTypeFilterBasedTrigger.

user = <class 'gramhopper.triggers.filter_triggers._UserFilterBasedTrigger'>

A user filter trigger. See more in _UserFilterBasedTrigger.

filter.user

class _UserFilterBasedTrigger(nickname: str = None, user_id: int = None, username: str = None)

A user filter trigger. This is used to trigger a rule when an incoming message comes from a specific user.

__init__(nickname: str = None, user_id: int = None, username: str = None)

Constructs the trigger. nickname can be used if such a nickname is defined in users.json file. Otherwise, one of user_id and username should be specified.

Parameters:

• message_filter – The filter to test if the message passes through
• nickname – The nickname of the user to pass messages from.
• user_id – The Telegram user ID of the user to pass messages from.
• username – The Telegram username of the user to pass messages from.

filter.chat

class _ChatFilterBasedTrigger(chat_id: int = None, username: str = None)

A chat filter trigger. This is used to trigger a rule when an incoming message is in a specific chat.

__init__(chat_id: int = None, username: str = None)

Constructs the trigger. One and only one of chat_id and username should be specified.

Parameters:

• chat_id – The Telegram chat ID of the chat to pass messages from.
• username – The Telegram username whose chat to pass messages from.

filter.language

class _LanguageFilterBasedTrigger(lang: Union[str, List[str]])

A language filter trigger. This is used to trigger a rule when an incoming message is in a specific language.

__init__(lang: Union[str, List[str]])

Constructs the trigger.

Parameters:lang – The language code/s in which to pass messages.

filter.message_type

class _MessageTypeFilterBasedTrigger(message_type)

A message type filter trigger. This is used to trigger a rule when an incoming message is of a specific type.

__init__(message_type)

Constructs the trigger.

Parameters:message_type – The message type of which to filter to pass messages, for example: ‘photo’, ‘status_update.left_chat_member’ or ‘document’. See more in telegram.ext.filters.Filters.