1. Singleton methods

self.new(expression) → EquationBlock

[PARAM] expression expression for equation.

self.new creates a EquationBlock object using a expression.

b = EquationBlock.new "x = \\\\frac{-b\\\\pm\\\\sqrt{b^2-4ac}}{2a}"; b.block_json
# => {"type"=>"equation", "object"=>"block", "equation"=>{"expression"=>"x = \\\\frac{-b\\\\pm\\\\sqrt{b^2-4ac}}{2a}"}}

↑ Table of Contents

2. Instance methods

expression → String

expression returns the language string for EquationBlock.

b = EquationBlock.new "x = \\\\frac{-b\\\\pm\\\\sqrt{b^2-4ac}}{2a}"; b.expression
# => "x = \\\\frac{-b\\\\pm\\\\sqrt{b^2-4ac}}{2a}"

↑ Table of Contents

expression=(new_expression)

[PARAM] new_expression new expression string

expression= updates the expression parameter for EquationBlock and sets update_block_key of the payload object.

b = EquationBlock.new "x = \\\\frac{-b\\\\pm\\\\sqrt{b^2-4ac}}{2a}"
b.expression = "X(z) = \\\\sum_{n=-\\\\infty}^{\\\\infty}x[n]z^{-n}"
b.update_block_json
# => {"equation"=>{"expression"=>"X(z) = \\\\sum_{n=-\\\\infty}^{\\\\infty}x[n]z^{-n}"}}

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

↑ Table of Contents

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

↑ Table of Contents