web

web#

class platypush.message.event.web.DashboardIframeUpdateEvent(url, width=None, height=None, timeout=None, *args, **kwargs)[source]#

Bases: Event

Deliver a DashboardIframeUpdateEvent if you are using the web dashboard and you want the connected web clients to show a certain URL in the iframe modal window for (optionally) a certain time.

__init__(url, width=None, height=None, timeout=None, *args, **kwargs)[source]#
Parameters:

  • url (str) – URL to show in the iframe dashboard element

  • width – Iframe width, as int (pixels) or CSS string

  • height – Iframe height, as int (pixels) or CSS string

  • timeout (float) – If set, the iframe will be closed after this time (in seconds)

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