1. Singleton methods

self.new(text_info, color: “default”) → Heading1Block

[PARAM] text_info

<aside> 📃 The following objects are used for this argument.
- a String like as “text” (String)
- an Array of Strings (Array of Strings)
- a RichTextObject (RichTextObject)
- an Array of RichTextObjects (Array of RichTextObjects)
- a RichTextArray (RichTextArray) </aside>
[PARAM(optional)] color color string. When a_color is not specified, use “default”
This block can have children blocks.

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

b = Heading1Block.new "Heading 1"; b.block_json
# => {"type"=>"heading_1", "object"=>"block", "heading_1"=>{"rich_text"=>[{"type"=>"text", "text"=>{"content"=>"Heading 1", "link"=>nil}, "plain_text"=>"Heading 1", "href"=>nil}], "color"=>nil}}

↑ Table of Contents

2. Instance methods

append_block_children(*blocks, dry_run: false) → Array<Block>, String

$\fbox{implemented in Block}$

[PARAM] blocks array of blocks
[PARAM(optional)] dry_run: true if you want to create a verification script

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 Heading1Block.

b = Heading1Block.new "Heading 1"; b.color
# => "default"

↑ Table of Contents

color=(new_color)

$\fbox{implemented in TextSubBlockColorBaseBlock}$

[PARAM] new_color new color string

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

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