Links (Block base class)
PageBookmarkBlockCodeBlockEmbedBlockHeading2BlockLinkToPageBlockQuoteBlockToDoBlockToggleHeading3Block
DatabaseBreadcrumbBlockColumnBlockEquationBlockHeading3BlockNumberedListItemBlockSyncedBlockToggleBlockVideoBlock
1. Singleton methods
self.new(url, caption: []) → BookmarkBlock
- [PARAM] url bookmark url (String)
- [PARAM(optional)] caption
- 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)
The following objects are used for this argument.
self.new creates a BookmarkBlock object using a url. caption is an optional parameter.b = BookmarkBlock.new "a_url", caption: "Sample url"; b.block_json # => {"type"=>"bookmark", "object"=>"block", "bookmark"=>{"caption"=>[{"type"=>"text", "text"=>{"content"=>"Sample url", "link"=>nil}, "plain_text"=>"Sample url", "href"=>nil}], "url"=>"a_url"}}# => {"type"=>"bookmark", "bookmark"=>{"caption"=>[{"type"=>"text", "text"=>{"content"=>"Sample url", "link"=>nil}, "plain_text"=>"Sample url", "href"=>nil}], "url"=>"a_url"}}
2. Instance methods
save(dry_run: false)
- [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/"}}'
caption → RichTextArray
caption returns the RichTextArray object for BookmarkBlock.b = BookmarkBlock.new "https://www.google.com/", caption: "Google"; b.caption => #<NotionRubyMapping::RichTextArray:...>
url → String
url returns the url parameter of BookmarkBlock.b = BookmarkBlock.new "https://www.google.com/", caption: "Google"; b.url # => "https://www.google.com/"
url=(str)
- [PARAM] str url str
url= updates the url parameter of block for BookmarkBlock and sets update_block_key of the payload object.b = BookmarkBlock.new "https://www.google.com/", caption: "Google" b.url = "https://www.apple.com/" b.update_block_json # => {"bookmark"=>{"url"=>"https://www.apple.com/"}}