<aside> ๐Ÿ‘‰

Links (Block base class)

Page

Block

CalloutBlock

DividerBlock

Heading1Block

ImageBlock

ParagraphBlock

TableOfContentsBlock

ToggleHeading2Block

Database

BookmarkBlock

CodeBlock

EmbedBlock

Heading2Block

LinkPreviewBlock

PdfBlock

ToDoBlock

ToggleHeading3Block

DataSource ๐Ÿ†•

BreadcrumbBlock

ColumnBlock

EquationBlock

Heading3Block

LinkToPageBlock

QuoteBlock

ToggleBlock

ToggleHeading4Block

List

BulletedListItemBlock

ColumnListBlock

FileBlock

Heading4Block

NumberedListItemBlock

SyncedBlock

ToggleHeading1Block

VideoBlock

Notion Ruby Mapping Public API Reference

</aside>

1. Class methods

self.new(text_info, sub_blocks: nil, color: โ€œdefaultโ€) โ†’ ToggleHeading4Block

$\fbox{implemented in TextSubBlockColorBaseBlock}$

self.new creates a ToggleHeading4Block object using a text_info. color is an optional parameters.

b = ToggleHeading4Block.new "Toggle Heading 4", color: "gray_background", sub_blocks: [
    BulletedListItemBlock.new("inside Toggle Heading 4"),
]
b.block_json
# => {"type"=>"heading_4", "object"=>"block", "heading_4"=>{"rich_text"=>[{"type"=>"text", "text"=>{"content"=>"Toggle Heading 4", "link"=>nil}, "plain_text"=>"Toggle Heading 4", "href"=>nil}], "color"=>"gray_background", "children"=>[{"type"=>"bulleted_list_item", "object"=>"block", "bulleted_list_item"=>{"rich_text"=>[{"type"=>"text", "text"=>{"content"=>"inside Toggle Heading 4", "link"=>nil}, "plain_text"=>"inside Toggle Heading 4", "href"=>nil}], "color"=>"default"}}]}}

2. Instance methods

append_block_children(*blocks, position: nil, dry_run: false) โ†’ Array<Block>, String

$\fbox{implemented in Block}$

append_block_children method of an existing block appends some block objects. Some blocks allow child blocks to be set up at the same time. However, due to API limitations, grandchild blocks cannot be created at once. There are many types of blocks, so check the page( Append block children sample) to see how to create blocks.

parent_block = Block.find "065babbba0854c188e964feb56291be2"
parent_block.append_block_children CodeBlock.new("% ls -l", caption: "List files")
# => 
# #<NotionRubyMapping::Block:0x0000000104e7d150

append_block_children(blocks, dry_run: true) creates a shell script using Append block children API for verification.

parent_block.append_block_children CodeBlock.new("% ls -l", caption: "List files"), dry_run: true
# => "#!/bin/sh\\ncurl -X PATCH '<https://api.notion.com/v1/blocks/065babbba0854c188e964feb56291be2/children>' \\\\\\n  -H 'Notion-Version: 2022-02-22' \\\\\\n  -H 'Authorization: Bearer '\\"$NOTION_API_KEY\\"'' \\\\\\n  -H 'Content-Type: application/json' \\\\\\n  --data '{\\"children\\":[{\\"type\\":\\"code\\",\\"object\\":\\"block\\",\\"code\\":{\\"rich_text\\":[{\\"type\\":\\"text\\",\\"text\\":{\\"content\\":\\"% ls -l\\",\\"link\\":null},\\"plain_text\\":\\"% ls -l\\",\\"href\\":null}],\\"caption\\":[{\\"type\\":\\"text\\",\\"text\\":{\\"content\\":\\"List files\\",\\"link\\":null},\\"plain_text\\":\\"List files\\",\\"href\\":null}],\\"language\\":\\"shell\\"}}]}'"

color โ†’ String

$\fbox{implemented in TextSubBlockColorBaseBlock}$

color returns the color string for ToggleHeading4Block.

color=(new_color)

$\fbox{implemented in TextSubBlockColorBaseBlock}$

color= updates the color parameter for ToggleHeading4Block and sets update_block_key of the payload object.

rich_text_array โ†’ RichTextArray