websocket

class platypush.message.event.websocket.WebsocketMessageEvent(*args, url: str, message: Any, **kwargs)

Bases: Event

Event triggered when a message is receive on a subscribed websocket URL.

__init__(*args, url: str, message: Any, **kwargs)

Parameters:

• url – Websocket URL.

• message – The received message.

as_dict()

Converts the event into a dictionary

classmethod build(msg)

Builds an event message from a JSON UTF-8 string/bytearray, a dictionary, or another Event

matches_condition(condition)

If the event matches an event condition, it will return an EventMatchResult :param condition: The platypush.event.hook.EventCondition object

classmethod parse(msg)

Parse a generic message into a key-value dictionary

Parameters:

msg – Original message. It can be a dictionary, a Message, or a string/bytearray, as long as it’s valid UTF-8 JSON

classmethod to_dict(msg)

Converts a Message object into a dictionary

Parameters:

msg – Message object