Skip to content

Adds optional naming to add_listener method. #302

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
err508 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Adds optional naming to add_listener method. #302

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions matrix_client/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,18 +352,19 @@ def get_rooms(self):

# TODO: create Listener class and push as much of this logic there as possible
# NOTE: listeners related to things in rooms should be attached to Room objects
def add_listener(self, callback, event_type=None):
def add_listener(self, callback, name=None, event_type=None):
""" Add a listener that will send a callback when the client recieves
an event.

Args:
callback (func(roomchunk)): Callback called when an event arrives.
name (str): Optional listener name to identify the listener more conveniently
event_type (str): The event_type to filter for.

Returns:
uuid.UUID: Unique id of the listener, can be used to identify the listener.
"""
listener_uid = uuid4()
listener_uid = name if name else uuid4()
# TODO: listeners should be stored in dict and accessed/deleted directly. Add
# convenience method such that MatrixClient.listeners.new(Listener(...)) performs
# MatrixClient.listeners[uuid4()] = Listener(...)
Expand Down