# {py:mod}`arelle.ModelRssObject`

```{py:module} arelle.ModelRssObject
```

```{autodoc2-docstring} arelle.ModelRssObject
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`ModelRssObject <arelle.ModelRssObject.ModelRssObject>`
  - ```{autodoc2-docstring} arelle.ModelRssObject.ModelRssObject
    :summary:
    ```
````

### API

`````{py:class} ModelRssObject(modelXbrl: arelle.ModelXbrl.ModelXbrl, type: int = Type.RSSFEED, uri: str | None = None, filepath: str | None = None, xmlDocument: lxml.etree._ElementTree[lxml.etree._Element] | None = None)
:canonical: arelle.ModelRssObject.ModelRssObject

Bases: {py:obj}`arelle.ModelDocument.ModelDocument`

```{autodoc2-docstring} arelle.ModelRssObject.ModelRssObject
```

```{rubric} Initialization
```

```{autodoc2-docstring} arelle.ModelRssObject.ModelRssObject.__init__
```

````{py:attribute} rssItems
:canonical: arelle.ModelRssObject.ModelRssObject.rssItems
:type: list[arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject]
:value: >
   None

```{autodoc2-docstring} arelle.ModelRssObject.ModelRssObject.rssItems
```

````

````{py:method} rssFeedDiscover(rootElement: arelle.ModelObject.ModelObject) -> None
:canonical: arelle.ModelRssObject.ModelRssObject.rssFeedDiscover

```{autodoc2-docstring} arelle.ModelRssObject.ModelRssObject.rssFeedDiscover
```

````

````{py:attribute} documentEncoding
:canonical: arelle.ModelRssObject.ModelRssObject.documentEncoding
:type: str
:value: >
   None

````

````{py:attribute} entrypoint
:canonical: arelle.ModelRssObject.ModelRssObject.entrypoint
:type: dict[str, typing.Any] | None
:value: >
   None

````

````{py:attribute} xmlRootElement
:canonical: arelle.ModelRssObject.ModelRssObject.xmlRootElement
:type: typing.Any
:value: >
   None

````

````{py:attribute} targetXbrlRootElement
:canonical: arelle.ModelRssObject.ModelRssObject.targetXbrlRootElement
:type: arelle.ModelObject.ModelObject
:value: >
   None

````

````{py:attribute} parser
:canonical: arelle.ModelRssObject.ModelRssObject.parser
:type: lxml.etree.XMLParser[lxml.etree._Element]
:value: >
   None

````

````{py:attribute} parserLookupName
:canonical: arelle.ModelRssObject.ModelRssObject.parserLookupName
:type: arelle.ModelObjectFactory.KnownNamespacesModelObjectClassLookup
:value: >
   None

````

````{py:attribute} parserLookupClass
:canonical: arelle.ModelRssObject.ModelRssObject.parserLookupClass
:type: arelle.ModelObjectFactory.DiscoveringClassLookup
:value: >
   None

````

````{py:attribute} securityClassification
:canonical: arelle.ModelRssObject.ModelRssObject.securityClassification
:type: str | None
:value: >
   None

````

````{py:attribute} fromDTS
:canonical: arelle.ModelRssObject.ModelRssObject.fromDTS
:type: arelle.ModelXbrl.ModelXbrl
:value: >
   None

````

````{py:attribute} toDTS
:canonical: arelle.ModelRssObject.ModelRssObject.toDTS
:type: arelle.ModelXbrl.ModelXbrl
:value: >
   None

````

````{py:method} objectId(refId: str = '') -> str
:canonical: arelle.ModelRssObject.ModelRssObject.objectId

````

````{py:property} qname
:canonical: arelle.ModelRssObject.ModelRssObject.qname
:type: arelle.ModelValue.QName | None

````

````{py:method} relativeUri(uri: str) -> str
:canonical: arelle.ModelRssObject.ModelRssObject.relativeUri

````

````{py:property} modelDocument
:canonical: arelle.ModelRssObject.ModelRssObject.modelDocument
:type: typing_extensions.Self

````

````{py:property} displayUri
:canonical: arelle.ModelRssObject.ModelRssObject.displayUri
:type: str

````

````{py:property} basename
:canonical: arelle.ModelRssObject.ModelRssObject.basename
:type: str

````

````{py:property} filepathdir
:canonical: arelle.ModelRssObject.ModelRssObject.filepathdir
:type: str

````

````{py:property} propertyView
:canonical: arelle.ModelRssObject.ModelRssObject.propertyView
:type: tuple[tuple[str, str], ...]

````

````{py:method} setTitle(cntlr: arelle.CntlrWinMain.CntlrWinMain) -> None
:canonical: arelle.ModelRssObject.ModelRssObject.setTitle

````

````{py:method} setTitleInBackground() -> None
:canonical: arelle.ModelRssObject.ModelRssObject.setTitleInBackground

````

````{py:method} updateFileHistoryIfNeeded() -> None
:canonical: arelle.ModelRssObject.ModelRssObject.updateFileHistoryIfNeeded

````

````{py:method} save(overrideFilepath: str | None = None, outputZip: zipfile.ZipFile | None = None, outputFile: io.IOBase | None = None, updateFileHistory: bool = True, encoding: str = 'utf-8', zipDir: str | None = None, **kwargs: typing.Any) -> None
:canonical: arelle.ModelRssObject.ModelRssObject.save

````

````{py:method} close(visited: list[arelle.ModelDocument.ModelDocument] | None = None, urlDocs: dict[str, arelle.ModelDocument.ModelDocument] | None = None) -> None
:canonical: arelle.ModelRssObject.ModelRssObject.close

````

````{py:method} gettype() -> str
:canonical: arelle.ModelRssObject.ModelRssObject.gettype

````

````{py:property} creationSoftwareComment
:canonical: arelle.ModelRssObject.ModelRssObject.creationSoftwareComment
:type: str | None

````

````{py:property} creationSoftware
:canonical: arelle.ModelRssObject.ModelRssObject.creationSoftware
:type: str

````

````{py:method} creationSoftwareMatches(text: str | None) -> list[str]
:canonical: arelle.ModelRssObject.ModelRssObject.creationSoftwareMatches

````

````{py:property} processingInstructions
:canonical: arelle.ModelRssObject.ModelRssObject.processingInstructions
:type: list[lxml.etree._ProcessingInstruction]

````

````{py:method} schemaDiscover(rootElement: arelle.ModelObject.ModelObject, isIncluded: bool | None, isSupplemental: bool, namespace: str | None) -> None
:canonical: arelle.ModelRssObject.ModelRssObject.schemaDiscover

````

````{py:method} schemaDiscoverChildElements(parentModelObject: arelle.ModelObject.ModelObject, isSupplemental: bool = False) -> None
:canonical: arelle.ModelRssObject.ModelRssObject.schemaDiscoverChildElements

````

````{py:method} baseForElement(element: arelle.ModelObject.ModelObject) -> str
:canonical: arelle.ModelRssObject.ModelRssObject.baseForElement

````

````{py:method} importDiscover(element: arelle.ModelObject.ModelObject) -> None
:canonical: arelle.ModelRssObject.ModelRssObject.importDiscover

````

````{py:method} schemalocateElementNamespace(element: arelle.ModelObject.ModelObject) -> None
:canonical: arelle.ModelRssObject.ModelRssObject.schemalocateElementNamespace

````

````{py:method} loadSchemalocatedSchemas() -> None
:canonical: arelle.ModelRssObject.ModelRssObject.loadSchemalocatedSchemas

````

````{py:method} schemaLinkbaseRefsDiscover(tree: arelle.ModelObject.ModelObject) -> None
:canonical: arelle.ModelRssObject.ModelRssObject.schemaLinkbaseRefsDiscover

````

````{py:method} schemaLinkbaseRefDiscover(element: arelle.ModelObject.ModelObject) -> typing.Any
:canonical: arelle.ModelRssObject.ModelRssObject.schemaLinkbaseRefDiscover

````

````{py:method} linkbasesDiscover(tree: arelle.ModelObject.ModelObject) -> None
:canonical: arelle.ModelRssObject.ModelRssObject.linkbasesDiscover

````

````{py:method} linkbaseDiscover(linkbaseElement: arelle.ModelObject.ModelObject, inInstance: bool = False) -> None
:canonical: arelle.ModelRssObject.ModelRssObject.linkbaseDiscover

````

````{py:method} discoverHref(element: arelle.ModelObject.ModelObject, nonDTS: bool = False, urlRewritePluginClass: str | None = None) -> tuple[arelle.ModelObject.ModelObject, arelle.ModelDocument.ModelDocument | None, str | None] | None
:canonical: arelle.ModelRssObject.ModelRssObject.discoverHref

````

````{py:method} instanceDiscover(xbrlElement: arelle.ModelObject.ModelObject) -> None
:canonical: arelle.ModelRssObject.ModelRssObject.instanceDiscover

````

````{py:method} instanceContentsDiscover(xbrlElement: arelle.ModelObject.ModelObject) -> None
:canonical: arelle.ModelRssObject.ModelRssObject.instanceContentsDiscover

````

````{py:method} contextDiscover(modelContext: arelle.ModelInstanceObject.ModelContext, setTargetModelXbrl: bool = False) -> None
:canonical: arelle.ModelRssObject.ModelRssObject.contextDiscover

````

````{py:method} unitDiscover(unitElement: arelle.ModelInstanceObject.ModelUnit, setTargetModelXbrl: bool = False) -> None
:canonical: arelle.ModelRssObject.ModelRssObject.unitDiscover

````

````{py:method} inlineXbrlDiscover(htmlElement: arelle.ModelObject.ModelObject) -> None
:canonical: arelle.ModelRssObject.ModelRssObject.inlineXbrlDiscover

````

````{py:method} factDiscover(modelFact: arelle.ModelInstanceObject.ModelFact, parentModelFacts: list[arelle.ModelInstanceObject.ModelFact] | None = None, parentElement: arelle.ModelObject.ModelObject | None = None) -> None
:canonical: arelle.ModelRssObject.ModelRssObject.factDiscover

````

````{py:method} testcasesIndexDiscover(rootNode: lxml.etree._ElementTree, validateTestcaseSchema: bool) -> None
:canonical: arelle.ModelRssObject.ModelRssObject.testcasesIndexDiscover

````

````{py:method} testcaseDiscover(testcaseElement: arelle.ModelObject.ModelObject, validateTestcaseSchema: bool) -> None
:canonical: arelle.ModelRssObject.ModelRssObject.testcaseDiscover

````

````{py:method} registryDiscover(rootNode: arelle.ModelObject.ModelObject) -> None
:canonical: arelle.ModelRssObject.ModelRssObject.registryDiscover

````

````{py:method} xPathTestSuiteDiscover(rootNode: arelle.ModelObject.ModelObject) -> None
:canonical: arelle.ModelRssObject.ModelRssObject.xPathTestSuiteDiscover

````

````{py:method} addDocumentReference(doc: arelle.ModelDocument.ModelDocument, referenceType: str, referringModelObject: arelle.ModelObject.ModelObject | None = None) -> None
:canonical: arelle.ModelRssObject.ModelRssObject.addDocumentReference

````

`````