Represents a code block in a Notion page. Code blocks are used to display formatted code snippets with syntax highlighting. They support various programming languages and can be used to share code examples or technical documentation.

DividerBlock

interface DividerBlock : Block

See Reference.

EmbedBlock

interface EmbedBlock : Block

See Reference.

EquationBlock

interface EquationBlock : Block

Heading1Block

interface Heading1Block : Block

See Reference.

Heading2Block

interface Heading2Block : Block

See Reference.

Heading3Block

interface Heading3Block : Block

See Reference.

ImageBlock

interface ImageBlock : Block

See reference

MutableBlockList

class MutableBlockList(blockList: MutableList<Block> = mutableListOf()) : List<Block>

NumberedListItemBlock

interface NumberedListItemBlock : Block

Represents a numbered list item block in a Notion page. Numbered list items are part of an ordered list, where each item is automatically numbered based on its position in the list. The numbering is handled automatically by Notion.

ParagraphBlock

interface ParagraphBlock : Block

See Reference.

QuoteBlock

interface QuoteBlock : Block

See Reference.

SyncedBlock

interface SyncedBlock : Block

See Reference.

TableOfContentsBlock

interface TableOfContentsBlock : Block

Represents a table of contents block in a Notion page. A table of contents block automatically generates a hierarchical list of all headings in the page, making it easy to navigate through the content.

ToDoBlock

interface ToDoBlock : Block

See Reference.

ToggleBlock

interface ToggleBlock : Block

Represents a toggle block in a Notion page. Toggle blocks are collapsible sections that can contain other blocks as children. They are useful for organizing content that can be expanded or collapsed by users.

UnknownTypeBlock

interface UnknownTypeBlock : Block

This type is returned when a Block of a type unknown to this library is returned by the Notion API.

VideoBlock

interface VideoBlock : Block

See reference

Functions

bookmark

fun bookmark(url: String, caption: RichTextList? = null): Block

@JvmOverloads

fun bookmark(url: String, caption: String? = null, linkUrl: String? = null, annotations: RichTextAnnotations = RichTextAnnotations.DEFAULT): Block

bulletedListItem

fun bulletedListItem(richTextList: RichTextList): Block

@JvmOverloads

fun bulletedListItem(text: String, linkUrl: String? = null, annotations: RichTextAnnotations = RichTextAnnotations.DEFAULT): Block

callout

fun callout(richTextList: RichTextList, icon: EmojiOrFile? = null): Block

@JvmOverloads

fun callout(text: String, icon: EmojiOrFile? = null, linkUrl: String? = null, annotations: RichTextAnnotations = RichTextAnnotations.DEFAULT): Block

code

fun code(language: String, text: RichTextList): Block

@JvmOverloads

fun code(language: String, text: String, linkUrl: String? = null, annotations: RichTextAnnotations = RichTextAnnotations.DEFAULT): Block

content

fun content(content: BlockListProducer): MutableBlockList?

divider

fun divider(): Block

embed

fun embed(url: String): Block

equation

fun equation(expression: String): Block

heading1

fun heading1(richTextList: RichTextList): Block

@JvmOverloads

fun heading1(text: String, linkUrl: String? = null, annotations: RichTextAnnotations = RichTextAnnotations.DEFAULT): Block

heading2

fun heading2(richTextList: RichTextList): Block

@JvmOverloads

fun heading2(text: String, linkUrl: String? = null, annotations: RichTextAnnotations = RichTextAnnotations.DEFAULT): Block

heading3

fun heading3(richTextList: RichTextList): Block

@JvmOverloads

fun heading3(text: String, linkUrl: String? = null, annotations: RichTextAnnotations = RichTextAnnotations.DEFAULT): Block

image

fun image(url: String, caption: RichTextList? = null): Block

@JvmOverloads

fun image(url: String, caption: String? = null, linkUrl: String? = null, annotations: RichTextAnnotations = RichTextAnnotations.DEFAULT): Block

numberedListItem

fun numberedListItem(richTextList: RichTextList): Block

@JvmOverloads

fun numberedListItem(text: String, linkUrl: String? = null, annotations: RichTextAnnotations = RichTextAnnotations.DEFAULT): Block

paragraph

fun paragraph(richTextList: RichTextList): Block

@JvmOverloads

fun paragraph(text: String, linkUrl: String? = null, annotations: RichTextAnnotations = RichTextAnnotations.DEFAULT): Block

quote

fun quote(richTextList: RichTextList): Block

@JvmOverloads

fun quote(text: String, linkUrl: String? = null, annotations: RichTextAnnotations = RichTextAnnotations.DEFAULT): Block

syncedBlock

fun syncedBlock(syncedFrom: UuidString): Block

tableOfContents

fun tableOfContents(): Block

toDo

fun toDo(richTextList: RichTextList, checked: Boolean): Block

@JvmOverloads

fun toDo(text: String, checked: Boolean, linkUrl: String? = null, annotations: RichTextAnnotations = RichTextAnnotations.DEFAULT): Block

toggle

fun toggle(richTextList: RichTextList): Block

@JvmOverloads

fun toggle(text: String, linkUrl: String? = null, annotations: RichTextAnnotations = RichTextAnnotations.DEFAULT): Block

video

fun video(url: String, caption: RichTextList? = null): Block

@JvmOverloads

fun video(url: String, caption: String? = null, linkUrl: String? = null, annotations: RichTextAnnotations = RichTextAnnotations.DEFAULT): Block