1. Class methods

self.new(url, caption: []) → BookmarkBlock

$\fbox{implemented in UrlCaptionBaseBlock}$

[PARAM] url bookmark URL (String)
[PARAM(optional)] caption defaults to an empty caption

<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>
[RETURN] BookmarkBlock
[RAISE] ArgumentError when neither url nor reconstruction JSON is provided

self.new creates a BookmarkBlock using url and an optional caption. An empty string is accepted as url; nil is not accepted for normal construction. When caption is omitted, the generated payload contains an empty caption array.

b = BookmarkBlock.new "<https://www.google.com/>", caption: "Google"
b.block_json
# => {"type"=>"bookmark", "object"=>"block", "bookmark"=>{"caption"=>[{"type"=>"text", "text"=>{"content"=>"Google", "link"=>nil}, "plain_text"=>"Google", "href"=>nil], "url"=>"<https://www.google.com/>"}}

2. Instance methods

save(dry_run: false)

$\fbox{implemented in Block}$

[PARAM(optional)] dry_run true returns a verification script without sending the request (Boolean)
[RETURN] updated BookmarkBlock, or a verification script when dry_run: true

save sends only the changed URL and caption fields through the Update a block API. The response is decoded into an updated BookmarkBlock.

block = Block.find "bookmark_block_id"
block.url = "<https://www.apple.com/>"
block.caption.rich_text_objects = "Apple"
block.save
# => #<NotionRubyMapping::BookmarkBlock:...>

Use dry_run: true to inspect the request without sending it.

block.save dry_run: true
# => curl -X PATCH '<https://api.notion.com/v1/blocks/bookmark_block_id>' ...
#    --data '{"bookmark":{"url":"<https://www.apple.com/","caption>":[...]}}'

caption → RichTextArray