icalendar.prop.xml_reference module#

XML-REFERENCE values from RFC 9253.

class icalendar.prop.xml_reference.vXmlReference(value: str, encoding: str = 'utf-8', /, params: dict[str, Any] | None = None)[source]#

Bases: vUri

An XML-REFERENCE.

The associated value references an associated XML artifact and is a URI with an XPointer anchor value.

This is defined in RFC 9253, Section 7.

default_value: ClassVar[str] = 'XML-REFERENCE'#
classmethod examples()[source]#

Examples of vXmlReference.

Return type:

list[None]

params: Parameters#
property x_pointer: str | None#

The XPointer of the URI.

The XPointer is defined in W3C.WD-xptr-xpointer-20021219, and its use as an anchor is defined in W3C.REC-xptr-framework-20030325.

Returns:

The decoded x-pointer or None if no valid x-pointer is found.

property xml_reference: str#

The XML reference URI of this property.