1. Singleton 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"}}

↑ Table of Contents

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

↑ Table of Contents

language → String

language returns the language string for CodeBlock.

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

↑ Table of Contents

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"}}

↑ Table of Contents