on_opml_outline Event

Fired for each outline in the current OPML document.

Syntax

class RSSOPMLOutlineEventParams(object):
  @property
  def level() -> int: ...
  @property
  def text() -> str: ...
  @property
  def type_name() -> str: ...
  @property
  def title() -> str: ...
  @property
  def url() -> str: ...
  @property
  def xmlurl() -> str: ...
  @property
  def htmlurl() -> str: ...
  @property
  def created() -> str: ...
  @property
  def description() -> str: ...
  @property
  def other_attrs() -> str: ...

# In class RSS:
@property
def on_opml_outline() -> Callable[[RSSOPMLOutlineEventParams], None]: ...
@on_opml_outline.setter
def on_opml_outline(event_hook: Callable[[RSSOPMLOutlineEventParams], None]) -> None: ...

Remarks

This event is fired for each outline in the OPML document.

The Level parameter contains the depth of the current outline in the OPML document.

Each outline contains a "Text" attribute, which is parsed out, and returned in the Text parameter.

The "Type" attribute is a string that describes how the other attributes of the outline are interpreted, and is returned in the TypeName parameter.

The Title parameter refers to the title of the outline.

The URL parameter indicates the external location of the outline.

The XMLURL parameter is usually set to an RSS, Atom or OPML file.

The HTMLURL parameter specifies an "HTMLURL" attribute, which may be used instead of the "URL" attribute.

The Created parameter contains the date the outline node was created.

The OtherAttrs parameter contains a list of other attributes for the current outline. You must use the opml_attr method here to get the attribute's corresponding values from the parser.