<aside> ๐Ÿ‘‰ Links (Block base class)

Page

BookmarkBlock

CodeBlock

EmbedBlock

Heading2Block

Database

BreadcrumbBlock

ColumnBlock

EquationBlock

Heading3Block

NumberedListItemBlock

SyncedBlock

ToggleBlock

VideoBlock

List

BulletedListItemBlock

ColumnListBlock

FileBlock

ImageBlock

ParagraphBlock

TableOfContentsBlock

ToggleHeading1Block

Block

CalloutBlock

DividerBlock

Heading1Block

LinkPreviewBlock

PdfBlock

TemplateBlock

ToggleHeading2Block

Notion Ruby Mapping Public API Reference

</aside>

<aside> โ„น๏ธ โ†‘ Table of Contents

</aside>

1. Singleton methods

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

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

b = Heading2Block.new "Heading 2"
b.block_json
# => {"type"=>"heading_2", "object"=>"block", "heading_2"=>{"rich_text"=>[{"type"=>"text", "text"=>{"content"=>"Heading 2", "link"=>nil}, "plain_text"=>"Heading 2", "href"=>nil}], "color"=>nil}}

โ†‘ Table of Contents

2. Instance methods

append_block_children(*blocks, 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\\"}}]}'"

โ†‘ Table of Contents

color โ†’ String

$\fbox{implemented in TextSubBlockColorBaseBlock}$

color returns the color string for Heading2Block.

b = Heading2Block.new "Heading 2"
b.color
# => "default"

โ†‘ Table of Contents

color=(new_color)

$\fbox{implemented in TextSubBlockColorBaseBlock}$

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

b = Heading2Block.new "Heading 2"
b.color = "red"
b.update_block_json
# => {"heading_2"=>{"color"=>"red", "rich_text"=>[{"type"=>"text", "text"=>{"content"=>"Heading 2", "link"=>nil}, "plain_text"=>"Heading 2", "href"=>nil}]}}