Notion Ruby Mapping Public API Reference

1. Instance methods

button → Hash, nil

  1. [P] button returns the button property object retrieved from Notion API.
  2. [DB/DS] button returns the Database or DataSource property schema object for the button property.
  3. ButtonProperty is managed by Notion and is read-only. It can be read from retrieved page property data, but it is not included in page update payloads.
  4. property_values_json keeps the current value representation for Page properties. However, ButtonProperty does not become an update target because will_update remains false.
page.properties["Buttons"].button
# => {}

ds.properties["Buttons"].button
# => {}

property_values_json → Hash

  1. [P] property_values_json returns the Page property value JSON representation.
  2. This method is available only for Page properties.
  3. The returned Hash is not normally used as a page update payload because ButtonProperty is read-only and is not marked for update.
page.properties["Buttons"].property_values_json
# => {"Buttons" => {"type" => "button", "button" => {}}}

2. Notes