DocumentOptions

class DocumentOptions

Description

Options to construct new document with

Inheritance:

property document_id: syside.DocumentID

Id of the new document.

Note: this currently has no effect.

property language: str: Language identifier of the new document, e.g. "sysml"

property owning_library: syside.LibraryID | None

Id of the library this document is a part of.

Note: this currently has no effect.

Document tier of the new document.

This will typically be Project.

__init__(url: syside.Url, language: str = 'plaintext', tier: syside.DocumentTier = DocumentTier.Project, document_id: syside.DocumentID = ..., owning_library: syside.LibraryID | None = None) → None

`document_id`	`RW`	Id of the new document.
`language`	`RW`	Language identifier of the new document, e.g. `"sysml"`
`owning_library`	`RW`	Id of the library this document is a part of.
`tier`	`RW`	Document tier of the new document.
`url`	`RW`	Url of the new document
`__init__`