1. Class methods

self.new(text_info, caption: [], language: “shell”) → CodeBlock

[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)] caption
[PARAM (optional)] language language for code. The default value is Shell.

self.new creates a CodeBlock object using a text_info. caption and language are optional parameters.

b = CodeBlock.new "Ruby code", language: "ruby", caption: "sample caption"; b.block_json
# => {"type"=>"code","object"=>"block","code"=>{"rich_text"=>[{"type"=>"text", "text"=>{"content"=>"Ruby code", "link"=>nil}, "plain_text"=>"Ruby code", "href"=>nil}],"caption"=>[{"type"=>"text", "text"=>{"content"=>"sample caption", "link"=>nil}, "plain_text"=>"sample caption", "href"=>nil}],"language"=>"Ruby"}}

2. Instance methods

caption → RichTextArray

caption returns the RichTextArray object for CodeBlock.

b = CodeBlock.new "Ruby code", language: "ruby", caption: "sample caption"; b.caption
=> #<NotionRubyMapping::RichTextArray:...>

language → String

language returns the language string for CodeBlock.

b = CodeBlock.new "Ruby code", language: "ruby", caption: "sample caption"
# => "Ruby"

language=(new_language)

[PARAM] new_language new language string

language= updates the language parameter for CodeBlock and sets update_block_key of the payload object.

b = CodeBlock.new "Ruby code", language: "ruby", caption: "sample caption"; b.language
b.language = "shell"
b.update_block_json
# => {"code"=>{"language"=>"shell"}}

save(dry_run: false)

$\fbox{implemented in Block}$

[PARAM] dry_run: true if you want to create a verification script

save updates the Block object with update block API. The updated object has block information generated from the JSON response.

block = Block.find "899e342cec84415f9ff86225704cbb75" # Notion API call
block.url = "<https://www.apple.com/>"
block.save
# => #<NotionRubyMapping::Block:...> # updated Block object

Block.find(id, dry_run: true) creates a shell script using Retrieve a block API for verification.

block = Block.find "899e342cec84415f9ff86225704cbb75" # Notion API call
block.url = "<https://www.apple.com/>"
block.save dry_run: true
# => 
# curl -X PATCH '<https://api.notion.com/v1/blocks/899e342cec84415f9ff86225704cbb75>' \\
#   -H 'Notion-Version: 2022-02-22' \\
#   -H 'Authorization: Bearer '"$NOTION_API_KEY"'' \\
#   -H 'Content-Type: application/json' \\
#   --data '{"bookmark":{"url":"<https://www.apple.com/>"}}'

rich_text_array → RichTextArray

rich_text_array returns the rich_text parameter of BulletedListItemBlock.

b = CodeBlock.new "Ruby code", language: "ruby", caption: "sample caption"; b.rich_text_array
# => #<NotionRubyMapping::...>