ktsoup-core/ktsoup/KtSoupDocument

KtSoupDocument

expect class KtSoupDocument : KtSoupElement

Represents a DOM document providing APIs to query and manipulate the document.

actual class KtSoupDocument : KtSoupElement

Functions

attr

expect fun attr(name: String): String?

Get the name attribute value or null if the attribute is missing.

actual fun attr(name: String): String?

attrs

expect fun attrs(): Map<String, String>

Get all attributes for this element.

actual fun attrs(): Map<String, String>

body

expect fun body(): KtSoupElement?

Get a KtSoupElement representing the document's body or null if there is no body.

actual fun body(): KtSoupElement?

child

expect fun child(index: Int): KtSoupNode?

Get the child KtSoupNode at the given index or null if the index is out of range.

actual fun child(index: Int): KtSoupNode?

children

expect fun children(): List<KtSoupNode>

Get a list of all the child nodes.

actual fun children(): List<KtSoupNode>

className

expect fun className(): String?

Get the class attribute value or null if there is no class attribute.

actual fun className(): String?

expect fun close()

Free all resources used for this document.

actual fun close()

equals

expect open operator override fun equals(other: Any?): Boolean

actual open operator override fun equals(other: Any?): Boolean

getElementById

expect fun getElementById(id: String): KtSoupElement?

Get the first element with an id attribute matching id or null if there are no matching elements.

actual fun getElementById(id: String): KtSoupElement?

getElementsByClass

expect fun getElementsByClass(className: String): List<KtSoupElement>

Get all elements with the provided className.

actual fun getElementsByClass(className: String): List<KtSoupElement>

getElementsByTagName

expect fun getElementsByTagName(tagName: String): List<KtSoupElement>

Get all elements with the provided tagName.

actual fun getElementsByTagName(tagName: String): List<KtSoupElement>

hashCode

expect open override fun hashCode(): Int

actual open override fun hashCode(): Int

head

expect fun head(): KtSoupElement?

Get a KtSoupElement representing the document's head or null if there is no head.

actual fun head(): KtSoupElement?

html

expect fun html(): String

Get the outer HTML as a string or the textContent if it's not an Element.

actual fun html(): String

expect fun id(): String?

Get the id attribute value or null if there is no id attribute.

actual fun id(): String?

nodeName

expect fun nodeName(): String

Get the node name of this node.

actual fun nodeName(): String

nodeType

expect fun nodeType(): KtSoupNodeType

Get the KtSoupNodeType of this node.

actual fun nodeType(): KtSoupNodeType

parent

expect fun parent(): KtSoupNode?

Get this node's parent KtSoupNode or null if it has no parent.

actual fun parent(): KtSoupNode?

querySelector

expect fun querySelector(selector: String): KtSoupElement?

Get the first KtSoupElement matching the css selector or null if there are no matches.

actual fun querySelector(selector: String): KtSoupElement?

querySelectorAll

expect fun querySelectorAll(selector: String): List<KtSoupElement>

Get all KtSoupElements matching the css selector.

actual fun querySelectorAll(selector: String): List<KtSoupElement>

tagName

expect fun tagName(): String

Get the tag name of this element.

actual fun tagName(): String

textContent

expect fun textContent(): String

Get the text content of this node.

actual fun textContent(): String

title

expect fun title(): String

Get the document's title or an empty string if no title is found.

actual fun title(): String

toString

expect open override fun toString(): String

actual open override fun toString(): String

use

expect inline fun <R> use(crossinline block: (KtSoupDocument) -> R): R

A convenience function to interact with the document in block and automatically invoke close at the end.

actual inline fun <R> use(crossinline block: (KtSoupDocument) -> R): R